@hashicorp/design-system-components

design-system-components

A package containing the components for the Helios Design System.

Compatibility

• Ember.js v3.28 or above
  • Note: The library should work with earlier versions of Ember, but we only test with Ember 3.28 and newer
• Ember CLI v3.28 or above
• Node.js v12 or above

Installation

yarn 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',
  ],
},

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 system team (we can try to find a workaround).

Usage

See the dedicated components website: https://design-system-components-hashicorp.vercel.app/

Contributing

See the Contributing guide for details.

License

This project is licensed under the Mozilla Public License 2.0.