@hashicorp/design-system-components 0.1.1 → 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# @hashicorp/design-system-components
+
+## 0.3.0
+
+### Minor Changes
+
+- [#48](https://github.com/hashicorp/design-system/pull/48) [`971efb9e`](https://github.com/hashicorp/design-system/commit/971efb9e92478e4d88c24aeee835f448f35d2066) Thanks [@didoo](https://github.com/didoo)! - Added "Breadcrumb" component
+
+## 0.2.0
+
+### Minor Changes
+
+- [#76](https://github.com/hashicorp/design-system/pull/76) [`48a82d54`](https://github.com/hashicorp/design-system/commit/48a82d545817c280d022cf95b2f3a691dc3c46a3) Thanks [@didoo](https://github.com/didoo)! - Added the "tertiary" color variant to the "Button" component
+
+* [#77](https://github.com/hashicorp/design-system/pull/77) [`c08711e4`](https://github.com/hashicorp/design-system/commit/c08711e4fa3fac0cd3418b8afa1a0c4c254e8fac) Thanks [@didoo](https://github.com/didoo)! - Fixed the "elevation" treatment for the "Button" component
+
+## 0.1.2
+
+### Patch Changes
+
+- Updated dependencies [[`04db4d9e`](https://github.com/hashicorp/design-system/commit/04db4d9ece6aba358acfa0721a78dfe84c561b5e)]:
+  - @hashicorp/design-system-tokens@0.6.0

package/README.md

@@ -21,7 +21,7 @@ Installation
 yarn add @hashicorp/design-system-components
 ```
 
-If you do not have `ember-cli-sass` installed, you will need to do three things before importing the styles into your app:
+You will need to do three things before importing the styles into your app:
 
 1. Install `ember-cli-sass`
 
@@ -36,7 +36,7 @@ ember install ember-cli-sass
 sassOptions: {
   precision: 4,
   includePaths: [
-    './node_modules/@hashicorp/design-system-tokens/products/css',
+    './node_modules/@hashicorp/design-system-tokens/dist/products/css',
   ],
 },
 ```

package/RELEASE.md

@@ -1,41 +1,12 @@
-# How To Release
+# How to release
 
 Whenever there is an update to the components, and these changes have been approved, we need to release them as package to the npm registry.
 
 Please see the instructions in the [CONTRIBUTING](CONTRIBUTING.md) file for more details about how to setup the project and make changes to the code for these packages.
 
-## Bump
+## Bump and release
 
-The "bump" step increases the _SemVer_ version number in the `package.json` file.
-
-* Make sure your local `main` branch is up to date.
-* Create new custom branch from `main`.
-* `cd /design-system-components`
-* Run `yarn bump` and choose the _SemVer_ version as agreed upon on the previous PR.
-  * _The `bump` command is interactive, you can move up and down with the keyboard, choose one option, and then hit "enter": the tool will automatically update the version in the `package.json` file for you._
-* Check the `git diff` for the project, you should see only the `package.json` file changed (with the new version).
-* Commit, push, open a pull request, and wait for approval.
-
-Once the PR has been approved and merged, you can finally move to the next step, the actual release.
-
-## Release
-
-The "release" step publishes the package on the npm registry, using the version declared in the `package.json` file, and [tags](https://www.atlassian.com/git/tutorials/inspecting-a-repository/git-tag) that specific release on git.
-
-_**IMPORTANT**: Once released a package on the public registry, you can't revert the changes: the only solution is to deprecate the package (this will hide it from the public, but remains there). If you need to do some tests, use a **local** package registry (see below), don't test directly in production!_
-
-* Make sure your local `main` branch is up to date.
-* You will need a company-approved 2FA-enabled account on npm to publish (see [npm 2FA docs](https://docs.npmjs.com/configuring-two-factor-authentication) for more info).
-* `cd /design-system-components`
-* `yarn release`
-* Check the git diff, you should not see any change.
-
-**Notice**: this action will automatically:
-
-* publish the new version of the package on the [NPM registry](https://www.npmjs.com/) using the current _SemVer_ version declared in the `package.json` file (the one previously chosen in the `bump` step).
-* tag the current last commit in the `main` branch and push the tag to the git origin
-
-At this point check on npm that the package ([@hashicorp/design-system-components](https://www.npmjs.com/package/@hashicorp/design-system-components) has been successfully published, and if it's so... well done! You just published your new package 🎉.
+Follow the instructions for Changesets in the root [README](../../README.md).
 
 🚨 **DON'T FORGET**:
 

package/addon/components/hds/breadcrumb/index.hbs

@@ -0,0 +1,13 @@
+<nav
+  class={{this.classNames}}
+  {{!
+    TODO: should this string be localized, like in Structure? https://github.com/hashicorp/structure/blob/dffbb0e0ae5246d3b832586ab25bcb981a052b30/packages/pds-ember/addon/components/pds/breadcrumbs/index.hbs#L3
+    (in which case, we need to expose a prop? or start to have localization in the HDS system?)
+  }}
+  aria-label="breadcrumbs"
+  ...attributes
+>
+  <ol class="hds-breadcrumb__list" {{did-insert this.didInsert}}>
+    {{yield}}
+  </ol>
+</nav>

package/addon/components/hds/breadcrumb/index.js

@@ -0,0 +1,40 @@
+import Component from '@glimmer/component';
+
+const noop = () => {};
+
+export default class HdsBreadcrumbComponent extends Component {
+  /**
+   * @param onDidInsert
+   * @type {function}
+   * @default () => {}
+   */
+  get didInsert() {
+    // TODO discuss with Matthew if this is the right way to create a guard for this method
+    return this.args.didInsert ?? noop;
+  }
+
+  /**
+   * @param itemsCanWrap
+   * @type {boolean}
+   * @default true
+   */
+  get itemsCanWrap() {
+    return this.args.itemsCanWrap ?? true;
+  }
+
+  /**
+   * Get the class names to apply to the component.
+   * @method Breadcrumb#classNames
+   * @return {string} The "class" attribute to apply to the component.
+   */
+  get classNames() {
+    let classes = ['hds-breadcrumb'];
+
+    // add a class based on the @itemsCanWrap argument
+    if (this.itemsCanWrap) {
+      classes.push('hds-breadcrumb--items-can-wrap');
+    }
+
+    return classes.join(' ');
+  }
+}

package/addon/components/hds/breadcrumb/item.hbs

@@ -0,0 +1,26 @@
+<li class="hds-breadcrumb__item" style={{this.itemStyle}} ...attributes>
+  {{#if @current}}
+    <div class="hds-breadcrumb__current">
+      {{#if @icon}}
+        <div class="hds-breadcrumb__icon">
+          <FlightIcon @name={{@icon}} @size="16" @stretched={{true}} />
+        </div>
+      {{/if}}
+      <span class="hds-breadcrumb__text">{{@text}}</span>
+    </div>
+  {{else}}
+    <LinkTo
+      class="hds-breadcrumb__link {{if @hover 'is-hover'}} {{if @active 'is-active'}} {{if @focus 'is-focus'}}"
+      @models={{hds-link-to-models @model @models}}
+      @query={{hds-link-to-query @query}}
+      @route={{@route}}
+    >
+      {{#if @icon}}
+        <div class="hds-breadcrumb__icon">
+          <FlightIcon @name={{@icon}} @size="16" @stretched={{true}} />
+        </div>
+      {{/if}}
+      <span class="hds-breadcrumb__text">{{@text}}</span>
+    </LinkTo>
+  {{/if}}
+</li>

package/addon/components/hds/breadcrumb/item.js

@@ -0,0 +1,50 @@
+import Component from '@glimmer/component';
+import { htmlSafe } from '@ember/template';
+import { assert } from '@ember/debug';
+
+export default class HdsBreadcrumbItemComponent extends Component {
+  /**
+   * @param maxWidth
+   * @type {string}
+   * @default undefined
+   * @description A parameter that can be applied to an "item" to limit its max-width
+   */
+  get maxWidth() {
+    let { maxWidth } = this.args;
+
+    if (maxWidth) {
+      assert(
+        `@maxWidth for "Hds::Breadcrumb::Item" must be a size as number in 'px' or in 'em' (eg. '200px' or '24em'), received: ${maxWidth}`,
+        maxWidth.match(/^\d+(px|em)$/)
+      );
+
+      return maxWidth;
+    } else {
+      return undefined;
+    }
+  }
+
+  /**
+   * Get the inline style to apply to the item.
+   * @method BreadcrumbItem#itemStyle
+   * @return {string} The "style" attribute to apply to the item.
+   */
+  get itemStyle() {
+    if (this.maxWidth) {
+      return htmlSafe(`max-width: ${this.maxWidth}`);
+    } else {
+      return undefined;
+    }
+  }
+
+  /**
+   * Get the class names to apply to the component.
+   * @method BreadcrumbItem#classNames
+   * @return {string} The "class" attribute to apply to the component.
+   */
+  get classNames() {
+    let classes = ['hds-breadcrumb__item'];
+
+    return classes.join(' ');
+  }
+}

package/addon/components/hds/breadcrumb/truncation.hbs

@@ -0,0 +1,23 @@
+<li class="hds-breadcrumb__item hds-breadcrumb__item--is-truncation" ...attributes>
+  <Hds::Disclosure>
+    <:toggle as |t|>
+      <button
+        type="button"
+        class="hds-breadcrumb__truncation-toggle
+          {{if @hover 'is-hover'}}
+          {{if @active 'is-active'}}
+          {{if @focus 'is-focus'}}"
+        {{on "click" t.onClickToggle}}
+      >
+        <FlightIcon @name="more-horizontal" @size="16" @isInlineBlock={{false}} />
+      </button>
+    </:toggle>
+    <:content>
+      <div class="hds-breadcrumb__truncation-content">
+        <ol class="hds-breadcrumb__sublist">
+          {{yield}}
+        </ol>
+      </div>
+    </:content>
+  </Hds::Disclosure>
+</li>

package/addon/components/hds/button/index.js

@@ -6,7 +6,7 @@ export const DEFAULT_COLOR = 'primary';
 export const DEFAULT_TYPE = 'button';
 export const DEFAULT_ICONPOSITION = 'leading';
 export const SIZES = ['small', 'medium', 'large'];
-export const COLORS = ['primary', 'secondary', 'critical'];
+export const COLORS = ['primary', 'secondary', 'tertiary', 'critical'];
 export const TYPES = ['button', 'submit', 'reset'];
 export const ICONPOSITIONS = ['leading', 'trailing'];
 
@@ -72,6 +72,11 @@ export default class HdsButtonIndexComponent extends Component {
    * @description The name of the icon to be used.
    */
   get icon() {
+    assert(
+      `when the "Hds::Button" @color is "tertiary" an @icon is required`,
+      !(this.color === 'tertiary' && !this.args.icon)
+    );
+
     return this.args.icon ?? null;
   }
 
@@ -162,7 +167,7 @@ export default class HdsButtonIndexComponent extends Component {
 
   /**
    * Get the class names to apply to the component.
-   * @method Badge#classNames
+   * @method Button#classNames
    * @return {string} The "class" attribute to apply to the component.
    */
   // "hds-button {{this.sizeClass}} {{this.colorClass}} {{this.widthClass}}"
@@ -180,9 +185,6 @@ export default class HdsButtonIndexComponent extends Component {
       classes.push('hds-button--width-full');
     }
 
-    // the button has a "low" elevation effect applied to it
-    classes.push('hds-elevation-low');
-
     return classes.join(' ');
   }
 }

package/app/components/hds/breadcrumb/index.js

@@ -0,0 +1 @@
+export { default } from '@hashicorp/design-system-components/components/hds/breadcrumb/index';

package/app/components/hds/breadcrumb/item.js

@@ -0,0 +1 @@
+export { default } from '@hashicorp/design-system-components/components/hds/breadcrumb/item';

package/app/components/hds/breadcrumb/truncation.js

@@ -0,0 +1 @@
+export { default } from '@hashicorp/design-system-components/components/hds/breadcrumb/truncation';

package/app/styles/@hashicorp/design-system-components.scss

@@ -5,6 +5,7 @@
 
 @use "../components/badge";
 @use "../components/badge-count";
+@use "../components/breadcrumb";
 @use "../components/button";
 @use "../components/card";
 @use "../components/disclosure";

package/app/styles/components/breadcrumb.scss

@@ -0,0 +1,189 @@
+//
+// BREADCRUMB
+//
+// properties within each class are sorted alphabetically
+//
+//
+
+@use "../mixins/focus-ring" as *;
+
+$hds-breadcrumb-item-height: 28px;
+$hds-breadcrumb-item-border-radius: 5px;
+$hds-breadcrumb-item-visual-horizontal-padding: 4px;
+
+// MAIN CONTAINER (NAV)
+.hds-breadcrumb {
+    position: relative;
+}
+
+// LIST (OL)
+
+.hds-breadcrumb__list {
+    display: flex;
+    list-style: none;
+    margin: 0;
+    padding: 0;
+
+    .hds-breadcrumb--items-can-wrap & {
+        flex-wrap: wrap;
+    }
+}
+
+.hds-breadcrumb__sublist {
+    list-style: none;
+    margin: 0;
+    padding: 0;
+}
+
+// ITEM (LI)
+
+.hds-breadcrumb__item {
+    align-items: center;
+    display: flex;
+    flex-direction: row;
+    min-width: 0;
+    position: relative;
+
+    .hds-breadcrumb__list > & {
+        &:not(:last-child)::after {
+            color: var(--token-color-palette-neutral-300);
+            content: "/";
+            padding: 0 8px;
+        }
+    }
+
+    .hds-breadcrumb__sublist > & + & {
+        margin-top: 4px;
+    }
+}
+
+.hds-breadcrumb__item--is-truncation {
+    flex: none; // needed to avoid that the "flex" parent collapses the truncation element (it happens with very long strings and no-wrapping)
+}
+
+// LINK (A)
+
+.hds-breadcrumb__link {
+    align-items: center;
+    border-radius: $hds-breadcrumb-item-border-radius;
+    color: var(--token-color-foreground-faint);
+    display: flex;
+    flex-direction: row;
+    margin: 0 (-$hds-breadcrumb-item-visual-horizontal-padding); // we use a negative horizontal margin to counter-balance the horizonal padding (used to shift the focus from the content)
+    min-width: 0;
+    padding: 0 $hds-breadcrumb-item-visual-horizontal-padding;
+    // notice: the text decoration is applied directly to the "text" container because of a bug in Safari (see https://github.com/hashicorp/design-system-components/issues/159)
+    text-decoration-color: transparent;
+
+    // we apply the focus directly to the element, without using a pseudo-element
+    @include hds-focus-ring-basic();
+
+    &:hover,
+    &.is-hover {
+        color: var(--token-color-palette-neutral-600);
+
+        > .hds-breadcrumb__text {
+            text-decoration-color: currentColor;
+        }
+    }
+
+    &:active,
+    &.is-active {
+        color: var(--token-color-foreground-secondary);
+
+        > .hds-breadcrumb__text {
+            text-decoration-color: currentColor;
+        }
+    }
+}
+
+// CURRENT
+
+.hds-breadcrumb__current {
+    align-items: center;
+    color: var(--token-color-foreground-strong);
+    display: flex;
+    flex-direction: row;
+    margin: 0 (-$hds-breadcrumb-item-visual-horizontal-padding); // we use a negative horizontal margin to counter-balance the horizonal padding (used to shift the focus from the content)
+    min-width: 0;
+    padding: 0 $hds-breadcrumb-item-visual-horizontal-padding;
+}
+
+// SUB-ELEMENTS
+
+.hds-breadcrumb__icon {
+    flex: none;
+    margin-right: 6px;
+    height: 13px;
+    width: 13px;
+}
+
+.hds-breadcrumb__text {
+    font-family: var(--token-typography-font-stack-text);
+    font-size: 0.8125rem; // 13px
+    line-height: 1rem; // 16px
+    overflow: hidden;
+    // we use the extra vertical padding to force the height of the parent item to be exactly $hds-breadcrumb-item-height
+    padding: calc((#{$hds-breadcrumb-item-height} - 1rem) / 2) 0;
+    text-decoration: underline;
+    text-decoration-color: transparent;
+    text-overflow: ellipsis;
+    white-space: nowrap;
+
+    .hds-breadcrumb__sublist & {
+        white-space: normal;
+    }
+}
+
+// TRUNCATION
+
+.hds-breadcrumb__truncation-toggle {
+    align-items: center;
+    background-color: transparent;
+    border: 1px solid transparent; // We need this to be transparent for a11y
+    border-radius: $hds-breadcrumb-item-border-radius;
+    color: var(--token-color-foreground-faint);
+    cursor: pointer;
+    display: flex;
+    flex: none;
+    height: $hds-breadcrumb-item-height;
+    justify-content: center;
+    margin: 0 (-$hds-breadcrumb-item-visual-horizontal-padding); // the horizontal negative margin applied here is for visual balance of the spacing between items
+    outline: none; // TODO check with @melanie
+    padding: 0;
+    width: $hds-breadcrumb-item-height;
+
+    // we apply the focus directly to the element, without using a pseudo-element
+    @include hds-focus-ring-basic();
+
+    &:hover,
+    &.is-hover {
+        border-color: var(--token-color-border-strong);
+        color: var(--token-color-foreground-faint);
+    }
+    &:active,
+    &.is-active {
+        background-color: var(--token-color-surface-interactive-active);
+        border-color: var(--token-color-border-strong);
+        color: var(--token-color-foreground-primary);
+    }
+    &:focus,
+    &.is-focus {
+        background-color: transparent;
+        border: none; // important: we need to completely remove the border, of the inner box-shadow of the focus ring will be drawn inside the border
+    }
+}
+
+.hds-breadcrumb__truncation-content {
+    background-color: var(--token-color-surface-primary);
+    border-radius: 6px;
+    box-shadow: var(--token-surface-high-box-shadow);
+    left: -$hds-breadcrumb-item-visual-horizontal-padding;
+    margin-top: 4px;
+    max-width: 200px; // by design
+    padding: 6px 12px;
+    position: absolute;
+    top: 100%;
+    width: max-content;
+    z-index: 300; // this is the z-index used in Structure for this kind of things, I am reusing the same value
+}

package/app/styles/components/button.scss

@@ -59,6 +59,8 @@ $hds-button-focus-border-width: 3px;
 
   &:focus,
   &.is-focus {
+    box-shadow: none;
+
     &::before {
       // the position absolute of an element is computed from the inside of the border of the container
       // so we have to take in account the border width of the pseudo-element container itself
@@ -141,6 +143,7 @@ $size-props: (
 .hds-button--color-primary {
   background-color: var(--token-color-palette-blue-200);
   border-color: var(--token-color-palette-blue-300);
+  box-shadow: var(--token-elevation-low-box-shadow);
   color: var(--token-color-foreground-high-contrast);
 
   &:focus,
@@ -183,6 +186,7 @@ $size-props: (
 .hds-button--color-secondary {
   background-color: var(--token-color-surface-faint);
   border-color: var(--token-color-border-strong);
+  box-shadow: var(--token-elevation-low-box-shadow);
   color: var(--token-color-foreground-primary);
 
   &:focus,
@@ -213,9 +217,59 @@ $size-props: (
   }
 }
 
+.hds-button--color-tertiary {
+  background-color: transparent;
+  border-color: transparent;
+  color: var(--token-color-foreground-action);
+
+  &:focus,
+  &.is-focus {
+    border-color: var(--token-color-focus-action-internal);
+    color: var(--token-color-foreground-action);
+    &::before {
+      border-color: var(--token-color-focus-action-external);
+    }
+  }
+  &:hover,
+  &.is-hover {
+    background-color: var(--token-color-surface-primary);
+    border-color: var(--token-color-border-strong);
+    color: var(--token-color-foreground-action-hover);
+    cursor: pointer;
+  }
+  &:active,
+  &.is-active {
+    background-color: var(--token-color-surface-interactive-active);
+    border-color: var(--token-color-border-strong);
+    box-shadow: none;
+    color: var(--token-color-foreground-action-active);
+    &::before {
+      border-color: transparent;
+    }
+  }
+
+  &:disabled,
+  &[disabled],
+  &.is-disabled,
+  &:disabled:focus,
+  &[disabled]:focus,
+  &.is-disabled:focus,
+  &:disabled:hover,
+  &[disabled]:hover,
+  &.is-disabled:hover {
+    background-color: transparent;
+    border-color: transparent;
+
+    &::before {
+      border-color: transparent;
+    }
+  }
+}
+
 .hds-button--color-critical {
   background-color: var(--token-color-surface-critical);
   border-color: var(--token-color-foreground-critical-on-surface);
+  box-shadow: var(--token-elevation-low-box-shadow);
   color: var(--token-color-foreground-critical-on-surface);
 
   &:focus,

package/app/styles/components/link/standalone.scss

@@ -102,7 +102,7 @@ $size-props: (
     }
 
     &::before {
-      background-color: var(--token-color-action-background-faint);
+      background-color: var(--token-color-surface-action);
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hashicorp/design-system-components",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "HashiCorp Design System Components",
   "keywords": [
     "hashicorp",
@@ -8,35 +8,13 @@
     "components",
     "ember-addon"
   ],
-  "repository": "https://github.com/hashicorp/design-system-components",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/hashicorp/design-system.git",
+    "directory": "packages/components"
+  },
   "license": "MPL-2.0",
   "author": "HashiCorp Design Systems <design-systems@hashicorp.com>",
-  "contributors": [
-    {
-      "name": "Melanie Sumner",
-      "email": "melanie@hashicorp.com"
-    },
-    {
-      "name": "Brian Runnells",
-      "email": "brunnells@hashicorp.com"
-    },
-    {
-      "name": "Hector Simpson",
-      "email": "hector@hashicorp.com"
-    },
-    {
-      "name": "Heather Larsen",
-      "email": "hlarsen@hashicorp.com"
-    },
-    {
-      "name": "Amy Lam",
-      "email": "alam@hashicorp.com"
-    },
-    {
-      "name": "Cristiano Rastelli",
-      "email": "cristiano.rastelli@hashicorp.com"
-    }
-  ],
   "directories": {
     "doc": "doc",
     "test": "tests"
@@ -53,15 +31,10 @@
     "test": "npm-run-all lint test:*",
     "test:ember": "ember test",
     "test:ember-compatibility": "ember try:each",
-    "test:ember:percy": "percy exec ember test",
-    "bump": "./node_modules/.bin/bump package.json",
-    "release": "yarn publish --new-version $npm_package_version",
-    "postrelease:git-tag": "TAG_VERSION=\"${npm_package_name}/${npm_package_version}\" && git tag $TAG_VERSION && git push origin $TAG_VERSION",
-    "postrelease": "yarn postrelease:git-tag",
-    "prepare": "husky install"
+    "test:ember:percy": "percy exec ember test"
   },
   "dependencies": {
-    "@hashicorp/design-system-tokens": "^0.5.0",
+    "@hashicorp/design-system-tokens": "^0.6.0",
     "@hashicorp/ember-flight-icons": "^2.0.1",
     "ember-auto-import": "^2.2.3",
     "ember-cli-babel": "^7.26.6",
@@ -111,8 +84,6 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^3.4.1",
     "eslint-plugin-qunit": "^6.2.0",
-    "husky": "^7.0.4",
-    "lint-staged": "^12.1.2",
     "loader.js": "^4.7.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.3.2",
@@ -129,9 +100,5 @@
   },
   "ember-addon": {
     "configPath": "tests/dummy/config"
-  },
-  "lint-staged": {
-    "*.js": "eslint --cache --fix",
-    "*.{js,hbs}": "prettier --write"
   }
 }

package/.github/ISSUE_TEMPLATE/new-component-quest-issue-engineering-checklist.md

@@ -1,78 +0,0 @@
----
-name: New Component Quest Issue/Engineering Checklist
-about: 'DS Team: Engineering Checklist for New Components'
-title: "[Quest] New Component: Component Name"
-labels: ''
-assignees: ''
-
----
-
-This is the quest issue/engineering checklist for the COMPONENT_NAME Component. All new components will have their own feature branch, and any PR that adds an item from the checklist should target the feature branch, and not `main`. 
-
-## Pre-Flight Checklist
-Update this list and these links as appropriate.
-
-- [Component Doc](url_here): This file should exist before any code is written.
-- [FIGMA Design](url_here): Since we are trying to align the component API naming with the same terms used in the Figma file, it is likely useful to have a fairly stable Figma design before we create a component; it should definitely be finalized before the component ships, however. 
-- [Design System Website](https://design-system-website.vercel.app/?path=/story/example-introduction--page) (storybook of storybooks): use for reference, to consider existing features that we might need to replicate in the component.
-
-## Engineering Checklist 
-The engineering checklist has six parts: creating the feature branch, component template, component backing class, component style, tests, and documentation.
-
-### Component Creation
-
-- [ ] create new branch from main for the component.
-- [ ] create new component
-  - `ember generate component hds/COMPONENT_NAME/index --gc` (the component won't need to be invoked with index, it's just to put all the files in the correct place)
-  - if it's a variation on a component, then `hds/COMPONENT_NAME/VARIATION` instead of `index`
-- [ ] **component template**
-  - use semantic HTML
-  - the component should have a css class that is the same as the component (e.g. `hds/button` should have a class name of `hds-button` on the component, and additional CSS classes should start with this same class name.
-  - add `...attributes` unless doing so would be detrimental (e.g., a parent component and child component that both have ...attributes) 
-- [ ] **component class**
-  - use getters (vs template conditionals or constructors, if possible)
-  - write API comments in the JS doc way (copy from an existing DS component)
-  - use the same naming as the Figma file for the components API unless it conflicts with a pre-existing HTML attribute. If that is the case, document the difference in the comment.
-  - ensure that all existing functionality (from a Structure component) is accounted for in some way. If we are not providing existing functionality at all, it should be documented (along with the reason why). If we are providing temporary functionality, explain that it's temporary and why.
-  - check the [design system website](https://design-system-website.vercel.app/?path=/story/example-introduction--page) to see what kind of component functionality is being used across all products
-  - booleans should start with a verb (is/has/etc)
-  - assertion text should match the content style of the other components.
-  - goal is a terse invocation
-- [ ] **component style**
-  - create `component/COMPONENT_NAME.scss` in `app/styles` 
-  - add `@use` to `app/styles/@hashicorp/design-system-components.scss` (see existing code for precise syntax)
-  - use design tokens wherever possible, comment where they are not
-  - sizes should be in relative units
-  - line heights should be unitless
-- [ ] **testing**
-  - [ ] test basic functionality
-  - [ ] test defaults
-  - [ ] try not to repeat tests (i.e., don't have to test all sizes, all colors, etc.)
-  - [ ] test all accessibility attributes
-- [ ] **documentation**
-  - create component page `ember generate route components/COMPONENT_NAME --dummy`
-  - add link to `templates/index.hbs` page
-  - [ ] API docs
-  - [ ] Usage 
-  - [ ] Showcase 
-
-### Component Review
-
-Pre-review request checks:
-
-- [ ] make sure all tests pass (`ember s` then visit /tests; or `ember t -s`)
-- [ ] check for basic a11y on docs page: 
-  - keyboard navigation
-  - logical DOM order
-  - zoom up to 400% 
-  - color contrast
-  - (the axe-core browser plugin can run some basic tests and give immediate feedback) 
-- [ ] check page on browsers
-  - Chrome
-  - Firefox
-  - Safari
-  - Edge (once available) 
-
-When ready for review: 
-- [ ] add situationally appropriate reviewers
-- [ ] added instructions for reviewers in your PR, letting them know what kind of review you need

package/.github/pull_request_template.md.

@@ -1,26 +0,0 @@
-## :pushpin: Summary
-
-<!-- TLDR that includes the purpose of the PR e.g. "If merged, this PR..." -->
-
-## :busts_in_silhouette: How to review this PR
-
-<!-- Check one box -->
-
-- [ ] Review commit-by-commit (please copy commit info to "Summary" for clarity)
-- [ ] Review by "Files changed"
-
-## :camera_flash: Screenshots
-
-<!-- A picture is a thousand words -->
-
-## :link: External links
-
-<!-- Asana issues, RFCs, etc. -->
-
-## :memo: Is it documented? 
-
-- [ ] Please confirm that this change is documented on the website!
-
-***
-
-:speech_balloon: Please consider using [conventional comments](https://conventionalcomments.org/) when reviewing this PR.

package/.github/workflows/ci.yml

@@ -1,196 +0,0 @@
-name: CI 
-
-on:
-  push:
-    branches:
-      - main
-  pull_request:
-
-env:
-  NODE_VERSION: '16.x'
-
-jobs:
-  lint:
-    name: Lint
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-
-    - uses: actions/setup-node@v2-beta
-      with:
-        node-version: '${{ env.NODE_VERSION }}'
-
-    - name: Get package manager's global cache path
-      id: global-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - name: Cache package manager's global cache and node_modules
-      id: cache-dependencies
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{ steps.global-cache-dir-path.outputs.dir }}
-          node_modules
-        key: ${{ runner.os }}-${{ matrix.node-version }}-${{
-          hashFiles('**/yarn.lock'
-          ) }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.node-version }}-
-
-    - name: Install Dependencies
-      run: yarn install --frozen-lockfile
-      if: |
-        steps.cache-dependencies.outputs.cache-hit != 'true'
-
-    - name: Lint
-      run: yarn lint
-
-
-  test:
-    name: Tests
-    runs-on: ${{ matrix.os }}
-    needs: lint
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        browser: [chrome]
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-
-    - uses: actions/setup-node@v2-beta
-      with:
-        node-version: '${{ env.NODE_VERSION }}'
-
-    - name: Get package manager's global cache path
-      id: global-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - name: Cache package manager's global cache and node_modules
-      id: cache-dependencies
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{ steps.global-cache-dir-path.outputs.dir }}
-          node_modules
-        key: ${{ runner.os }}-${{ matrix.node-version }}-${{
-          hashFiles('**/yarn.lock'
-          ) }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.node-version }}-
-
-    - name: Install Dependencies
-      run: yarn install --frozen-lockfile
-      if: |
-        steps.cache-dependencies.outputs.cache-hit != 'true'
-
-    - name: Test
-      run: yarn test:ember:percy --launch ${{ matrix.browser }}
-      env:
-        PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
-
-  floating-dependencies:
-    name: Floating Dependencies
-    runs-on: ${{ matrix.os }}
-    needs: lint
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        browser: [chrome]
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-
-    - uses: actions/setup-node@v2-beta
-      with:
-        node-version: '${{ env.NODE_VERSION }}'
-
-    - name: Get package manager's global cache path
-      id: global-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - name: Cache package manager's global cache and node_modules
-      id: cache-dependencies
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{ steps.global-cache-dir-path.outputs.dir }}
-          node_modules
-        key: ${{ runner.os }}-${{ matrix.node-version }}-${{
-          hashFiles('**/yarn.lock'
-          ) }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.node-version }}-
-
-    - name: Install Dependencies
-      run: yarn install --no-lockfile --non-interactive
-
-    - name: Test
-      run: yarn test:ember:percy --launch ${{ matrix.browser }}
-      env:
-        PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}
-
-  try-scenarios:
-    name: Tests - ${{ matrix.ember-try-scenario }}
-    runs-on: ubuntu-latest
-    continue-on-error: true
-    needs: test
-
-    strategy:
-      fail-fast: true
-      matrix:
-        ember-try-scenario: [
-          ember-lts-3.20,
-          ember-lts-3.24,
-          ember-release,
-          ember-beta,
-          # ember-canary,
-          ember-default-with-jquery,
-          ember-classic,
-          # embroider-safe,
-          # embroider-optimized
-        ]
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 1
-
-    - uses: actions/setup-node@v2-beta
-      with:
-        node-version: '${{ env.NODE_VERSION }}'
-
-    - name: Get package manager's global cache path
-      id: global-cache-dir-path
-      run: echo "::set-output name=dir::$(yarn cache dir)"
-
-    - name: Cache package manager's global cache and node_modules
-      id: cache-dependencies
-      uses: actions/cache@v2
-      with:
-        path: |
-          ${{ steps.global-cache-dir-path.outputs.dir }}
-          node_modules
-        key: ${{ runner.os }}-${{ matrix.node-version }}-${{
-          hashFiles('**/yarn.lock'
-          ) }}
-        restore-keys: |
-          ${{ runner.os }}-${{ matrix.node-version }}-
-
-    - name: Install Dependencies
-      run: yarn install --frozen-lockfile
-      if: |
-        steps.cache-dependencies.outputs.cache-hit != 'true'
-
-    - name: Test
-      env:
-        EMBER_TRY_SCENARIO: ${{ matrix.ember-try-scenario }}
-      run: node_modules/.bin/ember try:one $EMBER_TRY_SCENARIO

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-staged