Update TourKit README to correct primaryButton example and formatting (#37427)
This commit is contained in:
parent
a77e4abffe
commit
de111c1edb
|
@ -0,0 +1,4 @@
|
|||
Significance: patch
|
||||
Type: dev
|
||||
|
||||
Update TourKit README to correct primaryButton example and formatting.
|
|
@ -33,7 +33,9 @@ function Tour() {
|
|||
descriptions: {
|
||||
desktop: 'Lorem ipsum dolor sit amet.',
|
||||
},
|
||||
primaryButtonText: "Done"
|
||||
primaryButton: {
|
||||
text: 'Done',
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
|
@ -107,6 +109,7 @@ The main API for configuring a tour is the config object. See example usage and
|
|||
|
||||
- `popperModifiers`: The tour uses Popper to position steps near reference elements (and for other effects). An implementation can pass its own modifiers to tailor the functionality further e.g. more offset or padding from the reference element.
|
||||
- `tourRating` (optional - only in WPCOM Tour Kit variant):
|
||||
|
||||
- `enabled`: Whether to show rating in last step.
|
||||
- `useTourRating`: (optional) A hook to provide the rating from an external source/state (see [types.ts](./src/types.ts)).
|
||||
- `onTourRate`: (optional) A callback to fire off when a rating is submitted.
|
||||
|
|
Loading…
Reference in New Issue