Our guide to using dependencies with your custom React components.
In Aurora version 25.02, we introduced validation to the build to ensure that only allowlisted dependencies that are already installed by Aurora are used for custom React components.
Any dependencies in a custom React component's package.json file that are not in this allowlist will cause the Github Actions Build to fail (or fail things locally when you run npm run build
) and prevent the component from being installed.
If a dependency outside the allowlist is added to the package.json file for a component, the build fails with an error similar to the following:
[17:16:52.727] ERROR (build/16317): Validation Error: Disallowed dependencies found in /Users/john.doe/gitrepos/community-khoros-internal/johnscommunityrepo/src/components/FooterComponent/package.json: @tanstack/react-table. Only the following dependencies are allowed: react, react-bootstrap, react-hook-form, react-uid, react-dropzone, moment-timezone, @coveo/atomic-react, @coveo/atomic, @coveo/headless-react, @coveo/headless
The following dependencies are currently allowlisted and can be added to a custom React component if needed:
- react
- react-bootstrap
- react-hook-form
- react-uid
- react-dropzone
- moment-timezone
- @coveo/atomic-react
- @coveo/atomic
- @coveo/headless-react
- @coveo/headless
If your custom React components require additional dependencies, open a support ticket. We will review the dependency before approving it. If it hasn't already been added, it will be included in a future Aurora release.
ATLAS
Comments