Skip to content

Add skip documentation #1702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 18, 2017
Merged

Add skip documentation #1702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6481353
Add `skip` documentation
rreusser May 18, 2017
bad0808
Typo fix in component docs
rreusser May 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/components/sliders/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,11 @@ var stepsAttrs = {
dflt: 'restyle',
role: 'info',
description: [
'Sets the Plotly method to be called when the slider value is changed.'
'Sets the Plotly method to be called when the slider value is changed.',
'If the `skip` method is used, the API slider will function as normal',
'but will perform no API calls and will not bind automatically to state',
'updates. This may be used to create a component interface and attach to',
'slider events manually via JavaScript.'
].join(' ')
},
args: {
Expand Down
6 changes: 5 additions & 1 deletion src/components/updatemenus/attributes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ var buttonsAttrs = {
dflt: 'restyle',
role: 'info',
description: [
'Sets the Plotly method to be called on click.'
'Sets the Plotly method to be called on click.',
'If the `skip` method is used, the API updatemenu will function as normal',
'but will perform no API calls and will not bind automatically to state',
'updates. This may be used to create a component interface and attach to',
'updatemenu events manually via JavaScript.'
].join(' ')
},
args: {
Expand Down