Add warning when Settings.setAppElement is not set. #1460
Conversation
…etAppElement was not set. - Add ariaHideApp element as a way to opt out of having to set App Element. To opt out, ariaHideApp=false must be set.
|
This will show the following warning:
Just an observation: I guess the difference here is that we should also let consumers know that |
| @@ -31,6 +31,7 @@ const defaultProps = { | |||
| assistiveText: { | |||
| trigger: 'Open App Launcher', | |||
| }, | |||
| ariaHideApp: true, | |||
There was a problem hiding this comment.
React modal has this prop to "opt out" of setAppElement. I think we should use that as well.
| @@ -181,6 +188,9 @@ class Modal extends React.Component { | |||
| componentWillMount () { | |||
| this.generatedId = shortid.generate(); | |||
| checkProps(MODAL, this.props); | |||
| if (this.props.ariaHideApp) { | |||
| checkAppElementIsSet(); | |||
There was a problem hiding this comment.
If consumer hasn't opted-out, check if the app element was set. The app-launcher component also uses this modal internally so I only need to add this check here.
|
I'd like to not have truthy default props, but since |
Settings.setAppElement(el)was not set prior to using this component.ariaHideApponModalandApp Lauchercomponent as a way to opt-out of having to setSettings.setAppElement(el).Fixes #780
Additional description
CONTRIBUTOR checklist (do not remove)
Please complete for every pull request
npm run lint:fixhas been run and linting passes.components/component-docs.jsonCI tests pass (npm test).REVIEWER checklist (do not remove)
components/component-docs.jsontests.last-slds-markup-reviewinpackage.jsonand push.last-accessibility-review, topackage.jsonand push.npm run local-updatewithin locally cloned site repo to confirm the site will function correctly at the next release.