facebookarchive/draft-js

Changing customStyleMap doesn’t trigger re-render until contentState is changed

Open

#999 opened on Feb 7, 2017

View on GitHub
 (15 comments) (4 reactions) (0 assignees)JavaScript (22,554 stars) (2,646 forks)batch import
enhancementhelp wanted

Description

Do you want to request a feature or report a bug? Bug.

What is the current behavior? After customStyleMap is changed, nothing happens until contentState is changed.

If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem..

Check it out here: https://jsfiddle.net/m6z0xn4r/125/

What is the expected behavior?

#52 suggests that this exact problem has been cleared up. Regression?? Or am I not understanding how to do the thing?

Which versions of Draft.js, and which browser / OS are affected by this issue? Did this work in previous versions of Draft.js? Latest, macOS, seems like all browsers. Dunno about previous versions.

Contributor guide

Tech stack
javascriptreact
Domain
frontend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
Basic understanding of React lifecycleFamiliarity with Draft.js Editor component
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the provided jsfiddle (https://jsfiddle.net/m6z0xn4r/125/) that demonstrates the bug. The issue is that changing `customStyleMap` does not trigger a re render until `contentState` is changed. Look into Draft.js's `Editor` component to see how it uses `customStyleMap` and whether it's properly included in the component's state or props to trigger re renders. Check the Draft.js source code for how `customStyleMap` is handled in `Editor.react.js` and if there is a missing `shouldComponentUpdate` or `componentDidUpdate` logic. Note that the repository is archived, so the fix may not be merged; however, the analysis can still be done for learning purposes.