UNPKG

@primo/styles

Version:
63 lines (41 loc) 2.23 kB
# @primo/styles [![NPM version](https://badgen.net/npm/v/@primo/styles)](https://www.npmjs.org/package/@primo/styles) > Styles for the Primo Design System ## Getting started To install `@primo/styles` to your new or exsisting project, you will need to run the following command using [npm](https://www.npmjs.com/): ```bash npm install -S @primo/styles ``` If you use [Yarn](https://yarnpkg.com/en/), use the following command instead: ```bash yarn add @primo/styles ``` This package requires [Dart Sass](http://npmjs.com/package/sass) in order to compile. If you're new to Sass, or are wondering how to configure Sass for your project, we recommend checking out the following resources and links: - [Sass Basics](https://sass-lang.com/guide) - [Webpack with Sass](https://webpack.js.org/loaders/sass-loader/) - [Next.js with Sass](https://nextjs.org/docs/basic-features/built-in-css-support#sass-support) - [Create React App with Sass](https://create-react-app.dev/docs/adding-a-sass-stylesheet/) - [Parcel with Sass](https://v2.parceljs.org/languages/sass/) - [Vite with Sass](https://vitejs.dev/guide/features.html#css-pre-processors) - [Snowpack with Sass](https://www.snowpack.dev/guides/sass/) Once you get Sass up and running in your project, make sure to configure Sass to include `node_modules` in its `includePaths` option. ## Usage You can bring in all the styles for the Primo Design System by including `@primo/styles` in your Sass files. For example: ```scss @use '@primo/styles'; ``` ## Public Storybook If you wish to see our styles components live, and the most recent version and changes please visit here: [@primo/styles - Storybook](https://main--6377de0c8a29e4b5116a392b.chromatic.com) ## ✍️ Feedback Please ask any questions on this project, you can do so by [creating a new issue](https://github.com/primo-design-system/primo/issues/new/choose). Or contributing to any [active issues](https://github.com/primo-design-system/primo/issues). If you wish to get in contact, please don't hesitate via twitter [@Rich_McCartney](https://twitter.com/rich_mccartney). ## 📝 Licence Licensed under standard [MIT license](https://github.com/primo-design-system/primo/blob/main/LICENSE).