jsx-eslint/eslint-plugin-react

react/style-prop-object: document performance issues

Open

#1913 opened on Aug 5, 2018

View on GitHub
 (0 comments) (1 reaction) (0 assignees)JavaScript (8,630 stars) (2,797 forks)batch import
documentationhelp wanted

Description

It may help out future developers if it's noted in the style-prop-object documentation that using an object as the value for the style parameter will cause performance issues due to unnecessary re-rendering.

Contributor guide

Tech stack
javascriptreact
Domain
documentationperformance
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Familiarity with ESLint plugin documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Locate the documentation file for the `style prop object` rule in the eslint plugin react repository (likely in `docs/rules/style prop object.md` or similar). Add a note explaining that using an object as the `style` prop value causes unnecessary re renders because React creates a new object reference each render, avoiding inline objects or memoizing them. Refer to React's performance documentation for context. Ensure the note aligns with the rule's existing documentation style.