Skip to content
โ† Back to rules

react/style-prop-object Suspicious

What it does โ€‹

Require that the value of the prop style be an object or a variable that is an object.

Why is this bad? โ€‹

The style prop expects an object mapping from style properties to values when using JSX.

Examples โ€‹

Examples of incorrect code for this rule:

jsx
<div style="color: 'red'" />
<div style={true} />
<Hello style={true} />
const styles = true;
<div style={styles} />

React.createElement("div", { style: "color: 'red'" });
React.createElement("div", { style: true });
React.createElement("Hello", { style: true });
const styles = true;
React.createElement("div", { style: styles });

Examples of correct code for this rule:

jsx
<div style={{ color: "red" }} />
<Hello style={{ color: "red" }} />
const styles = { color: "red" };
<div style={styles} />

React.createElement("div", { style: { color: 'red' }});
React.createElement("Hello", { style: { color: 'red' }});
const styles = { height: '100px' };
React.createElement("div", { style: styles });

Configuration โ€‹

This rule accepts a configuration object with the following properties:

allow โ€‹

type: string[]

default: []

List of component names on which to allow style prop values of any type.

How to use โ€‹

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

json
{
  "plugins": ["react"],
  "rules": {
    "react/style-prop-object": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  plugins: ["react"],
  rules: {
    "react/style-prop-object": "error",
  },
});
bash
oxlint --deny react/style-prop-object --react-plugin

References โ€‹