Skip to content

Commit

Permalink
Update docs/props.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gilbarbara committed Jul 31, 2021
1 parent 3d11a4b commit 6c7b80e
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/props.md
Expand Up @@ -10,7 +10,7 @@ Below is the complete list of possible props and options:
**beaconComponent** {ReactNode}
A React component or function to be used instead the default Beacon. Check [custom components](custom-components.md) for details.

**callback** {\(\) => CallbackProps\)}
**callback** {() => CallbackProps}
It will be called when Joyride's state changes. it returns a single parameter with the state.

**continuous** {boolean} ▶︎ `false`
Expand All @@ -37,15 +37,16 @@ Disable the fix to handle "unused" overflow parents
**floaterProps** {object}
Options to be passed to [react-floater](https://github.com/gilbarbara/react-floater).

**getHelpers** {\(\) => StoreHelpers\)} Get the store methods to control the tour programatically. `prev, next, go, close, skip, reset, info`
**getHelpers** {() => StoreHelpers}
Get the store methods to control the tour programmatically. `prev, next, go, close, skip, reset, info`

**hideBackButton** {boolean} ▶︎ `false`
Hide the "back" button.

**hideCloseButton** {boolean} ▶︎ `false`
Hide the "close" button.

**locale** {object} ▶︎ `{ back: 'Back', close: 'Close', last: 'Last', next: 'Next', skip: 'Skip' }`
**locale** {object} ▶︎ `{ back: 'Back', close: 'Close', last: 'Last', next: 'Next', open: 'Open the dialog', skip: 'Skip' }`
The strings used in the tooltip.

**run** {boolean} ▶︎ `true`
Expand Down

0 comments on commit 6c7b80e

Please sign in to comment.