@politiet/sheriff-css-framework
v0.0.2
Published
Sheriff Design System CSS-Framework
Downloads
536
Keywords
Readme
Sheriff Design System CSS-Framework
TODO: A brief introduction to your package. Describe what it does, its target audience, and any unique features or benefits it provides.
Installation
Install the package via npm by running:
npm install @politiet/sheriff-css-framework
Usage
To use the styles in your web project, import the CSS or SCSS variables into your project files.
CSS
@import 'node_modules/@politiet/sheriff-css-framework/dist/tokens/css/variables.css';
SCSS
@use 'node_modules/@politiet/sheriff-css-framework/dist/tokens/scss/_variables.scss'
as *;
Javascript
To use the styles programmatically in JavaScript, import the styles module:
import styles from '@politiet/sheriff-css-framework/dist/tokens/js/styles.js';
Android
For Android applications, use the provided XML styles by including them in your project's resources.
Copy the styles.xml file into your Android project's res/values directory.
Reference the styles in your application as needed.
iOS (Swift)
For iOS projects, include the Swift style definitions by adding the styles.swift file to your project:
Add styles.swift to your Xcode project. Utilize the defined styles in your Swift code.
Contributing
TODO: Write how others can contribute to the design system.
License
This package is licensed under the ISC License. Feel free to use it in your projects.