feature: adds new form component & monorepo structure

AlaskaAirlines · Oct 28, 2024 · 2b52ee0 · 2b52ee0
1 parent 550c274
commit 2b52ee0
Show file tree

Hide file tree

Showing 169 changed files with 47,201 additions and 666 deletions.
diff --git a/.gitignore b/.gitignore
@@ -10,6 +10,8 @@ demo/*.css.map
 ## CSS built from Sass process
 src/**/*.css
 src/**/*.css.map
+components/**/*.css
+components/**/*.css.map
 
 ## *-css built from sass-render process
 *-css.js

diff --git a/README.md b/README.md
@@ -17,18 +17,18 @@ The following sections are editable by making changes to the following files:
 | Component Example Code | HTML sample code of the components use            | `./apiExamples/basic.html`          |
 -->
 
-# [Name]
+# Form
 
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/description.md) -->
-<!-- The below content is automatically added from ./../docs/partials/description.md -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
+<!-- The below content is automatically added from ./docs/partials/description.md -->
 `<auro-form>` is a [HTML custom element](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements) for the purpose of ...
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam convallis in tellus nec pellentesque. Integer bibendum ligula sit amet vehicula gravida. Maecenas accumsan, ligula vitae molestie iaculis, tellus mi laoreet ex [install instructions](https://auro.alaskaair.com/components/auro/button/install), ac malesuada velit dolor vel mi. Cras et rutrum urna. Sed mattis mi eu tortor ullamcorper, egestas bibendum mauris cursus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus viverra eros eget neque commodo vulputate. In tempus eu velit at dictum.
 
 Nulla at augue facilisis `odio lobortis` molestie vitae a nulla.
 <!-- AURO-GENERATED-CONTENT:END -->
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/readmeAddlInfo.md) -->
-<!-- The below content is automatically added from ./../docs/partials/readmeAddlInfo.md -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/readmeAddlInfo.md) -->
+<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
 <!-- AURO-GENERATED-CONTENT This file is to be used for any additional content that should be included in the README.md which is specific to this component. -->
 <!-- AURO-GENERATED-CONTENT:END -->
 
@@ -41,13 +41,14 @@ For the most up to date information on [UI development browser support](https://
 
 ## Install
 
-<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall.md) -->
-[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/[namespace]-[name]/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/[namespace]-[name]/actions/workflows/testPublish.yml)
-[![See it on NPM!](https://img.shields.io/npm/v/[npm]/[namespace]-[name]?style=for-the-badge&color=orange)](https://www.npmjs.com/package/[npm]/[namespace]-[name])
-[![License](https://img.shields.io/npm/l/[npm]/[namespace]-[name]?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
-
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentInstall_esm.md) -->
+[![Build Status](https://img.shields.io/github/actions/workflow/status/AlaskaAirlines/auro-form/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-form/actions/workflows/testPublish.yml)
+[![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-form?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-form)
+[![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-form?color=blue&style=for-the-badge)](https://www.apache.org/licenses/LICENSE-2.0)
+![ESM supported](https://img.shields.io/badge/ESM-compatible-FFE900?style=for-the-badge)
+
 ```shell
-$ npm i [npm]/[namespace]-[name]
+$ npm i @aurodesignsystem/auro-form
 ```
 
 Installing as a direct, dev or peer dependency is up to the user installing the package. If you are unsure as to what type of dependency you should use, consider reading this [stack overflow](https://stackoverflow.com/questions/18875674/whats-the-difference-between-dependencies-devdependencies-and-peerdependencies) answer.
@@ -64,29 +65,32 @@ The use of any Auro custom element has a dependency on the [Auro Design Tokens](
 ### Define dependency in project component
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImportDescription.md) -->
-Defining the component dependency within each component that is using the `<[namespace]-[name]>` component.
+Defining the component dependency within each component that is using the `<auro-form>` component.
 
 <!-- AURO-GENERATED-CONTENT:END -->
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/componentImport.md) -->
 
 ```js
-import "[npm]/[namespace]-[name]";
+import "@aurodesignsystem/auro-form";
 ```
 
 <!-- AURO-GENERATED-CONTENT:END -->
 **Reference component in HTML**
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
-<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
+<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
 
 ```html
-<auro-form>Hello World</auro-form>
+<auro-form>Hello World</auro-form>
+<auro-input>
+    <span slot="label">Hello World</span>
+</auro-input>
 ```
 <!-- AURO-GENERATED-CONTENT:END -->
 
 ## Install bundled assets from CDN
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleInstallDescription.md) -->
-In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `[namespace]-[name]__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
+In cases where the project is not able to process JS assets, there are pre-processed assets available for use. See -- `auro-form__bundled.js` for modern browsers. Legacy browsers such as IE11 are no longer supported.
 
 **WARNING!** When installing into your application environment, DO NOT use `@latest` for the requested version. Risks include unknown MAJOR version releases and instant adoption of any new features and possible bugs without developer knowledge. The `@latest` wildcard should NEVER be used for production customer-facing applications. You have been warned.
 
@@ -97,17 +101,17 @@ In cases where the project is not able to process JS assets, there are pre-proce
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/usage/bundleUseModBrowsers.md) -->
 
 ```html
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@[dtVersion]/dist/tokens/CSSCustomProperties.css" />
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@[wcssVersion]/dist/bundled/essentials.css" />
-<script src="https://cdn.jsdelivr.net/npm/[npm]/[namespace]-[name]@[Version]/dist/[namespace]-[name]__bundled.js" type="module"></script>
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/design-tokens@4.9.2/dist/tokens/CSSCustomProperties.css" />
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@aurodesignsystem/webcorestylesheets@5.1.2/dist/bundled/essentials.css" />
+<script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-form@0.0.0/dist/auro-form__bundled.js" type="module"></script>
 ```
 
 <!-- AURO-GENERATED-CONTENT:END -->
 
-## [namespace]-[name] use cases
+## auro-form use cases
 
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/useCases.md) -->
-<!-- The below content is automatically added from ./../docs/partials/useCases.md -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
+<!-- The below content is automatically added from ./docs/partials/useCases.md -->
 The `<auro-form>` element should be used in situations where users may:
 
 * ...
@@ -117,13 +121,16 @@ The `<auro-form>` element should be used in situations where users may:
 
 ## API Code Examples
 
-### Default [namespace]-[name]
+### Default auro-form
 
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./../apiExamples/basic.html) -->
-<!-- The below code snippet is automatically added from ./../apiExamples/basic.html -->
+<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
+<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
 
 ```html
-<auro-form>Hello World</auro-form>
+<auro-form>Hello World</auro-form>
+<auro-input>
+    <span slot="label">Hello World</span>
+</auro-input>
 ```
 <!-- AURO-GENERATED-CONTENT:END -->
 
@@ -167,7 +174,7 @@ The custom element API file is generated in the build and committed back to the
 ### Testing
 
 <!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/testing.md) -->
-Automated tests are required for every Auro component. See `.\test\[namespace]-[name].test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
+Automated tests are required for every Auro component. See `.\test\auro-form.test.js` for the tests for this component. Run `npm test` to run the tests and check code coverage. Tests must pass and meet a certain coverage threshold to commit. See [the testing documentation](https://auro.alaskaair.com/support/tests) for more details.
 
 <!-- AURO-GENERATED-CONTENT:END -->
 

diff --git a/components/dropdown/apiExamples/basic.html b/components/dropdown/apiExamples/basic.html
@@ -0,0 +1,6 @@
+<auro-dropdown aria-label="custom label">
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/basicButton.html b/components/dropdown/apiExamples/basicButton.html
@@ -0,0 +1,10 @@
+<auro-dropdown aria-label="custom label">
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-button
+      slot="trigger"
+      fluid>
+      Dropdown
+    </auro-button>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/basicIcon.html b/components/dropdown/apiExamples/basicIcon.html
@@ -0,0 +1,8 @@
+<auro-dropdown aria-label="custom label">
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-icon
+      category="interface"
+      name="arrow-down"></auro-icon>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/basicInput.html b/components/dropdown/apiExamples/basicInput.html
@@ -0,0 +1,10 @@
+<auro-dropdown aria-label="custom label">
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-input
+      borderless
+      slot="trigger"
+      id="inputExampleTrigger">
+    </auro-input>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/bordered.html b/components/dropdown/apiExamples/bordered.html
@@ -0,0 +1,6 @@
+<auro-dropdown aria-label="custom label" bordered>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/chevron.html b/components/dropdown/apiExamples/chevron.html
@@ -0,0 +1,6 @@
+<auro-dropdown aria-label="custom label" chevron>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/chevronButton.html b/components/dropdown/apiExamples/chevronButton.html
@@ -0,0 +1,10 @@
+<auro-dropdown aria-label="custom label" chevron>
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-button
+      slot="trigger"
+      fluid>
+      Dropdown
+    </auro-button>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/chevronIcon.html b/components/dropdown/apiExamples/chevronIcon.html
@@ -0,0 +1,8 @@
+<auro-dropdown aria-label="custom label" chevron>
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-icon
+      category="interface"
+      name="arrow-down"></auro-icon>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/chevronInput.html b/components/dropdown/apiExamples/chevronInput.html
@@ -0,0 +1,9 @@
+<auro-dropdown aria-label="custom label" chevron>
+  Lorem ipsum solar
+  <div slot="trigger">
+    <auro-input
+      slot="trigger"
+      id="inputExampleTrigger">
+    </auro-input>
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/common.html b/components/dropdown/apiExamples/common.html
@@ -0,0 +1,15 @@
+<auro-dropdown id="common" common aria-label="Label content for screen reader">
+  <div style="padding: var(--ds-size-150);">
+    Lorem ipsum solar
+    <br />
+    <auro-button onclick="document.querySelector('#common').hide()">
+      Dismiss Dropdown
+    </auro-button>
+  </div>
+  <span slot="helpText">
+    Help text
+  </span>
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/commonLabelledby.html b/components/dropdown/apiExamples/commonLabelledby.html
@@ -0,0 +1,17 @@
+<p id="foo">The element is labelled by content external to the element.</p>
+
+<auro-dropdown id="commonAdvanced" aria-labelledby="foo" bordered rounded inset chevron>
+  <div style="padding: var(--ds-size-150);">
+    Lorem ipsum solar
+    <br />
+    <auro-button onclick="document.querySelector('#commonAdvanced').hide()">
+      Dismiss Dropdown
+    </auro-button>
+  </div>
+  <span slot="helpText">
+    Help text
+  </span>
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/commonMatchWidth.html b/components/dropdown/apiExamples/commonMatchWidth.html
@@ -0,0 +1,15 @@
+<auro-dropdown id="common" common matchWidth aria-label="Label content for screen reader">
+  <div style="padding: var(--ds-size-150);">
+    Lorem ipsum solar
+    <br />
+    <auro-button onclick="document.querySelector('#common').hide()">
+      Dismiss Dropdown
+    </auro-button>
+  </div>
+  <span slot="helpText">
+    Help text
+  </span>
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/commonSlot.html b/components/dropdown/apiExamples/commonSlot.html
@@ -0,0 +1,18 @@
+<auro-dropdown id="commonSlot" bordered rounded inset chevron>
+  <div style="padding: var(--ds-size-150);">
+    Lorem ipsum solar
+    <br />
+    <auro-button onclick="document.querySelector('#commonSlot').hide()">
+      Dismiss Dropdown
+    </auro-button>
+  </div>
+  <span slot="helpText">
+    Help text
+  </span>
+  <span slot="label">
+    Element label (default text will be read by screen reader)
+  </span>
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/custom.html b/components/dropdown/apiExamples/custom.html
@@ -0,0 +1,15 @@
+<custom-dropdown id="common" common aria-label="Label content for screen reader">
+  <div style="padding: var(--ds-size-150);">
+    Lorem ipsum solar
+    <br />
+    <auro-button onclick="document.querySelector('#common').hide()">
+      Dismiss Dropdown
+    </auro-button>
+  </div>
+  <span slot="helpText">
+    Help text
+  </span>
+  <div slot="trigger">
+    Trigger
+  </div>
+</custom-dropdown>
diff --git a/components/dropdown/apiExamples/customDimensions100.html b/components/dropdown/apiExamples/customDimensions100.html
@@ -0,0 +1,18 @@
+<div style="width: 100px;" aria-label="custom label">
+  <auro-dropdown inset bordered rounded chevron>
+    <div style="width: 100px; max-height: 200px; overflow: scroll;">
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+    </div>
+    <div slot="trigger">
+      Trigger
+    </div>
+  </auro-dropdown>
+</div>
diff --git a/components/dropdown/apiExamples/customDimensions300.html b/components/dropdown/apiExamples/customDimensions300.html
@@ -0,0 +1,18 @@
+<div style="width: 300px;" aria-label="custom label">
+  <auro-dropdown inset bordered rounded chevron>
+    <div style="width: 300px; max-height: 200px; overflow: scroll;">
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+      <p>
+        Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </p>
+    </div>
+    <div slot="trigger">
+      Trigger
+    </div>
+  </auro-dropdown>
+</div>
diff --git a/components/dropdown/apiExamples/disabled.html b/components/dropdown/apiExamples/disabled.html
@@ -0,0 +1,6 @@
+<auro-dropdown aria-label="custom label" disabled>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/disabledAll.html b/components/dropdown/apiExamples/disabledAll.html
@@ -0,0 +1,18 @@
+<auro-dropdown
+  aria-label="custom label"
+  disabled
+  chevron
+  rounded
+  inset
+  bordered>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+  <span slot="helpText">
+    Helper text
+  </span>
+  <span slot="label">
+    Name
+  </span>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/disabledChevron.html b/components/dropdown/apiExamples/disabledChevron.html
@@ -0,0 +1,9 @@
+<auro-dropdown
+  aria-label="custom label"
+  disabled
+  chevron>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>
diff --git a/components/dropdown/apiExamples/error.html b/components/dropdown/apiExamples/error.html
@@ -0,0 +1,6 @@
+<auro-dropdown aria-label="custom label" error>
+  Lorem ipsum solar
+  <div slot="trigger">
+    Trigger
+  </div>
+</auro-dropdown>