style-prop-object.md

Enforce style prop value being an object (react/style-prop-object)

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

Rule Details

The following patterns are considered warnings:

<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 });

The following patterns are not considered warnings:

<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 });

Rule Options

...
"react/style-prop-object": [<enabled>, {
  "allow": [<string>]
}]
...

allow

A list of elements that are allowed to have a non-object value in their style attribute. The default value is [].

Example

{
  "allow": ["MyComponent"]
}

The following patterns are considered warnings:

<Hello style="a string">
React.createElement(Hello, { style: "some styling" });

The following patterns are not considered warnings:

<MyComponent style="a string">
React.createElement(MyComponent, { style: "some styling" });