From 6481353da3a5721100cecca4abe94a2f04bbf461 Mon Sep 17 00:00:00 2001 From: Ricky Reusser Date: Thu, 18 May 2017 11:15:39 -0400 Subject: [PATCH 1/2] Add `skip` documentation --- src/components/sliders/attributes.js | 6 +++++- src/components/updatemenus/attributes.js | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/src/components/sliders/attributes.js b/src/components/sliders/attributes.js index f175aa50f57..d344b0f078b 100644 --- a/src/components/sliders/attributes.js +++ b/src/components/sliders/attributes.js @@ -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 creating a component interface and attach to', + 'slider events manually via JavaScript.' ].join(' ') }, args: { diff --git a/src/components/updatemenus/attributes.js b/src/components/updatemenus/attributes.js index 2da8f3a85e6..10a3d154c65 100644 --- a/src/components/updatemenus/attributes.js +++ b/src/components/updatemenus/attributes.js @@ -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 creating a component interface and attach to', + 'updatemenu events manually via JavaScript.' ].join(' ') }, args: { From bad0808a81680f8a054ced333cccfac8287431c8 Mon Sep 17 00:00:00 2001 From: Ricky Reusser Date: Thu, 18 May 2017 11:17:38 -0400 Subject: [PATCH 2/2] Typo fix in component docs --- src/components/sliders/attributes.js | 2 +- src/components/updatemenus/attributes.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/components/sliders/attributes.js b/src/components/sliders/attributes.js index d344b0f078b..8687c6728ad 100644 --- a/src/components/sliders/attributes.js +++ b/src/components/sliders/attributes.js @@ -27,7 +27,7 @@ var stepsAttrs = { '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 creating a component interface and attach to', + 'updates. This may be used to create a component interface and attach to', 'slider events manually via JavaScript.' ].join(' ') }, diff --git a/src/components/updatemenus/attributes.js b/src/components/updatemenus/attributes.js index 10a3d154c65..3ffffdc5296 100644 --- a/src/components/updatemenus/attributes.js +++ b/src/components/updatemenus/attributes.js @@ -25,7 +25,7 @@ var buttonsAttrs = { '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 creating a component interface and attach to', + 'updates. This may be used to create a component interface and attach to', 'updatemenu events manually via JavaScript.' ].join(' ') },