Fix React unrecognized-prop warning for style field data attributes - #175
Merged
Merged
Conversation
Style field data attributes were emitted with the raw (camelCase) field name, producing e.g. data-style-blockWidth. React only forwards data-* attributes whose suffix is lowercase, so it dropped the attribute and warned in the console. Kebab-case the field name -> data-style-block-width. Single-word fields (align, theme) are unchanged.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The console showed:
Cause
toStyleFieldDataAttributesinpackages/plate/components/editor/plugins/style-fields-plugin.tsbuilt the attribute asdata-style-${fieldName}using the raw field name. ForblockWidththat yieldsdata-style-blockWidth. React only forwardsdata-*attributes whose suffix is lowercase, so it dropped the attribute and warned.Fix
Kebab-case the field name before building the attribute, so it becomes
data-style-block-width— the idiomatic HTML data-attribute form, which also round-trips cleanly viadataset.styleBlockWidth.align,theme) are unchanged, so existing CSS selectors like[data-style-align='left']keep working.--block-widthCSS variable, not this attribute, so they are unaffected.block-width-plugin.test.ts; all 26 tests pass.Notes
Swept the repo for any consumer of the old camelCase form — none remained.