@fidesui/components

FidesUI Components

Adding a new component

1. Match the structure of src/example-component
   • index.ts - Should re-export names that are part of the public interface of the component.
   • Component.tsx - And any other files required for the new functionality.
   • Component.stories.tsx - Stories that demonstrate the new functionality.
2. Export the new component's interface from src/index.ts.

Publishing an update

Merging a pull request with component changes should automatically:

• Bump the package version
• Create a git tag
• Update the changelog
• And publish to NPM

By default this will create a "chore" update: bump the patch version and generate the changelog.

To create a more robust changelog, you can use Conventional Commits syntax when closing your PR with a squash message.

Importing an update

Once CI has finished, the updated version should appear on NPM. Bump the dependency version in your other app's package.json, run npm install, and see the updates appear.