Skip to content

Commit 4fe8dad

Browse files
committed
Change disableArrowKeys -> disableKeyDown
1 parent aa89510 commit 4fe8dad

File tree

2 files changed

+6
-10
lines changed

2 files changed

+6
-10
lines changed

README.md

+2-6
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ npm install react-image-gallery
3535
3636
# CSS
3737
@import "~react-image-gallery/styles/css/image-gallery.css";
38-
39-
# Stylesheet with no icons
40-
node_modules/react-image-gallery/styles/scss/image-gallery-no-icon.scss
41-
node_modules/react-image-gallery/styles/css/image-gallery-no-icon.css
4238
```
4339

4440
### Example
@@ -110,8 +106,8 @@ class MyGallery extends React.Component {
110106
* `autoPlay`: Boolean, default `false`
111107
* `disableThumbnailScroll`: Boolean, default `false`
112108
* disables the thumbnail container from adjusting
113-
* `disableArrowKeys`: Boolean, default `false`
114-
* disables keydown listener for left and right keyboard arrow keys
109+
* `disableKeyDown`: Boolean, default `false`
110+
* disables keydown listener for keyboard shortcuts (left arrow, right arrow, esc key)
115111
* `disableSwipe`: Boolean, default `false`
116112
* `onErrorImageURL`: String, default `undefined`
117113
* an image src pointing to your default image if an image fails to load

src/ImageGallery.jsx

+4-4
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export default class ImageGallery extends React.Component {
6666
showPlayButton: bool,
6767
showFullscreenButton: bool,
6868
disableThumbnailScroll: bool,
69-
disableArrowKeys: bool,
69+
disableKeyDown: bool,
7070
disableSwipe: bool,
7171
useBrowserFullscreen: bool,
7272
preventDefaultTouchmoveEvent: bool,
@@ -119,7 +119,7 @@ export default class ImageGallery extends React.Component {
119119
showPlayButton: true,
120120
showFullscreenButton: true,
121121
disableThumbnailScroll: false,
122-
disableArrowKeys: false,
122+
disableKeyDown: false,
123123
disableSwipe: false,
124124
useTranslate3D: true,
125125
isRTL: false,
@@ -881,12 +881,12 @@ export default class ImageGallery extends React.Component {
881881
}
882882

883883
handleKeyDown(event) {
884-
const { disableArrowKeys, useBrowserFullscreen } = this.props;
884+
const { disableKeyDown, useBrowserFullscreen } = this.props;
885885
const { isFullscreen } = this.state;
886886
// keep track of mouse vs keyboard usage for a11y
887887
this.imageGallery.current.classList.remove('image-gallery-using-mouse');
888888

889-
if (disableArrowKeys) return;
889+
if (disableKeyDown) return;
890890
const LEFT_ARROW = 37;
891891
const RIGHT_ARROW = 39;
892892
const ESC_KEY = 27;

0 commit comments

Comments
 (0)