-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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.
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
Disabled: update docs to clarify the absence of inert polyfill #45272
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good catch!
As far as I could tell, this is only applicable to the inert
polyfill, and to the Disabled
component. So for now I think it would be more helpful to call this out in the docs for Disabled (specifically mentioning that you need an inert
polyfill).
Makes sense! I went ahead and applied the suggestions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Very helpful note with the links! ✨ I feel like it would be better to put that note in the component's main JSDoc and README, since it's not specific to Storybook, no?
Makes sense ! Just pushed those updates too |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🚀
Flagged for Dev Note in a "Updates to components" dev note to point out that the documentation has changed. :-) |
What?
Closes #45253
Update
Disabled
docs to clarify that theinert
polyfill is not loadedWhy?
To manage expectations when interacting with the component in browsers where the
inert
attribute is not supported✍️ Dev Note
The
Disabled
component internally relies on theinert
property. In order to manage expectations when interacting with the component in browsers where theinert
attribute is not supported, the component's docs were updated to clarify that the polyfill for theinert
property needs to be added by the consumer of the@wordpress/components
package.