feat: add ambient typings for React projects #659
Draft
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.
PR Checklist
Please check if your PR fulfills the following requirements:
Describe the new behavior?
Introduces a custom plugin into the custom elements manifest build pipeline to generate a
.d.ts
file that can be consumed by React-based projects that are using TypeScript. This augments the globalJSX.IntrinsicElements
interface with information about the<forge-*>
elements to ensure type safety for properties, attributes, and events.Here is an example of how it would be used in a React project:
Additional information
This was specifically introduced for usage in React v19 projects now that it supports communication with custom elements natively. React projects prior to React v19 should continue to use the
@tylertech/forge-react
adapter library.