@aurodesignsystem/auro-formkit 5.9.0 → 5.9.2

package/components/datepicker/demo/readme.html

@@ -48,10 +48,9 @@
           Prism.highlightAll();
         })
     </script>
-    <script type="module">
-      import { initExamples } from "./index.min.js";
+    <script src="./index.min.js" data-demo-script="true" type="module"></script>
 
-      initExamples();
-    </script>
+    <!-- If additional elements are needed for the demo, add them here. -->
+    <script src="https://cdn.jsdelivr.net/npm/@aurodesignsystem/auro-accordion@latest/+esm" type="module"></script>
   </body>
 </html>

package/components/datepicker/demo/readme.md

@@ -18,6 +18,7 @@ The following sections are editable by making changes to the following files:
 -->
 
 # Datepicker
+
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=./docs/partials/description.md) -->
 <!-- The below content is automatically added from ./docs/partials/description.md -->
 The `<auro-datepicker>` element allows users to select a date, or a pair of dates identifying a range, either with text input or by making a section in a calendar. The `<auro-datepicker>` element is the combination of [auro-dropdown](http://auro.alaskaair.com/components/auro/dropdown), [auro-input](http://auro.alaskaair.com/components/auro/input), and Auro's extension of [wc-range-datepicker](https://www.npmjs.com/package/wc-range-datepicker).
@@ -27,7 +28,18 @@ The `<auro-datepicker>` element allows users to select a date, or a pair of date
 <!-- 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 -->
 
+## Datepicker 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-datepicker>` element should be used in situations where users may:
+
+* select a single date
+* select a pair of dates which identify a calendar range
+<!-- 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 -->
 
@@ -40,30 +52,7 @@ $ npm i @aurodesignsystem/auro-formkit
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/templates/gettingStarted.md) -->
 <!-- The below content is automatically added from ../../docs/templates/gettingStarted.md -->
 
-### Import Options
-
-#### Automatic Registration
-
-For automatic registration, simply import the component:
-
-```javascript
-// Registers <auro-datepicker> automatically
-import '@aurodesignsystem/auro-formkit/auro-datepicker';
-```
-
-#### Custom Registration
-
-To protect from versioning conflicts with other instances of the component being loaded, it is recommended to use our static `AuroDatepicker.register('custom-datepicker')` method on the component class and pass in a unique name.
-
-```javascript
-// Import the class only
-import { AuroDatepicker } from '@aurodesignsystem/auro-formkit/auro-datepicker/class';
-
-// Register with a custom name if desired
-AuroDatepicker.register('custom-datepicker');
-```
-
-#### TypeScript Module Resolution
+### TypeScript Module Resolution
 
 When using TypeScript set `moduleResolution` to `bundler`, add the following to your `tsconfig.json`:
 
@@ -76,30 +65,10 @@ 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 -->
-**Reference component in HTML**
-
-<!-- AURO-GENERATED-CONTENT:START (CODE:src=./apiExamples/basic.html) -->
-<!-- The below code snippet is automatically added from ./apiExamples/basic.html -->
-
-```html
-<auro-datepicker required="">
-  <span slot="ariaLabel.bib.close">Close Calendar</span>
-  <span slot="bib.fullscreen.headline">Datepicker Headline</span>
-  <span slot="fromLabel">Choose a date</span>
-  <span slot="bib.fullscreen.dateLabel">Choose a date</span>
-</auro-datepicker>
-```
-<!-- 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 -->
 
 ## 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.
@@ -109,22 +78,7 @@ In cases where the project is not able to process JS assets, there are pre-proce
 ```
 <!-- AURO-GENERATED-CONTENT:END -->
 
-## UI development browser support
-<!-- AURO-GENERATED-CONTENT:START (REMOTE:url=https://raw.githubusercontent.com/AlaskaAirlines/WC-Generator/master/componentDocs/partials/browserSupport.md) -->
-For the most up to date information on [UI development browser support](https://auro.alaskaair.com/support/browsersSupport)
-
-<!-- AURO-GENERATED-CONTENT:END -->
-
-## auro-datepicker 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-datepicker>` element should be used in situations where users may:
-
-* select a single date
-* select a pair of dates which identify a calendar range
-<!-- AURO-GENERATED-CONTENT:END -->
-
-## Formkit development
+## Formkit Development
 
 <!-- AURO-GENERATED-CONTENT:START (FILE:src=../../docs/partials/developmentDescription.md) -->
 <!-- The below content is automatically added from ../../docs/partials/developmentDescription.md -->
@@ -138,4 +92,46 @@ 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 { AuroDatepicker } from '@aurodesignsystem/auro-formkit/auro-datepicker/class';
+
+// Register with a custom name if desired
+AuroDatepicker.register('custom-datepicker');
+```
+
+This will create a new custom element `<custom-datepicker>` that behaves exactly like `<auro-datepicker>`, allowing both to coexist on the same page without interfering with each other.
+
+<div class="exampleWrapper exampleWrapper--flex">
+  <custom-datepicker>
+    <span slot="bib.fullscreen.headline">custom-datepicker Example</span>
+    <span slot="fromLabel">Choose a date</span>
+    <span slot="bib.fullscreen.dateLabel">Choose a date</span>
+  </custom-datepicker>
+</div>
+<auro-accordion alignRight>
+  <span slot="trigger">See code</span>
+
+```html
+  <custom-datepicker>
+    <span slot="bib.fullscreen.headline">custom-datepicker Example</span>
+    <span slot="fromLabel">Choose a date</span>
+    <span slot="bib.fullscreen.dateLabel">Choose a date</span>
+  </custom-datepicker>
+```
+</auro-accordion>
 <!-- AURO-GENERATED-CONTENT:END -->

package/components/datepicker/dist/auro-calendar.d.ts

@@ -1,66 +1,78 @@
 /**
- * @prop {Object} firstDayOfWeek - Weekday that will be displayed in first column of month grid.
- * 0: sunday, 1: monday, 2: tuesday, 3: wednesday , 4: thursday, 5: friday, 6: saturday
- * Default is 0.
- * @prop {Date | null} focusedDate - The currently focused date (if any).
- * @prop {Date} maxDate - Maximum date. All dates after will be disabled.
- * @prop {Date} minDate - Minimum date. All dates before will be disabled.
- * @prop {Date | undefined} selectedDate - The selected date, usually synchronized with datepicker-input.
- * Not to be confused with the focused date (therefore not necessarily in active month view).
- * @prop {string} weekdayHeaderNotation - Weekday header notation, based on Intl DatetimeFormat:.
- * @prop {Boolean} visible - Flag indicating if the calendar is visible.
- * - 'short' (e.g., Thu)
- * - 'narrow' (e.g., T).
- * Default is 'short'.
  * @event auroCalendar-dateSelected - Notifies that a date has been selected in the calendar.
  * @event auroCalendar-monthChanged - Notifies that the visible calendar month(s) have changed.
  */
 export class AuroCalendar extends RangeDatepicker {
     static get styles(): import("lit").CSSResult[];
     static get properties(): {
-        numCalendars: {
-            type: NumberConstructor;
-        };
-        dateFrom: {
-            type: StringConstructor;
-        };
-        dateTo: {
-            type: StringConstructor;
-        };
-        maxDate: {
+        /**
+         * The last month that may be displayed in the calendar.
+         */
+        calendarEndMonth: {
             type: StringConstructor;
             reflect: boolean;
         };
-        minDate: {
+        /**
+         * The first month that may be displayed in the calendar.
+         */
+        calendarStartMonth: {
             type: StringConstructor;
             reflect: boolean;
         };
-        calendarStartMonth: {
+        /**
+         * The date that determines the currently visible month.
+         */
+        centralDate: {
             type: StringConstructor;
             reflect: boolean;
         };
-        calendarEndMonth: {
+        /**
+         * The starting date of the selected range.
+         */
+        dateFrom: {
             type: StringConstructor;
-            reflect: boolean;
         };
-        centralDate: {
+        /**
+         * The ending date of the selected range.
+         */
+        dateTo: {
             type: StringConstructor;
-            reflect: boolean;
         };
-        visible: {
+        /**
+         * Dropdown element that contains the calendar.
+         * @private
+         */
+        dropdown: {
+            type: ObjectConstructor;
+        };
+        /**
+         * Flag indicating if the calendar is in fullscreen mode.
+         */
+        isFullscreen: {
             type: BooleanConstructor;
             reflect: boolean;
         };
+        /**
+         * If declared, make bib.fullscreen.headline in HeadingDisplay.
+         * Otherwise, Heading 600.
+         */
         largeFullscreenHeadline: {
             type: BooleanConstructor;
             reflect: boolean;
         };
-        isFullscreen: {
-            type: BooleanConstructor;
+        /**
+         * Maximum date. All dates after will be disabled.
+         */
+        maxDate: {
+            type: StringConstructor;
             reflect: boolean;
         };
-        dropdown: {
-            type: ObjectConstructor;
+        /**
+         * Minimum date. All dates before will be disabled.
+         */
+        minDate: {
+            type: StringConstructor;
+            reflect: boolean;
         };
         /**
          * Mobile breakpoint for responsive design.
@@ -76,6 +88,20 @@ export class AuroCalendar extends RangeDatepicker {
         monthFirst: {
             type: BooleanConstructor;
         };
+        /**
+         * Number of calendars to render.
+         * @private
+         */
+        numCalendars: {
+            type: NumberConstructor;
+        };
+        /**
+         * Flag indicating if the calendar is visible.
+         */
+        visible: {
+            type: BooleanConstructor;
+            reflect: boolean;
+        };
     };
     /**
      * @private

package/components/datepicker/dist/auro-datepicker.d.ts

@@ -1,9 +1,13 @@
 /**
+ * The `auro-datepicker` component provides users with a way to select a date or date range from a calendar popup or fullscreen calendar on mobile.
+ * @customElement auro-datepicker
+ *
  * @slot helpText - Defines the content of the helpText.
  * @slot ariaLabel.bib.close - Sets aria-label on close button in fullscreen bib
  * @slot ariaLabel.input.clear - Sets aria-label on clear button
  * @slot bib.fullscreen.headline - Defines the headline to display above bib.fullscreen.dateLabels in the mobile layout.
  * @slot bib.fullscreen.dateLabel - Defines the content to display above selected dates in the mobile layout.
+ * @slot label - Defines the label content for the entire datepicker when `layout="snowflake"`.
  * @slot toLabel - Defines the label content for the second input when the `range` attribute is used.
  * @slot fromLabel - Defines the label content for the first input.
  * @slot date_MM_DD_YYYY - Defines the content to display in the auro-calendar-cell for the specified date. The content text is colored using the success state token when the `highlight` attribute is applied to the slot.
@@ -114,18 +118,15 @@ export class AuroDatePicker extends AuroElement {
             reflect: boolean;
         };
         /**
-         * Defines the screen size breakpoint (`xs`, `sm`, `md`, `lg`, `xl`, `disabled`)
-         * at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.
+         * Defines the screen size breakpoint at which the dropdown switches to fullscreen mode on mobile. `disabled` indicates a dropdown should _never_ enter fullscreen.
          *
          * When expanded, the dropdown will automatically display in fullscreen mode
          * if the screen size is equal to or smaller than the selected breakpoint.
-         * @default sm
+         * @type {'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'disabled'}
+         * @default 'sm'
          */
-        fullscreenBreakpoint: {
-            type: StringConstructor;
-            reflect: boolean;
-        };
-        /** Exposes inputmode attribute for input.  */
+        fullscreenBreakpoint: "xs" | "sm" | "md" | "lg" | "xl" | "disabled";
+        /** Exposes inputmode attribute for input. */
         inputmode: {
             type: StringConstructor;
             attribute: boolean;
@@ -139,6 +140,12 @@ export class AuroDatePicker extends AuroElement {
             type: BooleanConstructor;
             reflect: boolean;
         };
+        /**
+         * Sets the layout of the datepicker.
+         * @type {'classic' | 'snowflake'}
+         * @default 'classic'
+         */
+        layout: "classic" | "snowflake";
         /**
          * Maximum date. All dates after will be disabled.
          */
@@ -168,7 +175,6 @@ export class AuroDatePicker extends AuroElement {
         /**
          * If declared, the bib will NOT flip to an alternate position
          * when there isn't enough space in the specified `placement`.
-         * @default false
          */
         noFlip: {
             type: BooleanConstructor;
@@ -176,7 +182,6 @@ export class AuroDatePicker extends AuroElement {
         };
         /**
          * If declared, the dropdown will shift its position to avoid being cut off by the viewport.
-         * @default false
          */
         shift: {
             type: BooleanConstructor;
@@ -198,7 +203,7 @@ export class AuroDatePicker extends AuroElement {
             reflect: boolean;
         };
         /**
-         * DEPRECATED - use `appearance` instead.
+         * DEPRECATED - use `appearance="inverse"` instead.
          */
         onDark: {
             type: BooleanConstructor;
@@ -222,17 +227,10 @@ export class AuroDatePicker extends AuroElement {
         };
         /**
          * Position where the bib should appear relative to the trigger.
-         * Accepted values:
-         * "top" | "right" | "bottom" | "left" |
-         * "bottom-start" | "top-start" | "top-end" |
-         * "right-start" | "right-end" | "bottom-end" |
-         * "left-start" | "left-end"
-         * @default bottom-start
-         */
-        placement: {
-            type: StringConstructor;
-            reflect: boolean;
-        };
+         * @type {'top' | 'right' | 'bottom' | 'left' | 'bottom-start' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-end' | 'left-start' | 'left-end'}
+         * @default 'bottom-start'
+         */
+        placement: "top" | "right" | "bottom" | "left" | "bottom-start" | "top-start" | "top-end" | "right-start" | "right-end" | "bottom-end" | "left-start" | "left-end";
         /**
          * If set, turns on date range functionality in auro-calendar.
          */
@@ -313,16 +311,18 @@ export class AuroDatePicker extends AuroElement {
         };
         /**
          * Indicates whether the datepicker is in a dirty state (has been interacted with).
-         * @type {boolean}
-         * @default false
          * @private
          */
-        touched: boolean;
+        touched: {
+            type: BooleanConstructor;
+            reflect: boolean;
+            attribute: boolean;
+        };
     };
     static get styles(): import("lit").CSSResult[];
     /**
      * This will register this element with the browser.
-     * @param {string} [name="auro-datepicker"] - The name of element that you want to register to.
+     * @param {string} [name="auro-datepicker"] - The name of the element that you want to register.
      *
      * @example
      * AuroDatePicker.register("custom-datepicker") // this will register this element to <custom-datepicker/>
@@ -447,11 +447,11 @@ export class AuroDatePicker extends AuroElement {
      * @returns {string} - The font class for the input.
      */
     private get displayValueFontClass();
-    get commonDisplayValueWrapperClasses(): {
-        [x: string]: boolean;
-        displayValueWrapper: boolean;
-        util_displayHiddenVisually: boolean;
-    };
+    /**
+     * @private
+     * Common display value wrapper classes.
+     */
+    private get commonDisplayValueWrapperClasses();
     /**
      * Function to determine if there is any displayValue content to render.
      * @private
@@ -613,7 +613,7 @@ export class AuroDatePicker extends AuroElement {
      */
     private setHasValue;
     get hasError(): boolean;
-    updated(changedProperties: any): void;
+    updated(changedProperties: any): Promise<void>;
     monthFirst: boolean;
     previousTabIndex: string;
     formattedFocusDate: boolean;

package/components/datepicker/dist/iconVersion.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "9.1.0";
+declare const _default: "9.1.1";
 export default _default;