Skip to content

Commit

Permalink
Fix type name and docs typos
Browse files Browse the repository at this point in the history
  • Loading branch information
wajeshubham committed Jul 5, 2023
1 parent 8cc8b7b commit d83999e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/react-native.md
Expand Up @@ -106,7 +106,7 @@ Specifies the configuration of the slides. Every time there is an update, resize
- **function** - Specifies the slides configuration with a function that returns an array of slide configurations. A slide configuration has the following optional properties:

- `origin`: **number** - Determines where the origin of a slide is within the viewport. Default is **0**.
- `size`: **number** - Determines the relativ size of the slide in relation to the viewport. Default is **1**.
- `size`: **number** - Determines the relative size of the slide in relation to the viewport. Default is **1**.
- `spacing`: **number** - Defines the space to the next slide in relation to the viewport. Default is **0**.

The function receives as first argument the container size.
Expand Down Expand Up @@ -228,7 +228,7 @@ Changes the currently active slide to the previous one when called. If exists.

### `size`: **number**

The size of the container/viewport, width or height, depending on the verical option.
The size of the container/viewport, width or height, depending on the vertical option.

### `slidesProps`: **object[]**

Expand Down
4 changes: 2 additions & 2 deletions docs/web.md
Expand Up @@ -203,7 +203,7 @@ Changes the direction in which the slides are positioned, from left-to-right to

Enables or disables the rubberband behavior for dragging and animation after a drag. Default is **true**.

### `selector`: **string | HTMLElement[] | Nodelist | function | null**
### `selector`: **string | HTMLElement[] | NodeList | function | null**

Specifies how the slides from the DOM are received. This could be a **css selector string**, an **array of HTMLElement** or a **function** that gets the container and returns an **array** of **HTMLElement**, a **NodeList**, a **HTMLCollection**, a **string** or **null**. If you don't want the slider to position or scale the slides, set this option to **null**. Default is **'.keen-slider\_\_slide'**.

Expand All @@ -223,7 +223,7 @@ Specifies the configuration of the slides. Every time there is an update, resize
- **function** - Specifies the slides configuration with a function that returns an array of slide configurations. A slide configuration has the following optional properties:

- `origin`: **number** - Determines where the origin of a slide is within the viewport. Default is **0**.
- `size`: **number** - Determines the relativ size of the slide in relation to the viewport. Default is **1**.
- `size`: **number** - Determines the relative size of the slide in relation to the viewport. Default is **1**.
- `spacing`: **number** - Defines the space to the next slide in relation to the viewport. Default is **0**.

The function receives as first argument the container size and the slides as an array of HTML elements as the second argument.
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/web/types.ts
Expand Up @@ -5,7 +5,7 @@ export interface WebOptions<O> {
selector?:
| string
| HTMLElement[]
| Nodelist
| NodeList
| HTMLCollection
| ((
container: HTMLElement
Expand Down

0 comments on commit d83999e

Please sign in to comment.