Skip to content

Commit 578d4df

Browse files
committed
Update docs
1 parent 05c016a commit 578d4df

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ Slot props:
143143
## Methods
144144

145145
### `goTo`
146-
Navigates to a page by index
146+
Navigates to a page by index. `(options) => Promise<void>`.
147147

148148
Arguments:
149149

@@ -170,13 +170,13 @@ Arguments:
170170
```
171171

172172
### `goToPrev`
173-
Navigates to the previous page
173+
Navigates to the previous page. `(options) => Promise<void>`.
174174

175175
Arguments:
176176

177-
| Argument | Type | Default | Description |
178-
|--------------------|-------------|---------|---------------------------------------|
179-
| `options.animated` | `boolean` | `true` | Should it be animated or not |
177+
| Argument | Type | Default | Description |
178+
|--------------------|-------------|---------|-------------------------------|
179+
| `options.animated` | `boolean` | `true` | Should it be animated or not |
180180

181181
```jsx
182182
<script>
@@ -196,13 +196,13 @@ Arguments:
196196
```
197197

198198
### `goToNext`
199-
Navigates to the next page
199+
Navigates to the next page. `(options) => Promise<void>`.
200200

201201
Arguments:
202202

203-
| Argument | Type | Default | Description |
204-
|--------------------|-------------|---------|---------------------------------------|
205-
| `options.animated` | `boolean` | `true` | Should it be animated or not |
203+
| Argument | Type | Default | Description |
204+
|--------------------|-------------|---------|------------------------------|
205+
| `options.animated` | `boolean` | `true` | Should it be animated or not |
206206

207207
```jsx
208208
<script>

src/docs/Carousel.svx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -375,14 +375,14 @@ Slot props:
375375
# Methods
376376

377377
## `goTo`
378-
Navigates to a page by index
378+
Navigates to a page by index. `(options) => Promise<void>`.
379379

380380
Arguments:
381381

382-
| Argument | Type | Default | Description |
383-
|--------------------|-------------|---------|---------------------------------------|
384-
| `pageIndex` | `number` | | Page number |
385-
| `options.animated` | `boolean` | `true` | Should it be animated or not |
382+
| Argument | Type | Default | Description |
383+
|--------------------|-------------|---------|------------------------------|
384+
| `pageIndex` | `number` | | Page number |
385+
| `options.animated` | `boolean` | `true` | Should it be animated or not |
386386

387387
```jsx
388388
<script>
@@ -402,13 +402,13 @@ Arguments:
402402
```
403403

404404
## `goToPrev`
405-
Navigates to the previous page
405+
Navigates to the previous page. `(options) => Promise<void>`.
406406

407407
Arguments:
408408

409-
| Argument | Type | Default | Description |
410-
|--------------------|-------------|---------|---------------------------------------|
411-
| `options.animated` | `boolean` | `true` | Should it be animated or not |
409+
| Argument | Type | Default | Description |
410+
|--------------------|-------------|---------|------------------------------|
411+
| `options.animated` | `boolean` | `true` | Should it be animated or not |
412412

413413
```jsx
414414
<script>
@@ -428,13 +428,13 @@ Arguments:
428428
```
429429

430430
## `goToNext`
431-
Navigates to the next page
431+
Navigates to the next page. `(options) => Promise<void>`.
432432

433433
Arguments:
434434

435-
| Argument | Type | Default | Description |
436-
|--------------------|-------------|---------|---------------------------------------|
437-
| `options.animated` | `boolean` | `true` | Should it be animated or not |
435+
| Argument | Type | Default | Description |
436+
|--------------------|-------------|---------|------------------------------|
437+
| `options.animated` | `boolean` | `true` | Should it be animated or not |
438438

439439
```jsx
440440
<script>

0 commit comments

Comments
 (0)