Skip to content

NIAID-Data-Ecosystem/nde-ui

Repository files navigation

⚠️ Deprecation Notice

As of February 2024, the NDE UI design system is officially deprecated. Why is it being deprecated? The NDE UI design system is exclusively used within the NIAID Data Ecosystem Portal. For this reason, there is no strong need for a separate package, choosing instead the simplicity of maintaining all UI related components in the NDE Portal repository.

What does this mean? No New Features: The project will no longer receive updates or new features. Limited Support: We will offer limited support, mainly focusing on critical bug fixes and security updates, until February 2024.

Questions and Support For any questions or support regarding the deprecation, please open an issue on our GitHub repository.

Add to project

yarn add nde-design-system

Usage

  • Components require a Theme Provider to apply the styles.
import {ThemeProvider} from 'nde-ui';

<ThemeProvider>
  <FontFace />
  <App />
</ThemeProvider>;
  • The NDE design system extends Chakra-UI functionality. Refer to their docs for more info.

Storybook

To view all components available, clone the repo and run:

yarn install
yarn run storybook

About

Design library for the NIAID Data Ecosystem

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published