options
This prop can be passed to both
-
ROnboardingWrapper
-
ROnboardingStep
ROnboardingWrapper
's options by passing options to ROnboardingStep
Default value
{
popper: {},
overlay: {
enabled: true,
padding: 0,
borderRadius: 0
},
scrollToStep: {
enabled: true,
options: {
behavior: 'smooth',
block: 'center',
inline: 'center'
}
},
labels: {
previousButton: 'Previous',
nextButton: 'Next',
finishButton: 'Finish'
}
}
Name | Type | Default |
---|---|---|
popper |
PopperJS options | {} |
overlay |
||
overlay.enabled |
Boolean |
true |
overlay.padding |
Number { top: 0, right: 0, bottom: 0, left: 0 } |
0 |
overlay.borderRadius |
Number { leftTop: 0, rightTop: 0, rightBottom: 0, leftBottom: 0 } |
0 |
scrollToStep |
||
scrollToStep.enabled |
Boolean |
true |
scrollToStep.options |
Scroll Into View Options | { behavior: 'smooth', block: 'center', inline: 'center' } |
labels |
||
labels.previousButton |
String |
Previous |
labels.nextButton |
String |
Next |
labels.finishButton |
String |
Finish |