# Formkit ## Description `auro-formkit` is a collection of web components that can be used to build forms. It is a monorepo that contains the following components: - `auro-checkbox` - `auro-checkbox-group` - `auro-combobox` - `auro-counter` - `auro-counter-group` - `auro-datepicker` - `auro-dropdown` - `auro-form` - `auro-input` - `auro-menu` - `auro-menu-option` - `auro-radio` - `auro-radio-group` - `auro-select` ## Use Cases ### 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 ## Getting Started [](https://github.com/AlaskaAirlines/auro-formkit/actions/workflows/testPublish.yml) [](https://www.npmjs.com/package/@aurodesignsystem/auro-formkit) [](https://www.apache.org/licenses/LICENSE-2.0)  #### NPM Installation ```shell $ npm i @aurodesignsystem/auro-formkit ``` ### 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. ## Install from CDN 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. Each component is imported individually by its export path: ```html ``` ## Additional Information ### 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 #### 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` #### Internal Dependencies - These are packages from within the `auro-formkit` monorepo - Allow sharing code between different packages in your repository - Example: The `@aurodesignsystem/combobox` package might depend on `@aurodesignsystem/input` - 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 #### Dependencies (`dependencies`) - Required for the package to function in production - Example: ```json { "dependencies": { "lit": "^3.0.0" } } ``` ### Development Dependencies (`devDependencies`) - Only needed during development, testing, or building - Not included in the production bundle - Example: ```json { "devDependencies": { "@aurodesignsystem/auro-dropdown": "*", "@aurodesignsystem/build-tools": "*", "rollup": "^4.24.4" } } ``` ### Example: Component Dependencies Let's use `@aurodesignsystem/combobox` as an example to illustrate these concepts: ```json { "name": "@aurodesignsystem/combobox", "dependencies": { "lit": "^3.2.1" }, "devDependencies": { // Internal component dependencies "@aurodesignsystem/auro-dropdown": "*", "@aurodesignsystem/auro-input": "*", // Build utilities "rollup": "^4.24.4", "@aurodesignsystem/build-tools": "*" } } ``` 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 - External dependencies come from the `npm` registry. - Internal dependencies let you share functionality within your repository. This practice has several benefits: - **Improved clarity:** It's easier to understand what a package depends on when its dependencies are listed in its `package.json`. Developers working in the repository can see at a glance what dependencies are used within the package. - **Enhanced flexibility:** In a monorepo at scale, it can be unrealistic to expect each package to use the same version of an external dependency. - **Better caching ability:** If you install too many dependencies in the root of your repository, you'll be changing the workspace root whenever you add, update, or delete a dependency, leading to unnecessary cache misses. - **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). ### Root `package.json` The only dependencies that belong in the root `package.json` are **tools for managing the repository**. 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. ## Formkit Development ### 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 ```