@dynamic-framework/ui-react

Dynamic UI

Quickly create feature-rich financial applications through a robust micro frontend architecture of React-based components with customizable templates built for integration.

Getting Started

Installation

npm install @dynamic-framework/ui-react

For more details, visit the npm package page.

CSS Distribution Change

Important: Starting from version 2.3.0, only dynamic-ui.css and dynamic-ui.min.css are distributed. The previous variants dynamic-ui-root.css and dynamic-ui-non-root.css have been removed to simplify upgrades and avoid desynchronization issues.

• To customize design tokens or variables, include dynamic-ui.css and override the variables you need in your own stylesheet or snippet.
• All default variables are included in the main bundle, ensuring safe upgrades and consistent behavior.
• For advanced customization, refer to the Storybook design tokens documentation and docs.modyo.com.

Development Commands

For local development and testing, you can use the following commands after clone the project:

• Install deps: Install required deps for development

  npm install
  

• Build: Compiles the project for distribution.

  npm run build
  

• Test: Runs all unit tests.

  npm test
  

• Test with Coverage: Runs unit tests and generates a coverage report.

  npm run test:coverage
  

• Storybook: Starts the Storybook development server to browse components.

  npm run storybook
  

Documentation and Useful Links

• Official Documentation: Find guides and in-depth documentation at docs.modyo.com/en/dynamic.
• Framework Website: Visit our main site at dynamicframework.dev.
• Component Library: Explore our components in Storybook at react.dynamicframework.dev.

Made with 💚 by Modyo