-
Notifications
You must be signed in to change notification settings - Fork 879
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[labs/react] Fix for #2799: add support for properties with custom accessors #2800
Merged
justinfagnani
merged 3 commits into
lit:main
from
lideen:fix/2799-labs-react-custom-accessors-bug
Aug 11, 2022
Merged
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -136,6 +136,7 @@ export const createComponent = <I extends HTMLElement, E extends Events>( | |
) => { | ||
const Component = React.Component; | ||
const createElement = React.createElement; | ||
const eventProps = new Set(Object.keys(events ?? {})); | ||
|
||
// Props the user is allowed to use, includes standard attributes, children, | ||
// ref, as well as special event and element properties. | ||
|
@@ -157,28 +158,6 @@ export const createComponent = <I extends HTMLElement, E extends Events>( | |
__forwardedRef?: React.Ref<unknown>; | ||
}; | ||
|
||
// Set of properties/events which should be specially handled by the wrapper | ||
// and not handled directly by React. | ||
const elementClassProps = new Set(Object.keys(events ?? {})); | ||
for (const p in elementClass.prototype) { | ||
if (!(p in HTMLElement.prototype)) { | ||
if (reservedReactProperties.has(p)) { | ||
// Note, this effectively warns only for `ref` since the other | ||
// reserved props are on HTMLElement.prototype. To address this | ||
// would require crawling down the prototype, which doesn't feel worth | ||
// it since implementing these properties on an element is extremely | ||
// rare. | ||
console.warn( | ||
`${tagName} contains property ${p} which is a React ` + | ||
`reserved property. It will be used by React and not set on ` + | ||
`the element.` | ||
); | ||
} else { | ||
elementClassProps.add(p); | ||
} | ||
} | ||
} | ||
|
||
class ReactComponent extends Component<ComponentProps> { | ||
private _element: I | null = null; | ||
private _elementProps!: {[index: string]: unknown}; | ||
|
@@ -257,7 +236,12 @@ export const createComponent = <I extends HTMLElement, E extends Events>( | |
for (const [k, v] of Object.entries(this.props)) { | ||
if (k === '__forwardedRef') continue; | ||
|
||
if (elementClassProps.has(k)) { | ||
if ( | ||
eventProps.has(k) || | ||
(!reservedReactProperties.has(k) && | ||
!(k in HTMLElement.prototype) && | ||
k in elementClass.prototype) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We still need to verify this logic (specifically excluding |
||
) { | ||
this._elementProps[k] = v; | ||
} else { | ||
// React does *not* handle `className` for custom elements so | ||
|
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should keep this warning. We can move this into a dev build in the future.