Skip to content

Conversation

@Shauryan0207
Copy link

Description

@plone/types requires React but can be used in non-React frameworks (Astro, SvelteKit) for API type definitions. Made React peer dependency optional so users only needing REST API types don't have to install React.

Changes

  • Made react peer dependency optional in peerDependenciesMeta
  • Added documentation for using package without React
  • Content and services types remain React-agnostic

Checklist

  • I signed the Plone Contributor Agreement
  • Verified no other PRs for this change
  • Followed Volto contribution guidelines
  • No tests needed (dependency/doc update)
  • Added changelog entry: packages/types/news/6115.bugfix
  • Updated README with usage examples

Related

Closes #6115

Allow @plone/types to be installed without React for API-only type usage in non-React frameworks like Astro or SvelteKit.

- Mark react as optional in peerDependenciesMeta
- Add documentation for using types without React
- Content and services types are React-agnostic and can be used for REST API responses
@mister-roboto
Copy link

@Shauryan0207 you need to sign the Plone Contributor Agreement to merge this pull request.

Learn about the Plone Contributor Agreement: https://plone.org/foundation/contributors-agreement

If you have already signed the agreement, please allow a week for your agreement to be processed.
Once it is processed, you will receive an email invitation to join the plone GitHub organization as a Contributor.

If after a week you have not received an invitation, then please contact agreements@plone.org.

@Shauryan0207
Copy link
Author

I have signed it

@stevepiercy
Copy link
Collaborator

@Shauryan0207 please read and follow the third and fourth sentences. After that's completed, then add a comment stating that you've completed the process.

@Shauryan0207
Copy link
Author

@Shauryan0207 please read and follow the third and fourth sentences. After that's completed, then add a comment stating that you've completed the process.

Sure thank you

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

@plone/types dependency conflict with react-intl's React peer dependency

3 participants