Skip to content

Commit cea9455

Browse files
authored
Merge pull request #1702 from plotly/add-skip-documentation
Add `skip` documentation
2 parents e83c216 + bad0808 commit cea9455

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

src/components/sliders/attributes.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ var stepsAttrs = {
2424
dflt: 'restyle',
2525
role: 'info',
2626
description: [
27-
'Sets the Plotly method to be called when the slider value is changed.'
27+
'Sets the Plotly method to be called when the slider value is changed.',
28+
'If the `skip` method is used, the API slider will function as normal',
29+
'but will perform no API calls and will not bind automatically to state',
30+
'updates. This may be used to create a component interface and attach to',
31+
'slider events manually via JavaScript.'
2832
].join(' ')
2933
},
3034
args: {

src/components/updatemenus/attributes.js

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ var buttonsAttrs = {
2222
dflt: 'restyle',
2323
role: 'info',
2424
description: [
25-
'Sets the Plotly method to be called on click.'
25+
'Sets the Plotly method to be called on click.',
26+
'If the `skip` method is used, the API updatemenu will function as normal',
27+
'but will perform no API calls and will not bind automatically to state',
28+
'updates. This may be used to create a component interface and attach to',
29+
'updatemenu events manually via JavaScript.'
2630
].join(' ')
2731
},
2832
args: {

0 commit comments

Comments
 (0)