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

package/components/menu/demo/readme.md

@@ -1,145 +0,0 @@
-<!--
-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`          |
--->
-
-# Menu
-
-<!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
-<!-- The below content is automatically added from ./docs/partials/description.md -->
-The `<auro-menu>` element provides a list of options for a user to select from.
-
-A list of options is created within the `<slot>` of the `<auro-menu>` element by using the `<auro-menuoption>` element to define options. Use a standard `<hr>` element to create dividers within the list of options.
-
-The `<auro-menu>` element is designed for contextual menus, e.g. a dropdown menus. They are not intended to be used for navigation menus which have a different semantic meaning. The `<auro-menu>` element does not support hide/show functionality within its scope. This functionality will be managed by a wrapping element such as a drop-down menu composite element.
-<!-- 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 -->
-
-## Menu 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-menu>` element should be used in situations where users may:
-
-* A user needs to select one option from a list of options.
-<!-- 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-menu/+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 { AuroMenu, AuroMenuOption } from '@aurodesignsystem/auro-formkit/auro-menu/class';
-
-// Register with a custom name if desired
-AuroMenu.register('custom-menu');
-AuroMenuOption.register('custom-menu-option');
-```
-
-This will create a new custom element `<custom-menu>` and `<custom-menu-option>` that behaves exactly like `<auro-menu>` and `<auro-menu-option>`, allowing both to coexist on the same page without interfering with each other.
-
-<div class="exampleWrapper exampleWrapper--flex">
-  <custom-menu>
-    <custom-menuoption value="stops">Stops</custom-menuoption>
-    <custom-menuoption value="price">Price</custom-menuoption>
-    <custom-menuoption value="duration">Duration</custom-menuoption>
-    <custom-menuoption value="departure">Departure</custom-menuoption>
-    <custom-menuoption value="arrival">Arrival</custom-menuoption>
-  </custom-menu>
-</div>
-<auro-accordion alignRight>
-  <span slot="trigger">See code</span>
-
-```html
-  <custom-menu>
-    <custom-menuoption value="stops">Stops</custom-menuoption>
-    <custom-menuoption value="price">Price</custom-menuoption>
-    <custom-menuoption value="duration">Duration</custom-menuoption>
-    <custom-menuoption value="departure">Departure</custom-menuoption>
-    <custom-menuoption value="arrival">Arrival</custom-menuoption>
-  </custom-menu>
-```
-</auro-accordion>
-<!-- AURO-GENERATED-CONTENT:END -->

package/components/menu/dist/auro-menu-utils.d.ts

@@ -1,34 +0,0 @@
-/**
- * Converts value to an array.
- * If the value is a JSON string representing an array, it will be parsed.
- * If the value is already an array, it is returned.
- * If the value is undefined, it returns undefined.
- * @private
- * @param {any} value - The value to be converted. Can be a string, array, or undefined.
- * @returns {Array|undefined} - The converted array or undefined.
- * @throws {Error} - Throws an error if the value is not an array, undefined,
- * or if the value cannot be parsed into an array from a JSON string.
- */
-export function arrayConverter(value: any): any[] | undefined;
-/**
- * Compare two arrays for equality.
- * @private
- * @param {Array} arr1 - First array to compare.
- * @param {Array} arr2 - Second array to compare.
- * @returns {boolean} True if arrays are equal.
- */
-export function arraysAreEqual(arr1: any[], arr2: any[]): boolean;
-/**
- * Validates if an option can be interacted with.
- * @private
- * @param {HTMLElement} option - The option to check.
- * @returns {boolean} True if option is interactive.
- */
-export function isOptionInteractive(option: HTMLElement): boolean;
-/**
- * Helper method to dispatch custom events.
- * @param {HTMLElement} element - Element to dispatch event from.
- * @param {string} eventName - Name of the event to dispatch.
- * @param {Object} [detail] - Optional detail object to include with the event.
- */
-export function dispatchMenuEvent(element: HTMLElement, eventName: string, detail?: any): void;

package/components/menu/dist/auro-menu.context.d.ts

@@ -1,239 +0,0 @@
-export class MenuService {
-    /**
-     * CONSTRUCTOR
-     */
-    /**
-     * Creates a new MenuService instance.
-     * @param {Object} options - The options object.
-     *   @param {AuroMenu} options.host - The host element that this service will control. Required.
-     * @throws {Error} If the host is not provided.
-     */
-    constructor({ host }?: {
-        host: AuroMenu;
-    });
-    /**
-     * PROPERTIES AND GETTERS
-     */
-    /**
-     * Gets the list of registered menu options.
-     * @returns {AuroMenuOption[]}
-     */
-    get menuOptions(): AuroMenuOption[];
-    /**
-     * Gets the currently highlighted option.
-     * @returns {AuroMenuOption|null}
-     */
-    get highlightedOption(): AuroMenuOption | null;
-    /**
-     * Gets the current value(s) of the selected option(s).
-     * @returns {string|string[]|undefined}
-     */
-    get currentValue(): string | string[] | undefined;
-    /**
-     * Gets the label(s) of the currently selected option(s).
-     * @returns {string}
-     */
-    get currentLabel(): string;
-    /**
-     * Gets the string representation of the current value(s).
-     * For multi-select, this is a JSON stringified array.
-     * @returns {string|undefined}
-     */
-    get stringValue(): string | undefined;
-    /**
-     * Gets the key(s) of the currently selected option(s).
-     * @returns {string|string[]|undefined}
-     */
-    get currentKeys(): string | string[] | undefined;
-    host: AuroMenu;
-    size: any;
-    shape: any;
-    noCheckmark: any;
-    disabled: any;
-    matchWord: any;
-    multiSelect: any;
-    allowDeselect: any;
-    selectAllMatchingOptions: any;
-    highlightedIndex: number;
-    _menuOptions: any[];
-    _subscribers: any[];
-    internalUpdateInProgress: boolean;
-    selectedOptions: any[];
-    _pendingValue: string | number | (string | number)[];
-    _pendingRetryScheduled: boolean;
-    _pendingRetryCount: number;
-    /**
-     * PROPERTY SYNCING
-     */
-    /**
-     * Handles host updates.
-     * This is a lit reactive lifecycle method.
-     * This comes from the Lit controller interface provided by adding this service as a controller to the host.
-     * See constructor for `this.host.addController(this)`
-     * You can read more about Lit reactive controllers here: https://lit.dev/docs/composition/controllers/
-     */
-    hostUpdated(): void;
-    /**
-     * Handles host disconnection and memory cleanup.
-     */
-    hostDisconnected(): void;
-    /**
-     * Sets a property value if it exists on the instance and the value has changed.
-     * @param {string} property
-     * @param {any} value
-     */
-    setProperty(property: string, value: any): void;
-    /**
-     * Sets multiple properties on the instance.
-     * @param {Object} properties - Key-value pairs of properties to set.
-     */
-    setProperties(properties: any): void;
-    /**
-     * MENU OPTION HIGHLIGHTING
-     */
-    /**
-     * Highlights the next active option in the menu.
-     */
-    highlightNext(): void;
-    /**
-     * Highlights the previous active option in the menu.
-     */
-    highlightPrevious(): void;
-    /**
-     * Moves the highlighted option in the specified direction.
-     * @param {string} direction - The direction to move the highlight ("next" or "previous").
-     */
-    moveHighlightedOption(direction: string): void;
-    /**
-     * Sets the highlighted index to the specified option.
-     * @param {AuroMenuOption} option - The option to highlight.
-     */
-    setHighlightedOption(option: AuroMenuOption): void;
-    /**
-     * Sets the highlighted option to the option at the specified index if it exists.
-     * @param {number} index
-     */
-    setHighlightedIndex(index: number): void;
-    /**
-     * Selects the currently highlighted option.
-     */
-    selectHighlightedOption(): void;
-    /**
-     * SELECTION AND DESELECTION METHODS
-     */
-    /**
-     * Selects one or more options in a batch operation
-     * @param {AuroMenuOption|AuroMenuOption[]} options - Single option or array of options to select
-     */
-    selectOptions(options: AuroMenuOption | AuroMenuOption[]): void;
-    /**
-     * Deselects one or more options in a batch operation
-     * @param {AuroMenuOption|AuroMenuOption[]} options - Single option or array of options to deselect
-     */
-    deselectOptions(options: AuroMenuOption | AuroMenuOption[]): void;
-    /**
-     * Selects a single option.
-     * @param {AuroMenuOption} option
-     */
-    selectOption(option: AuroMenuOption): void;
-    /**
-     * Deselects a single option.
-     * @param {AuroMenuOption} option
-     */
-    deselectOption(option: AuroMenuOption): void;
-    /**
-     * Toggles the selection state of a single option.
-     * @param {AuroMenuOption} option
-     */
-    toggleOption(option: AuroMenuOption): void;
-    /**
-     * Selects options based on their value(s) when compared to a passed value or values.
-     * Value or values are normalized to an array of strings that can be matched to option keys.
-     * @param {string|number|Array<string|number>} value - The value(s) to select.
-     */
-    selectByValue(value: string | number | Array<string | number>): void;
-    /**
-     * Queues a pending value and schedules a bounded retry.
-     * @param {string|number|Array<string|number>} value - The value to retry.
-     */
-    queuePendingValue(value: string | number | Array<string | number>): void;
-    /**
-     * Clears pending retry state.
-     */
-    clearPendingValue(): void;
-    /**
-     * Resets the selected options to an empty array.
-     */
-    reset(): void;
-    /**
-     * SUBSCRIPTION, NOTIFICATION AND EVENT DISPATCH METHODS
-     */
-    /**
-     * Subscribes a callback to menu service events.
-     * @param {Function} callback - The callback to invoke on events.
-     */
-    subscribe(callback: Function): void;
-    /**
-     * Remove a previously subscribed callback from menu service events.
-     * @param {Function} callback
-     */
-    unsubscribe(callback: Function): void;
-    /**
-     * Stages an update to notify subscribers of state and value changes.
-     */
-    stageUpdate(meta?: {}): void;
-    /**
-     * Notifies subscribers of a menu service event.
-     * All notifications are sent to all subscribers.
-     * @param {string} event - The event to send to subscribers.
-     */
-    notify(event: string): void;
-    /**
-     * Notifies subscribers of a state change (selected options has changed).
-     */
-    notifyStateChange(meta?: {}): void;
-    /**
-     * Notifies subscribers of a value change (current value has changed).
-     */
-    notifyValueChange(meta?: {}): void;
-    /**
-     * Dispatches a custom event from the host element.
-     * @param {string} eventName
-     * @param {any} detail
-     */
-    dispatchChangeEvent(eventName: string, detail: any): void;
-    /**
-     * MENU OPTION MANAGEMENT METHODS
-     */
-    /**
-     * Adds a menu option to the service's list.
-     * @param {AuroMenuOption} option - the option to track
-     */
-    addMenuOption(option: AuroMenuOption): void;
-    /**
-     * Removes a menu option from the service's list.
-     * @param {AuroMenuOption} option - the option to remove
-     */
-    removeMenuOption(option: AuroMenuOption): void;
-    /**
-     * UTILITIES
-     */
-    /**
-     * Normalizes a value or array of values into an array of strings for option selection.
-     * This function ensures that input values are consistently formatted for matching menu options.
-     *
-     * @param {string|number|Array<string|number>} value - The value(s) to normalize.
-     * @returns {Array<string>} An array of string values suitable for option matching.
-     * @throws {Error} If any value is not a string or number.
-     */
-    _getNormalizedValues(value: string | number | Array<string | number>): Array<string>;
-    /**
-     * Returns whether two arrays of options contain the same elements.
-     * @param {AuroMenuOption[]} arr1 - First array of options.
-     * @param {AuroMenuOption[]} arr2 - Second array of options.
-     * @returns {boolean} True if arrays match, false otherwise.
-     */
-    optionsArraysMatch(arr1: AuroMenuOption[], arr2: AuroMenuOption[]): boolean;
-}
-export const MenuContext: import("@lit/context").Context<"menu-context", any>;
-import { AuroMenuOption } from "./auro-menuoption";