kamrify commited on
Commit
43c0911
·
1 Parent(s): 2e0d6f9

Update docs

Browse files
Files changed (1) hide show
  1. readme.md +6 -0
readme.md CHANGED
@@ -154,12 +154,18 @@ const driver = new Driver({
154
  opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
155
  padding: 10, // Distance of element from around the edges
156
  allowClose: true, // Whether the click on overlay should close or not
 
 
 
 
 
157
  scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
158
  onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
159
  onHighlighted: (Element) {}, // Called when element is fully highlighted
160
  onDeselected: (Element) {}, // Called when element has been deselected
161
  });
162
  ```
 
163
 
164
  ### Step Definition
165
 
 
154
  opacity: 0.75, // Background opacity (0 means only popovers and without overlay)
155
  padding: 10, // Distance of element from around the edges
156
  allowClose: true, // Whether the click on overlay should close or not
157
+ doneBtnText: 'Done', // Text on the final button
158
+ closeBtnText: 'Close', // Text on the close button for this step
159
+ nextBtnText: 'Next', // Next button text for this step
160
+ prevBtnText: 'Previous', // Previous button text for this step
161
+ showButtons: false, // Do not show control buttons in footer
162
  scrollIntoViewOptions: {}, // We use `scrollIntoView()` when possible, pass here the options for it if you want any
163
  onHighlightStarted: (Element) {}, // Called when element is about to be highlighted
164
  onHighlighted: (Element) {}, // Called when element is fully highlighted
165
  onDeselected: (Element) {}, // Called when element has been deselected
166
  });
167
  ```
168
+ Note that all the button options that you provide in the driver definition can be overridden for a specific step by giving them in the step definition
169
 
170
  ### Step Definition
171