Skip to content

Commit ada3762

Browse files
committed
Add documentation for observe step property
1 parent e64ffba commit ada3762

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -336,6 +336,7 @@ steps: PropTypes.arrayOf(PropTypes.shape({
336336
'style': PropTypes.object,
337337
'stepInteraction': PropTypes.bool,
338338
'navDotAriaLabel': PropTypes.string,
339+
'observe': PropTypes.string,
339340
})),
340341
```
341342
@@ -369,6 +370,10 @@ const steps = [
369370
stepInteraction: false,
370371
// Text read to screen reader software for this step's navigation dot
371372
navDotAriaLabel: 'Go to step 4',
373+
// Observe direct children DOM mutations of this node
374+
// If a child is added: the highlighted region is redrawn focused on it
375+
// If a child is removed: the highlighted region is redrawn focused on the step selector node
376+
observe: '[data-tour="observable-parent"]',
372377
},
373378
// ...
374379
]

0 commit comments

Comments
 (0)