@aurodesignsystem-dev/auro-formkit 0.0.0-pr1422.0 → 0.0.0-pr1422.2

package/components/counter/demo/keyboardBehavior.md

@@ -0,0 +1,127 @@
+<auro-header level="1" id="overview">Counter & Counter Group - Keyboard Behavior</auro-header>
+<div class="contentWrapper">
+  <div class="mainContent">
+  <div class="scrollWrapper">
+    <auro-header level="2" id="tabBehavior">Tab Behavior</auro-header>
+    <auro-header level="3" id="tabBehaviorCounter">Counter</auro-header>
+    <p>The counter component is itself a focusable element. There are no sub-parts that are separately focusable.</p>
+    <auro-header level="3" id="tabBehaviorCounterGroup">Counter Group</auro-header>
+    <p>When multiple counters are placed inside a counter group the component behaves as an auro-dropdown. The trigger element renders a counter group label and a summary of all counter labels and current values. The dropdown bib renders all counters inside of the group.</p>
+    <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../dropdown/docs/partials/tabindex.md) -->
+    <!-- The below content is automatically added from ./../../dropdown/docs/partials/tabindex.md -->
+    <p>The trigger is a focusable element and participates in the standard tab order, responding to <code>Tab</code> and <code>Shift+Tab</code> key events per <auro-hyperlink href="https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Global_attributes/tabindex">native browser behavior, i.e., these keys step through the browser tabindex sequence.</auro-hyperlink></p>
+    <p>When the component is <code>disabled</code> it is removed from the <code>tabindex</code> sequence. VoiceOver's virtual cursor <em>(swipe navigation)</em> can still encounter the component, but standard keyboard <code>Tab</code> navigation skips it.</p>
+    <p>When the bib is collapsed, the bib content is excluded from the tab sequence. When <strong>expanded</strong>, focusable elements within the bib content are included in the natural tab order. In fullscreen mode, focus is trapped within the bib, and the tab sequence cycles through the bib content focusable elements until the bib is closed or the viewport no longer meets the fullscreen condition and is rendered as a popover.</p>
+    <!-- AURO-GENERATED-CONTENT:END -->
+    <auro-header level="2" id="keyEvents">Key Events</auro-header>
+    <auro-header level="3" id="keyEventsCounter">Counter</auro-header>
+    <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/keyEvents-counter.md) -->
+    <!-- The below content is automatically added from ./../docs/partials/keyEvents-counter.md -->
+    <table>
+      <thead>
+        <tr>
+          <th>Key</th>
+          <th>Modifier</th>
+          <th>Current State</th>
+          <th>Focus Element</th>
+          <th>Behavior</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td>ArrowDown</td>
+          <td>-</td>
+          <td>*</td>
+          <td>
+            Trigger element.
+          </td>
+          <td>Decrements the counter value by 1.</td>
+        </tr>
+        <tr>
+          <td>ArrowUp</td>
+          <td>-</td>
+          <td>*</td>
+          <td>
+            Trigger element.
+          </td>
+          <td>Increments the counter value by 1.</td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- AURO-GENERATED-CONTENT:END -->
+    <div class="note">
+      <p><strong>Note:</strong> The following keyboard behavior is unsupported at this time:</p>
+      <ul>
+        <li><strong>Home:</strong> sets the counter value to the defined minimum (default 0)</li>
+        <li><strong>End:</strong> sets the counter value to the defined maximum (default 9)</li>
+        <li><strong>PageUp:</strong> (optional) Increases the value by a larger step than Up Arrow.</li>
+        <li><strong>PageDown:</strong> (optional) Decreases the value by a larger step than Down Arrow.</li>
+      </ul>
+    </div>
+    <auro-header level="3" id="keyEventsCounterGroup">Counter Group</auro-header>
+    <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../docs/partials/keyEvents-counterGroup.md) -->
+    <!-- The below content is automatically added from ./../docs/partials/keyEvents-counterGroup.md -->
+    <p>The counter group itself does not have any key event handlers other than those inherited from the dropdown component. However, when the counter group is <strong>expanded</strong> or <strong>opened</strong> the first counter in the bib receives <strong>focus</strong>. When the counter group is <strong>collapsed</strong> or <strong>closed</strong> by any method other than the <code>Tab</code> key (e.g., the <strong>Escape</strong> key), <strong>focus</strong> moves to the trigger element.</p>
+    <!-- AURO-GENERATED-CONTENT:END -->
+    <auro-header level="4" id="keyEventsDropdown">Key Events inherited from Auro-Dropdown</auro-header>
+    <!-- AURO-GENERATED-CONTENT:START (FILE:src=./../../dropdown/docs/partials/keyEvents.md) -->
+    <!-- The below content is automatically added from ./../../dropdown/docs/partials/keyEvents.md -->
+    <table>
+      <thead>
+        <tr>
+          <th>Key</th>
+          <th>Modifier</th>
+          <th>Current State</th>
+          <th>Focus Element</th>
+          <th>Behavior</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td rowspan="2">Enter</td>
+          <td>-</td>
+          <td>Collapsed</td>
+          <td>
+            Trigger or any <strong>focusable</strong> element within the trigger.
+          </td>
+          <td>Opens the bib.</td>
+        </tr>
+        <tr>
+          <td>-</td>
+          <td>Expanded</td>
+          <td>
+            Trigger or any <strong>focusable</strong> element within the trigger.
+          </td>
+          <td>Closes the bib.</td>
+        </tr>
+        <tr>
+          <td>Escape</td>
+          <td>-</td>
+          <td>Expanded</td>
+          <td>
+            Component <code>:host</code> or any <strong>focusable</strong> element within the component.
+          </td>
+          <td>Closes the bib.</td>
+        </tr>
+        <tr>
+          <td rowspan="2">Space</td>
+          <td>-</td>
+          <td>Collapsed</td>
+          <td>
+            Trigger or any <strong>focusable</strong> element within the trigger.
+          </td>
+          <td>Opens the bib.</td>
+        </tr>
+        <tr>
+          <td>-</td>
+          <td>Expanded</td>
+          <td>
+            Trigger or any <strong>focusable</strong> element within the trigger.
+          </td>
+          <td>Closes the bib.</td>
+        </tr>
+      </tbody>
+    </table>
+    <!-- AURO-GENERATED-CONTENT:END -->
+  </div>
+</div>

package/components/counter/demo/readme.md

@@ -0,0 +1,161 @@
+<!--
+The README.md file is a compiled document. No edits should be made directly to this file.
+
+README.md is created by running `npm run build:docs`.
+
+This file is generated based on a template fetched from
+`../../docs/templates/componentReadmeTemplate.md`
+and copied to `./componentDocs/README.md` each time the docs are compiled.
+
+The following sections are editable by making changes to the following files:
+
+| SECTION                | DESCRIPTION                                       | FILE LOCATION                       |
+|------------------------|---------------------------------------------------|-------------------------------------|
+| Description            | Description of the component                      | `./docs/partials/description.md`    |
+| Use Cases              | Examples for when to use this component           | `./docs/partials/useCases.md`       |
+| Additional Information | For use to add any component specific information | `./docs/partials/readmeAddlInfo.md` |
+| Component Example Code | HTML sample code of the components use            | `./apiExamples/basic.html`          |
+-->
+
+# Counter
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
+<!-- The below content is automatically added from ./docs/partials/description.md -->
+The `auro-counter` component is a ui element that enables a way to increment or decrement a single digit value. Common use case is inside the `auro-counter-group` to facilitate a collection of counters to add passenger types to a flight.
+<!-- 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 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 -->
+
+## Counter Use Cases
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
+<!-- The below content is automatically added from ./docs/partials/useCases.md -->
+The `auro-counter` element should be used in situations where users may:
+
+* Need to input a numeric value within a defined range
+* Need a user-friendly interface for quantity selection
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Getting Started
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/componentInstall.md) -->
+<!-- The below content is automatically added from ../../docs/templates/componentInstall.md -->
+
+#### NPM Installation
+
+```shell
+$ npm i @aurodesignsystem/auro-formkit
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
+<!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
+
+### TypeScript Module Resolution
+
+When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
+
+```json
+{
+    "compilerOptions": {
+        "moduleResolution": "bundler"
+    }
+}
+```
+
+This configuration enables proper module resolution for the component's TypeScript files.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Install from CDN
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/bundleInstallDescription.md) -->
+<!-- The below content is automatically added from ../../docs/templates/bundleInstallDescription.md -->
+In cases where the project is not able to process JS assets, there are pre-processed assets available for use. Legacy browsers such as IE11 are no longer supported.
+
+```html
+<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-counter/+esm"></script>
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Formkit Development
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
+<!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
+
+### Filtering
+
+Running the `dev` command will open a `localhost` development server for all components in the monorepo at once.
+
+To only develop a single component, use the `--filter` flag:
+
+```shell
+npx turbo dev --filter=@aurodesignsystem/auro-input
+```
+<!-- AURO-GENERATED-CONTENT:END -->
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/customRegistration.md) -->
+<!-- The below content is automatically added from ./docs/partials/customRegistration.md -->
+
+## Custom Component Registration for Version Management
+
+There are two key parts to every Auro component: the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes">class</a> and the custom element definition. The class defines the component’s behavior, while the custom element registers it under a specific name so it can be used in HTML.
+
+When you install the component as described on the `Install` page, the class is imported automatically, and the component is registered globally for you.
+
+However, if you need to load multiple versions of the same component on a single page (for example, when two projects depend on different versions), you can manually register the class under a custom element name to avoid conflicts.
+
+You can do this by importing only the component class and using the `register(name)` method with a unique name:
+
+```js
+// Import the class only
+import { AuroCounter, AuroCounterGroup } from '@aurodesignsystem/auro-formkit/auro-counter/class';
+
+// Register with a custom name if desired
+AuroCounter.register('custom-counter');
+AuroCounterGroup.register('custom-counter-group');
+```
+
+This will create a new custom element `<custom-counter>` and `<custom-counter-group>` that behaves exactly like `<auro-counter>` and `<auro-counter-group>`, allowing both to coexist on the same page without interfering with each other.
+
+<div class="exampleWrapper exampleWrapper--flex">
+  <custom-counter-group>
+    <div slot="bib.fullscreen.headline">Passengers</div>
+    <div slot="label">Passengers</div>
+    <custom-counter>
+      Adults
+      <span slot="description">18 years or older</span>
+    </custom-counter>
+    <custom-counter>
+      Children
+      <span slot="description">2-17 years</span>
+    </custom-counter>
+  </custom-counter-group>
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+
+```html
+  <custom-counter-group>
+    <div slot="bib.fullscreen.headline">Passengers</div>
+    <div slot="label">Passengers</div>
+    <custom-counter>
+      Adults
+      <span slot="description">18 years or older</span>
+    </custom-counter>
+    <custom-counter>
+      Children
+      <span slot="description">2-17 years</span>
+    </custom-counter>
+  </custom-counter-group>
+
+```html
+  <custom-checkbox-group>
+    <span slot="legend">Form label goes here</span>
+    <custom-checkbox value="value1" name="custom" id="checkbox-custom1">Custom checkbox option</custom-checkbox>
+    <custom-checkbox value="value2" name="custom" id="checkbox-custom2" checked>Custom checkbox option</custom-checkbox>
+    <custom-checkbox value="value3" name="custom" id="checkbox-custom3">Custom checkbox option</custom-checkbox>
+    <custom-checkbox value="value4" name="custom" id="checkbox-custom4">Custom checkbox option</custom-checkbox>
+  </custom-checkbox-group>
+```
+</auro-accordion>
+<!-- AURO-GENERATED-CONTENT:END -->

package/components/counter/dist/auro-counter-button.d.ts

@@ -0,0 +1,14 @@
+export class AuroCounterButton {
+    static get styles(): import("lit").CSSResult[];
+    /**
+     * This will register this element with the browser.
+     * @param {string} [name="auro-counter-button"] - The name of element that you want to register to.
+     *
+     * @example
+     * AuroCounterButton.register("custom-counter-button") // this will register this element to <custom-counter-button/>
+     *
+     */
+    static register(name?: string): void;
+    size: string;
+    shape: string;
+}