heading-has-content

Enforce that heading elements (h1, h2, etc.) have content and that the content is accessible to screen readers. Accessible means that it is not hidden using the aria-hidden prop. Refer to the references to learn about why this is important.

References

  1. axe-core, empty-heading

Rule details

This rule takes one optional object argument of type object:

json { "rules": { "jsx-a11y/heading-has-content": [ 2, { "components": [ "MyHeading" ], }], } }

For the components option, these strings determine which JSX elements (always including <h1> thru <h6>) should be checked for having content. This is a good use case when you have a wrapper component that simply renders an h1 element (like in React):

```js // Header.js const Header = props => { return (

{ props.children }

); }

...

// CreateAccount.js (for example) ... return (

Create Account

); ```

Bad

jsx function Foo(props) { return <label {...props} /> }

Succeed

```jsx

Heading Content!

``` ### Fail ```jsx

```