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

10
README.md
View File

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

12
src/docs/Carousel.svx
View File

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