Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates #713

Merged
merged 3 commits into from Aug 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions .eslintrc
Expand Up @@ -3,9 +3,7 @@
"airbnb",
"plugin:flowtype/recommended",
"plugin:prettier/recommended",
"prettier/flowtype",
"prettier/react",
"prettier/standard"
"prettier"
],
"parser": "babel-eslint",
"env": {
Expand Down
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
2 changes: 1 addition & 1 deletion jest.config.js
Expand Up @@ -10,7 +10,7 @@ module.exports = {
},
setupFiles: ['<rootDir>/test/__setup__/setupFiles.js'],
setupFilesAfterEnv: ['<rootDir>/test/__setup__/setupTests.js'],
testEnvironment: 'jest-environment-jsdom-global',
testEnvironment: 'jsdom',
testEnvironmentOptions: {
resources: 'usable',
},
Expand Down