@charm-ux/fui

CHARM-FUI — Coherence + HARMony core components extended for Fluent UI.

A library of Fluent-aligned web components, utilities, and theming primitives, built on top of @charm-ux/core.

Install

npm install @charm-ux/fui
# or
pnpm add @charm-ux/fui
# or
yarn add @charm-ux/fui

Getting started

Prerequisites

• Node.js >= 18.14.1 (see .nvmrc; nvm use will pick this up)
• pnpm 9.x (npm install -g pnpm@latest-9 or brew install pnpm@9)

Local development

pnpm install
pnpm dev          # runs Storybook for the web components
pnpm dev:react    # runs Storybook for the React wrappers

Storybook

Each surface has its own Storybook configuration:

pnpm storybook:dev        # web components (port 6006)
pnpm storybook:react      # React wrappers (port 6007)
pnpm storybook:build      # builds both static sites

Testing

pnpm test                       # run all tests
pnpm test:components-single     # run a single component's tests
pnpm test:performance           # run performance tests
pnpm test:watch                 # watch mode

Contributing

We welcome contributions! Please read CONTRIBUTING.md before opening a pull request.

Changelog & versioning

This project uses changesets for versioning and changelog management.

Before opening a PR, add a changeset:

pnpm changeset

The CLI will prompt you for the change type and a short description. Commit the resulting .changeset/*.md file with your PR.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Security

If you believe you have found a security vulnerability, please follow the disclosure guidance in SECURITY.md.

License

MIT © Microsoft Corporation