Description
@cchaos and @1Copenut were discussing the callout heading prop defaulting to a P tag in PR #5870 5870. We opted to leave the default as a P tag for now and open an exploratory ticket for improved awareness. We want consuming applications to be aware callouts should have a relevant heading that is properly nested (H4 if under an H3 for example) when it makes sense.
Making sure callouts have proper headings is especially important if the text is styled in such a way as to suggest prominence or greater importance than paragraph text.
There are two items we'd like to look at specifically:
- Callout guidance in the
EuiCallout docs page outlining why a properly nested heading is important for assistive technology. I'll list some relevant links below.
- Making the
heading prop required by consuming apps in the future. This feels like a good defensive coding strategy. It also has potential to be a breaking change.
Guidance
Description
@cchaos and @1Copenut were discussing the callout
headingprop defaulting to a P tag in PR #5870 5870. We opted to leave the default as a P tag for now and open an exploratory ticket for improved awareness. We want consuming applications to be aware callouts should have a relevant heading that is properly nested (H4 if under an H3 for example) when it makes sense.Making sure callouts have proper headings is especially important if the text is styled in such a way as to suggest prominence or greater importance than paragraph text.
There are two items we'd like to look at specifically:
EuiCalloutdocs page outlining why a properly nested heading is important for assistive technology. I'll list some relevant links below.headingprop required by consuming apps in the future. This feels like a good defensive coding strategy. It also has potential to be a breaking change.Guidance