Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gilbarbara committed Jan 4, 2024
1 parent 28ea4fc commit 6c84d3e
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
9 changes: 5 additions & 4 deletions docs/constants.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ You should use them in your component for the callback events.
import Joyride, { ACTIONS, EVENTS, LIFECYCLE, STATUS } from 'react-joyride';
```

[Actions](https://github.com/gilbarbara/react-joyride/blob/master/src/constants/actions.js) - The action that updated the state.
ACTIONS - The action that updated the state.

[Events](https://github.com/gilbarbara/react-joyride/blob/master/src/constants/events.js) - The type of the event.
EVENTS - The type of the event.

[Lifecycle](https://github.com/gilbarbara/react-joyride/blob/master/src/constants/lifecycle.js) - The step lifecycle.
LIFECYCLE - The step lifecycle.

[Status](https://github.com/gilbarbara/react-joyride/blob/master/src/constants/status.js) - The tour's status.
STATUS - The tour's status.

Consult the [source code](https://github.com/gilbarbara/react-joyride/blob/main/src/literals/index.ts) for more information.
2 changes: 1 addition & 1 deletion docs/step.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Step will inherit some properties from Joyride's own [props](props.md) but you c
- disableOverlay
- disableOverlayClose
- disableScrolling
- floaterProps \(check the [getMergedStep](https://github.com/gilbarbara/react-joyride/blob/master/src/modules/step.js) function for more information\)
- floaterProps \(check the [getMergedStep](https://github.com/gilbarbara/react-joyride/blob/main/src/modules/step.ts) function for more information\)
- hideBackButton
- hideCloseButton
- locale
Expand Down
2 changes: 1 addition & 1 deletion docs/styling.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export class App extends React.Component {

You can customize the styles per step too.

Check [styles.js](https://github.com/gilbarbara/react-joyride/tree/3e08384415a831b20ce21c8423b6c271ad419fbf/src/styles.js) for more information.
Check [styles.js](https://github.com/gilbarbara/react-joyride/blob/main/src/styles.ts) for more information.

Or if you need finer control you can use you own components for the beacon and tooltip. Check the [custom components](custom-components.md) documentation.

Expand Down

0 comments on commit 6c84d3e

Please sign in to comment.