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

package/CHANGELOG.md

@@ -1,5 +1,5 @@
-# Changelog
+### Changelog
 
-You can view a complete history of changes to this repository on the GitHub releases page:
+You can view a history of changes to this repository on the releases page:
 
 https://github.com/AlaskaAirlines/auro-formkit/releases

package/README.md

@@ -3,25 +3,21 @@ The README.md file is a compiled document. No edits should be made directly to t
 
 README.md is created by running `npm run build:docs:kit`.
 
-This file is generated based on the template at
-`./docs/templates/kitReadmeTemplate.md`
-and compiled to `./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 kit                      | `./docs/partials/description.md`    |
-| Use Cases              | Examples for when to use this kit           | `./docs/partials/useCases.md`       |
-| Additional Information | For use to add any kit specific information | `./docs/partials/readmeAddlInfo.md` |
-| kit Example Code | HTML sample code of the kits use            | `./apiExamples/basic.html`          |
--->
-
-# Formkit
+| 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`          |
+-->
+
+# Auro Formkit
 
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
-<!-- The below content is automatically added from ./docs/partials/description.md -->
-
+<!-- The below content is automatically added from ./docs/partials/description.md -->
+
 ## Description
 
 `auro-formkit` is a collection of web components that can be used to build forms.
@@ -42,73 +38,58 @@ It is a monorepo that contains the following components:
 - `auro-radio`
     - `auro-radio-group`
 - `auro-select`
-<!-- AURO-GENERATED-CONTENT:END -->
-
-## Use Cases
-
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/useCases.md) -->
-<!-- The below content is automatically added from ./docs/partials/useCases.md -->
-
-### 1. User Accounts
-- Sign up and login forms  
-- Email and password validation  
-
-### 2. Checkout & Payments
-- Collect shipping and billing info  
-- Use autofill and validation to reduce errors  
-
-### 3. Booking & Scheduling
-- Select dates and times  
-- Prevent invalid selections (like past dates)  
-
-### 4. Search & Filters
-- Search inputs with suggestions  
-- Filters like price ranges or categories  
-
-### 5. File Uploads
-- Upload images, documents, or media  
-- Restrict file types and allow multiple files  
-
-### 6. Feedback & Surveys
-- Collect ratings, choices, and comments  
-- Require answers where needed  
-
-### 7. Calculators & Dynamic Forms
-- Show real-time results (e.g., pricing, totals)  
-
-### 8. Multi-Step Forms
-- Break long forms into smaller steps  
-
-### 9. Mobile-Friendly Input
-- Use input types that trigger the right keyboard  
-
-### 10. Accessible Forms
-- Proper labels and grouped inputs  
-- Built-in error handling  
-
-### 11. Built-in Validation
-- Use HTML5 rules instead of custom JavaScript
-<!-- AURO-GENERATED-CONTENT:END -->
-
-## Getting Started
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Install
 
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/kitInstall.md) -->
-<!-- The below content is automatically added from ./docs/partials/kitInstall.md -->
+<!-- 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-formkit/testPublish.yml?style=for-the-badge)](https://github.com/AlaskaAirlines/auro-formkit/actions/workflows/testPublish.yml)
 [![See it on NPM!](https://img.shields.io/npm/v/@aurodesignsystem/auro-formkit?style=for-the-badge&color=orange)](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit)
 [![License](https://img.shields.io/npm/l/@aurodesignsystem/auro-formkit?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)
 
-#### NPM Installation
-
 ```shell
 $ npm i @aurodesignsystem/auro-formkit
 ```
-<!-- AURO-GENERATED-CONTENT:END -->
+
+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.
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## Getting Started
+
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/gettingStarted.md) -->
-<!-- The below content is automatically added from ./docs/partials/gettingStarted.md -->
-
-### TypeScript Module Resolution
+<!-- The below content is automatically added from ./docs/partials/gettingStarted.md -->
+To start using the Auro Formkit components, follow the instructions below:
+
+### Usage
+
+You can use Auro Formkit components in your project in two ways: automatic or custom registration.
+
+#### Automatic Registration
+
+For automatic registration, simply import the component:
+
+```javascript
+import "@aurodesignsystem/auro-formkit/auro-checkbox";
+```
+
+This will automatically register both the `<auro-checkbox>` and the included `<auro-checkbox-group>` component for use in your project. Note that not all Auro Formkit components have sub-components. Be sure to check the documentation for each component to understand its specific usage and registration requirements.
+
+#### Custom Registration
+
+If you prefer to register the component with a custom name, you can call the component class directly to create a custom registration:
+
+```javascript
+import { AuroCheckbox, AuroCheckboxGroup } from "@aurodesignsystem/auro-formkit/auro-checkbox/class";
+
+AuroCheckbox.register('custom-checkbox');
+AuroCheckbox.register('custom-checkbox-group');
+```
+
+This will register the component as `<custom-checkbox>` and `<custom-checkbox-group>`.
+
+#### TypeScript Module Resolution
 
 When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
 
@@ -121,47 +102,111 @@ When using TypeScript set `moduleResolution` to `bundler`, add the following to
 ```
 
 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/partials/bundleInstallDescription.md) -->
-<!-- The below content is automatically added from ./docs/partials/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.
+### Basic HTML Example
+
+Here is an example of how to use the Auro Checkbox component in your HTML:
+
+`index.html -> <head>`
+
+```html
+<script type="module">
+    import "@aurodesignsystem/auro-formkit/auro-checkbox";
+</script>
+```
 
-Each component is imported individually by its export path:
+`index.html -> <body>`
 
 ```html
-<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-checkbox/+esm"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-input/+esm"></script>
-<script type="module" src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-formkit@latest/auro-select/+esm"></script>
-```
-<!-- AURO-GENERATED-CONTENT:END -->
-
-## Additional Information
+<auro-checkbox-group>
+    <span slot="legend">
+        Form label goes here
+    </span>
+    <auro-checkbox value="value1" name="basic" id="checkbox-basic1">
+        Checkbox option
+    </auro-checkbox>
+    <auro-checkbox value="value2" name="basic" id="checkbox-basic2" checked>
+        Checkbox option two
+    </auro-checkbox>
+</auro-checkbox-group>
+```
+
+By following these steps, you can easily integrate Auro Formkit components into your project.
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Design Token CSS Custom Property dependency
+
+<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/development/designTokens.md) -->
+The use of any Auro custom element has a dependency on the [Auro Design Tokens](https://auro.alaskaair.com/getting-started/developers/design-tokens).
+
+<!-- AURO-GENERATED-CONTENT:END -->
+
+## 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 -->
+
+### Start development environment
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/localhost.md) -->
+<!-- The below content is automatically added from ./docs/partials/localhost.md -->
+
+## Local Development
+<!-- AURO-GENERATED-CONTENT:END -->
+
+### Testing
+
+<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/testing.md) -->
+<!-- The below content is automatically added from ./docs/partials/testing.md -->
+```
+npm run test
+```
+
+#### Port configuration
 
+Turbo will attempt to test components in parallel which will lead to port conflicts.
+
+Setting the `concurrency` to `1` will prevent Turbo from running tests in parallel:
+
+```
+"test": "turbo run test --concurrency=1",
+```
+
+`turbo.json`does not support `--concurrency` yet. See [this issue](https://github.com/vercel/turborepo/discussions/7493).
+<!-- 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 -->
-
-### Turborepo Overview
-
-This monorepo is managed using [Turborepo](https://turborepo.org/).
-
-### Managing dependencies
-
+<!-- The below content is automatically added from ./docs/partials/readmeAddlInfo.md -->
+
+## Turborepo Overview
+
+This monorepo is managed using [Turborepo](https://turborepo.org/).
+
+### Managing dependencies
+
 #### Best practices for dependency installation
 
 When you install a dependency in a component or package in `auro-formkit`, you should install it directly in the package that uses it. 
 
-The package's `package.json` will have every dependency that it needs. This is true for both external and internal dependencies.
-
-### Types of Dependencies by Source
-
+The package's `package.json` will have every dependency that it needs. This is true for both external and internal dependencies.
+
+### Types of Dependencies by Source
+
 #### External Dependencies
 - These are packages fetched from the `npm` registry (e.g., Lit, Rollup, Sass)
 - Declared in `package.json` using exact versions or version ranges
-- Installed in `node_modules` during `npm install` or `yarn install`
-
+- Installed in `node_modules` during `npm install` or `yarn install`
+
 #### Internal Dependencies
 - These are packages from within the `auro-formkit` monorepo
 - Allow sharing code between different packages in your repository
@@ -169,19 +214,33 @@ The package's `package.json` will have every dependency that it needs. This is t
 - Must be declared in `package.json` just like external dependencies
 - Use workspace protocols (e.g., `"workspace:*"` or `"workspace:^1.0.0"`)
 
-### Types of Dependencies by Purpose
-
+### Types of Dependencies by Purpose
+
 #### Dependencies (`dependencies`)
 - Required for the package to function in production
 - Example:
   ```json
   {
     "dependencies": {
-      "lit": "^3.0.0"
+      "lit.js": "^3.0.0",                    // External dependency
+      "@aurodesignsystem/input": "workspace:*"  // Internal dependency
+    }
+  }
+  ```
+
+#### Peer Dependencies (`peerDependencies`)
+- Packages that your library expects the consuming application to provide
+- Common for plugins or UI component libraries
+- Example:
+  ```json
+  {
+    "peerDependencies": {
+      "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
+      "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
     }
   }
-  ```
-
+  ```
+
 ### Development Dependencies (`devDependencies`)
 - Only needed during development, testing, or building
 - Not included in the production bundle
@@ -189,30 +248,36 @@ The package's `package.json` will have every dependency that it needs. This is t
   ```json
   {
     "devDependencies": {
-      "@aurodesignsystem/auro-dropdown": "*",
-      "@aurodesignsystem/build-tools": "*",
-      "rollup": "^4.24.4"
+      "typescript": "^5.0.0",
+      "@open-wc/testing": "^4.0.0"  // Internal dev dependency
     }
   }
-  ```
-
-### Example: Component Dependencies
+  ```
 
-Let's use `@aurodesignsystem/combobox` as an example to illustrate these concepts:
+## Example: Component Dependencies
+
+Let's use `@auro-formki/combobox` as an example to illustrate these concepts:
 
 ```json
 {
   "name": "@aurodesignsystem/combobox",
   "dependencies": {
-    "lit": "^3.2.1"
+    // Internal dependencies
+    "@aurodesignsystem/auro-dropdown": "*",     // Required UI component
+    "@aurodesignsystem/auro-input": "*",        // Required UI component
+
+    // External dependencies
+    "@alaskaairux/icons": "^5.3.0",  // Required UI component
+    "lit": "^3.2.1"                   // Framework
+  },
+  "peerDependencies": {
+    "@aurodesignsystem/design-tokens": "^4.12.1",
+    "@aurodesignsystem/webcorestylesheets": "^5.1.2"
   },
   "devDependencies": {
-    // Internal component dependencies
-    "@aurodesignsystem/auro-dropdown": "*",
-    "@aurodesignsystem/auro-input": "*",
     // Build utilities
     "rollup": "^4.24.4",
-    "@aurodesignsystem/build-tools": "*"
+    "@aurodesignsystem/build-tools": "*",
   }
 }
 ```
@@ -221,6 +286,7 @@ This structure ensures that:
 1. The package explicitly declares all its dependencies
 2. Internal dependencies are properly tracked and versioned
 3. Development tools are separated from production dependencies
+4. Peer dependencies are clearly communicated to consumers
 
 - External dependencies come from the `npm` registry.
 
@@ -236,8 +302,8 @@ This practice has several benefits:
 
 - **Pruning unused dependencies:** When dependencies are installed in the packages that they are meant for, Turborepo can read your lockfile and remove dependencies that aren't used in the packages you need.
 
-For more information, see the [Turborepo docs](https://turbo.build/repo/docs/crafting-your-repository/managing-dependencies).
-
+For more information, see the [Turborepo docs](https://turbo.build/repo/docs/crafting-your-repository/managing-dependencies).
+
 ### Root `package.json`
 
 The only dependencies that belong in the root `package.json` are **tools for managing the repository**.
@@ -245,20 +311,4 @@ The only dependencies that belong in the root `package.json` are **tools for man
 Some examples of dependencies that make sense to install in the root are `turbo`, `husky`, or `stylelint`.
 
 Conversely, dependencies Auro components rely on should be installed in their respective packages, such as `Lit`, `Rollup`, or other `auro-formkit` dependencies.
-<!-- 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 -->

package/components/checkbox/demo/api.min.js

@@ -1687,7 +1687,7 @@ class AuroHelpText extends i$2 {
   }
 }
 
-var formkitVersion = '202604071818';
+var formkitVersion = '202604072118';
 
 // Copyright (c) 2026 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
 // See LICENSE in the project root for license information.

package/components/checkbox/demo/index.min.js

@@ -1679,7 +1679,7 @@ class AuroHelpText extends i$2 {
   }
 }
 
-var formkitVersion = '202604071818';
+var formkitVersion = '202604072118';
 
 // Copyright (c) 2026 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
 // See LICENSE in the project root for license information.

package/components/checkbox/dist/index.js

@@ -1632,7 +1632,7 @@ class AuroHelpText extends LitElement {
   }
 }
 
-var formkitVersion = '202604071818';
+var formkitVersion = '202604072118';
 
 // Copyright (c) 2026 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
 // See LICENSE in the project root for license information.

package/components/checkbox/dist/registered.js

@@ -1632,7 +1632,7 @@ class AuroHelpText extends LitElement {
   }
 }
 
-var formkitVersion = '202604071818';
+var formkitVersion = '202604072118';
 
 // Copyright (c) 2026 Alaska Airlines. All right reserved. Licensed under the Apache-2.0 license
 // See LICENSE in the project root for license information.