public/svelte-carousel
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Vadim
2021-07-18 16:31:40 +03:00
parent 05c016a125
commit 578d4dfe3d
2 changed files with 22 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -143,7 +143,7 @@ Slot props:
## Methods ## Methods
### `goTo` ### `goTo`
Navigates to a page by index Navigates to a page by index. `(options) => Promise<void>`.
Arguments: Arguments:
@@ -170,13 +170,13 @@ Arguments:
``` ```
### `goToPrev` ### `goToPrev`
Navigates to the previous page Navigates to the previous page. `(options) => Promise<void>`.
Arguments: Arguments:
| Argument | Type | Default | Description | | Argument | Type | Default | Description |
|--------------------|-------------|---------|---------------------------------------| |--------------------|-------------|---------|-------------------------------|
| `options.animated` | `boolean` | `true` | Should it be animated or not | | `options.animated` | `boolean` | `true` | Should it be animated or not |
```jsx ```jsx
<script> <script>
@@ -196,13 +196,13 @@ Arguments:
``` ```
### `goToNext` ### `goToNext`
Navigates to the next page Navigates to the next page. `(options) => Promise<void>`.
Arguments: Arguments:
| Argument | Type | Default | Description | | Argument | Type | Default | Description |
|--------------------|-------------|---------|---------------------------------------| |--------------------|-------------|---------|------------------------------|
| `options.animated` | `boolean` | `true` | Should it be animated or not | | `options.animated` | `boolean` | `true` | Should it be animated or not |
```jsx ```jsx
<script> <script>

26
src/docs/Carousel.svx
View File

@@ -375,14 +375,14 @@ Slot props:
# Methods # Methods
## `goTo` ## `goTo`
Navigates to a page by index Navigates to a page by index. `(options) => Promise<void>`.
Arguments: Arguments:
| Argument | Type | Default | Description | | Argument | Type | Default | Description |
|--------------------|-------------|---------|---------------------------------------| |--------------------|-------------|---------|------------------------------|
| `pageIndex` | `number` | | Page number | | `pageIndex` | `number` | | Page number |
| `options.animated` | `boolean` | `true` | Should it be animated or not | | `options.animated` | `boolean` | `true` | Should it be animated or not |
```jsx ```jsx
<script> <script>
@@ -402,13 +402,13 @@ Arguments:
``` ```
## `goToPrev` ## `goToPrev`
Navigates to the previous page Navigates to the previous page. `(options) => Promise<void>`.
Arguments: Arguments:
| Argument | Type | Default | Description | | Argument | Type | Default | Description |
|--------------------|-------------|---------|---------------------------------------| |--------------------|-------------|---------|------------------------------|
| `options.animated` | `boolean` | `true` | Should it be animated or not | | `options.animated` | `boolean` | `true` | Should it be animated or not |
```jsx ```jsx
<script> <script>
@@ -428,13 +428,13 @@ Arguments:
``` ```
## `goToNext` ## `goToNext`
Navigates to the next page Navigates to the next page. `(options) => Promise<void>`.
Arguments: Arguments:
| Argument | Type | Default | Description | | Argument | Type | Default | Description |
|--------------------|-------------|---------|---------------------------------------| |--------------------|-------------|---------|------------------------------|
| `options.animated` | `boolean` | `true` | Should it be animated or not | | `options.animated` | `boolean` | `true` | Should it be animated or not |
```jsx ```jsx
<script> <script>