Skip to content

react/jsx-boolean-value Style

🛠️ An auto-fix is available for this rule.

What it does

Enforce a consistent boolean attribute style in your code.

Why is this bad?

In JSX, you can set a boolean attribute to true or omit it. This rule will enforce a consistent style for boolean attributes.

Examples

Examples of incorrect code for this rule:

jsx
const Hello = <Hello personal={true} />;

Examples of correct code for this rule:

jsx
const Hello = <Hello personal />;

Configuration

This rule accepts a configuration object with the following properties:

assumeUndefinedIsFalse

type: boolean

default: false

If true, treats prop={false} as equivalent to the prop being undefined

enforceBooleanAttribute

type: "always" | "never"

default: "never"

Enforce boolean attributes to always or never have a value.

exceptions

type: string[]

default: []

List of attribute names to exclude from the rule.

How to use

To enable this rule in the CLI or using the config file, you can use:

bash
oxlint --deny react/jsx-boolean-value --react-plugin
json
{
  "plugins": ["react"],
  "rules": {
    "react/jsx-boolean-value": "error"
  }
}

References

Released under the MIT License.