diff --git a/README.md b/README.md index 787c877..ec9b778 100644 --- a/README.md +++ b/README.md @@ -146,15 +146,14 @@ Navigates to a page by index Arguments: -| Prop | Type | Default | Description | +| Argument | Type | Default | Description | |--------------------|-------------|---------|---------------------------------------| | `pageIndex` | `number` | | Page number | -| `options.animated` | `boolean` | `true` | Should be animated or not | +| `options.animated` | `boolean` | `true` | Should it be animated or not | ```jsx ``` + + # Props +
| Prop | Type | Default | Description | @@ -220,7 +225,9 @@ Import component
-# Event + + +# Events ## `pageChange` Is dispatched on page change @@ -243,6 +250,8 @@ Is dispatched on page change ``` + + # Slots ## `prev` and `next` @@ -329,6 +338,41 @@ Slot props: +# Methods + +## `goTo` +Navigates to a page by index + +Arguments: + +
+ +| Argument | Type | Default | Description | +|--------------------|-------------|---------|---------------------------------------| +| `pageIndex` | `number` | | Page number | +| `options.animated` | `boolean` | `true` | Should it be animated or not | + +
+ +```jsx + + + + + + +``` + + +