ni | nimble

Nimble

The NI Nimble Design System: Styled UI components for NI applications.

If you are at NI, lucky you! Reach out to ask questions via Microsoft Teams on the Design System General channel or via NI Stack Overflow with the nimble tag.

If you are outside NI, we want to hear from you too! See how to reach out in the Community section below.

Getting Started

See the corresponding Getting Started section in the packages hosted in the repository. Most applications will start by leveraging the Nimble packages.

Nimble packages

The Nimble packages contain general-use components implementing the Nimble Design System for use by all applications.

• @ni/nimble-angular - Angular bindings for Nimble components.
• @ni/nimble-blazor - Blazor bindings for Nimble components.
• @ni/nimble-components - Nimble components to be used by any type of application.

Spright packages

The Spright packages contain components that are built using Nimble technology and design patterns but tailored for specific use-cases or applications instead of being general purpose.

• @ni/spright-angular - Angular bindings for Spright components.
• @ni/spright-blazor - Blazor bindings for Spright components.
• @ni/spright-components - Spright components to be used by any type of application.

Utility packages

Tools and utilities hosted in the repository.

• @ni/nimble-tokens - Base design tokens used by the Nimble and Spright component packages.
• @ni/jasmine-parameterized - a utility for writing Jasmine parameterized tests.
• @ni/xliff-to-json-converter - a utility to convert translation files from XLIFF to JSON for Angular localization.

The above packages follow Semantic Versioning. Consult the CHANGELOG.md for each package to see the changes in each version, including instructions for adapting your application in response to breaking changes.

Community

We welcome feedback and contributions!

The fastest way to ask questions is to join the discussion on Teams or the NI Stack Overflow (accessible to NI employees only). You can also start a discussion on GitHub by filing an issue using the 🎙 Discussion template.

Requesting New Components and Features

Is Nimble missing a component that your team needs? Check the Component Status page and search the Issues list to see if it's on our radar. If an issue exists already, comment with your use cases. If no issue exists yet, file a new one using the 🙋 Feature Request template.

Filing Bugs

To report a bug with an existing component, file an issue using the 🐛 Bug Report template.

Contributing

See Getting Started in Contributing.md to get started with building the monorepo.