Skip to content

Commit bdd2a9c

Browse files
mikkoporileMaik
andauthored
Update props in the readme (#89)
* Update README.md Update/add missing props * Keep alphabetical prop order, use the same description for classes. * Update README.md Co-authored-by: Maik Marschner <[email protected]>
1 parent 149fbb4 commit bdd2a9c

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ npm i --save react-swipeable-views
2323
|----------------|------------|------------|--------------------------------
2424
|autoplay | `bool` | `true` | If `false`, the auto play behavior is disabled.
2525
|ButtonProps | `object` | | Properties applied to the [Button](https://material-ui.com/api/button/) element.
26+
|classes | `object` | | Object for customizing the CSS classes.
2627
|containerStyle | `object` | | Override the inline-styles of the carousel container.
28+
|hideArrows | `function` | | If `true`, the left and right arrows are hidden in the desktop version.
2729
|interval | `integer` | `3000` | Delay between auto play transitions (in ms).
2830
|label | `string` | | Button text. If not supplied, the button will be hidden.
2931
|landscape | `bool` | | If `true`, slide will adjust content for wide mobile screens.
@@ -38,8 +40,11 @@ npm i --save react-swipeable-views
3840

3941
|Name |Type |Default |Description
4042
|-----------------------|-----------|-------------|--------------------------------
43+
|classes | `object` | | Object for customizing the CSS classes.
44+
|landscape | `bool` | | If `true`, slide will adjust content for wide mobile screens (automatically set by `AutoRotatingCarousel`).
4145
|media* | `node` | | Object to display in the upper half.
4246
|mediaBackgroundStyle | `object` | | Override the inline-styles of the media container.
47+
|mobile | `bool` | | If `true`, the screen width and height is filled (automatically set by `AutoRotatingCarousel`).
4348
|style | `object` | | Override the inline-styles of the slide.
4449
|subtitle* | `string` | | Subtitle for the slide.
4550
|title* | `string` | | Title for the slide.

0 commit comments

Comments
 (0)