add disable_n_clicks prop to html components #2389
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As reported on the forum, components with event listeners can cause issues with screen readers.
https://community.plotly.com/t/how-to-remove-events-from-dash-html-components-to-avoid-misinterpretation-by-screen-readers/70477
This PR adds a
disable_n_clicks
prop to all html components, giving the ability to remove the event listener.By default,
n_clicks
will be enabled on any html component that has anid
. Ifn_clicks
is not used in a callback for that component, the event listener can be removed by settingdisable_n_clicks
=True`For example:
No event listener:
html.Div()
html.Div(id="my-id", disable_n_clicks=True)
onClick event listener:
html.Div(id="my-id")
(re-created clean pull request without the botched merge commits from #2370)