Skip to content

README.md

Latest commit

 

History

History
64 lines (44 loc) · 2.04 KB

README.md

File metadata and controls

64 lines (44 loc) · 2.04 KB

design-system-components

A package containing the components for the Helios Design System.

npm version

Compatibility

  • Ember.js v4.12 or above
  • Ember CLI v4.12 or above
  • Node.js v18 or above

Installation

pnpm add @hashicorp/design-system-components

You will need to do three things before importing the styles into your app:

  1. Install ember-cli-sass
ember install ember-cli-sass
  1. Change app/styles/app.css to app/styles/app.scss
  2. Add the following to the app definition (starts on/around line 6 in new Ember apps) in ember-cli-build.js
sassOptions: {
  precision: 4,
  includePaths: [
    './node_modules/@hashicorp/design-system-tokens/dist/products/css',
    './node_modules/@hashicorp/design-system-components/dist/styles',
  ],
},

Finally, add this line to the top of your app's style file (app.scss or similar):

@import '@hashicorp/design-system-components';

⚠️ Notice: our component library assumes that a *, *::before, *::after { box-sizing: border-box; } reset is applied globally in the CSS of the application. If in your use case this is not true, please speak with the Design Systems Team (we can try to find a workaround).

Usage

See the dedicated components website: https://helios.hashicorp.design/components

Contributing

See the Contributing guide for details.

License

This project is licensed under the Mozilla Public License 2.0.