Sheriff Design System Web Component Library

Alpha Release

This library is currently in an early alpha stage and should be considered highly experimental and unstable. It's under active development, and we're working to add more components and improve stability.

⚠️ Disclaimer

This version is intended for testing and feedback purposes only. It is not suitable for production use at this stage. Features and components may change significantly. We appreciate your interest and contributions, but please use it with caution.

Prerequisites

To visually adhere to the Sheriff design system you need to include the Roboto font in your application.

Installation

# Using npm
npm install @politiet/sheriff-web-components --save

# Using yarn
yarn add @politiet/sheriff-web-components

Note: As this is an alpha release, expect frequent updates and breaking changes. We recommend using it for experimental projects only.

Usage

To start using the components in your project, import them as follows:

All components:

import '@politiet/sheriff-web-components';

Spesific components:

import { SDSButton } from '@politiet/sheriff-web-components';

Contributing

We welcome contributions! Whether it's reporting bugs, feature requests, or contributing code, please feel free to reach out.

Feedback

Your feedback is invaluable to us. Please submit any feedback or issues you encounter through our GitHub issue tracker.

License

This project is licensed under the ISC License.