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.

Sign up for GitHub

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

Remove steps from tour options #23

Merged
merged 1 commit into from
May 12, 2021
Merged

Remove steps from tour options #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions schema/user-tours.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"properties": {
"id": {
"type": "string",
"description": "A machine-readble ID to identify this tour, will be prefixed. Should be unique within this document."
"description": "A machine-readable ID to identify this tour, will be prefixed. Should be unique within this document."
},
"label": {
"type": "string",
Expand All @@ -36,6 +36,10 @@
"options": {
"description": "Other options for the tour",
"$ref": "#/definitions/Props"
},
"translation": {
"description": "Translation domain containing for this tour",
"type": "string"
}
}
}
Expand Down Expand Up @@ -283,12 +287,6 @@
"stepIndex": {
"type": "number"
},
"steps": {
"items": {
"$ref": "#/definitions/Step"
},
"type": "array"
},
"styles": {
"$ref": "#/definitions/Styles"
},
Expand Down
8 changes: 6 additions & 2 deletions src/tokens.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,15 @@ export interface ITour {
*/
steps: Array<IStep>;
/**
* A full tour description
* Tour options
*
* @see https://docs.react-joyride.com/props
*
* #### Notes
*
* All options are accepted except the steps entry.
*/
options?: JoyrideProps;
options?: Omit<JoyrideProps, 'steps'>;
}

/**
Expand Down