@aotearoan/neon 21.0.0 → 21.0.2

package/dist/src/components/user-input/date-picker/NeonDatePicker.d.ts

@@ -14,6 +14,12 @@ import { NeonDropdownPlacement } from '@/common/enums/NeonDropdownPlacement';
  * This component interaction was inspired by this <a href="https://icehaunter.github.io/vue3-datepicker" target="_blank">vue-datepicker</a>
  */
 declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    /**
+     * Id for the date picker button.
+     */
+    id: {
+        type: StringConstructor;
+    };
     /**
      * The selected date. A date string in the
      * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
@@ -193,7 +199,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     isoDate: (day: number, month: number, year: number) => string;
     isMonthDisabled: (year: number, month: number) => boolean | "" | null;
     isYearDisabled: (year: number) => boolean | 0 | null;
-    openCalendar: () => void;
+    toggleCalendar: () => void;
     onNext: () => void;
     onNextDecade: () => void;
     onNextYear: () => void;
@@ -204,6 +210,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     selectMonth: (month: number) => void;
     selectYear: (year: number) => void;
 }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    /**
+     * Id for the date picker button.
+     */
+    id: {
+        type: StringConstructor;
+    };
     /**
      * The selected date. A date string in the
      * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
@@ -404,14 +416,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: StringConstructor;
             default: null;
         };
+        iconAriaLabel: {
+            type: StringConstructor;
+        };
         iconPosition: {
             type: () => import("../../../neon").NeonHorizontalPosition;
             default: import("../../../neon").NeonHorizontalPosition;
         };
         buttonStyle: {
-            /**
-             * Minimum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-             */
             type: () => import("../../../neon").NeonButtonStyle;
             default: import("../../../neon").NeonButtonStyle;
         };
@@ -499,14 +511,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: StringConstructor;
             default: null;
         };
+        iconAriaLabel: {
+            type: StringConstructor;
+        };
         iconPosition: {
             type: () => import("../../../neon").NeonHorizontalPosition;
             default: import("../../../neon").NeonHorizontalPosition;
         };
         buttonStyle: {
-            /**
-             * Minimum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-             */
             type: () => import("../../../neon").NeonButtonStyle;
             default: import("../../../neon").NeonButtonStyle;
         };
@@ -607,12 +619,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             name: {
                 type: StringConstructor;
                 required: true; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
             }; /**
-             * The selected date. A date string in the
-             * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+             * Id for the date picker button.
              */
             color: {
                 type: () => NeonFunctionalColor;
@@ -624,8 +634,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             disabled: {
                 type: BooleanConstructor;
-                default: boolean;
-            };
+                default: boolean; /**
+                 * Disable date picker
+                 */
+            }; /**
+             * Disable date picker
+             */
         }>, {
             attrs: {
                 [x: string]: unknown;
@@ -635,12 +649,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             name: {
                 type: StringConstructor;
                 required: true; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
             }; /**
-             * The selected date. A date string in the
-             * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+             * Id for the date picker button.
              */
             color: {
                 type: () => NeonFunctionalColor;
@@ -652,8 +664,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             disabled: {
                 type: BooleanConstructor;
-                default: boolean;
-            };
+                default: boolean; /**
+                 * Disable date picker
+                 */
+            }; /**
+             * Disable date picker
+             */
         }>> & Readonly<{}>, {
             disabled: boolean;
             color: NeonFunctionalColor;
@@ -683,9 +699,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             }>;
             activeRoute: import("vue").ComputedRef<boolean | "">;
             exactRoute: import("vue").ComputedRef<boolean | "">;
-            onClick: () => void; /**
-             * Maximum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-             */
+            onClick: () => void;
             onSpace: () => Promise<void>;
         }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
             href: {
@@ -716,12 +730,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -733,8 +745,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>, {
                 attrs: {
                     [x: string]: unknown;
@@ -744,12 +760,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -761,8 +775,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>> & Readonly<{}>, {
                 disabled: boolean;
                 color: NeonFunctionalColor;
@@ -794,6 +812,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: StringConstructor;
             default: null;
         };
+        iconAriaLabel: {
+            type: StringConstructor;
+        };
         indicator: {
             type: BooleanConstructor;
             default: boolean;
@@ -804,9 +825,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         };
         size: {
             type: () => NeonSize;
-            /**
-             * The placement of the dropdown calendar popup.
-             */
             default: NeonSize;
         };
         color: {
@@ -815,15 +833,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
              * Disabled dates, a list of <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format
              * dates for which to disable selection.
              */
-        };
+        }; /**
+         * Disabled dates, a list of <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format
+         * dates for which to disable selection.
+         */
         alternateColor: {
             type: () => NeonFunctionalColor;
             default: null;
         };
         dropdownStyle: {
-            /**
-             * This is the placeholder for the text input when no value is provided.
-             */
             type: () => import("../../../neon").NeonDropdownStyle;
             default: import("../../../neon").NeonDropdownStyle;
         };
@@ -884,6 +902,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             type: StringConstructor;
             default: null;
         };
+        iconAriaLabel: {
+            type: StringConstructor;
+        };
         indicator: {
             type: BooleanConstructor;
             default: boolean;
@@ -894,9 +915,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         };
         size: {
             type: () => NeonSize;
-            /**
-             * The placement of the dropdown calendar popup.
-             */
             default: NeonSize;
         };
         color: {
@@ -905,15 +923,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
              * Disabled dates, a list of <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format
              * dates for which to disable selection.
              */
-        };
+        }; /**
+         * Disabled dates, a list of <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format
+         * dates for which to disable selection.
+         */
         alternateColor: {
             type: () => NeonFunctionalColor;
             default: null;
         };
         dropdownStyle: {
-            /**
-             * This is the placeholder for the text input when no value is provided.
-             */
             type: () => import("../../../neon").NeonDropdownStyle;
             default: import("../../../neon").NeonDropdownStyle;
         };
@@ -968,8 +986,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             size: {
-                type: () => NeonSize;
-                default: NeonSize;
+                type: () => import("../../../neon").NeonBadgeSize;
+                default: import("../../../neon").NeonBadgeSize;
             };
             color: {
                 type: () => NeonFunctionalColor;
@@ -1011,8 +1029,8 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             size: {
-                type: () => NeonSize;
-                default: NeonSize;
+                type: () => import("../../../neon").NeonBadgeSize;
+                default: import("../../../neon").NeonBadgeSize;
             };
             color: {
                 type: () => NeonFunctionalColor;
@@ -1038,7 +1056,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: boolean;
             label: string;
             icon: string;
-            size: NeonSize;
+            size: import("../../../neon").NeonBadgeSize;
             color: NeonFunctionalColor;
             image: string;
             circular: boolean;
@@ -1050,12 +1068,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -1067,8 +1083,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>, {
                 attrs: {
                     [x: string]: unknown;
@@ -1078,12 +1098,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -1095,8 +1113,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>> & Readonly<{}>, {
                 disabled: boolean;
                 color: NeonFunctionalColor;
@@ -1132,14 +1154,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 type: StringConstructor;
                 default: null;
             };
+            iconAriaLabel: {
+                type: StringConstructor;
+            };
             iconPosition: {
                 type: () => import("../../../neon").NeonHorizontalPosition;
                 default: import("../../../neon").NeonHorizontalPosition;
             };
             buttonStyle: {
-                /**
-                 * Minimum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-                 */
                 type: () => import("../../../neon").NeonButtonStyle;
                 default: import("../../../neon").NeonButtonStyle;
             };
@@ -1227,14 +1249,14 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 type: StringConstructor;
                 default: null;
             };
+            iconAriaLabel: {
+                type: StringConstructor;
+            };
             iconPosition: {
                 type: () => import("../../../neon").NeonHorizontalPosition;
                 default: import("../../../neon").NeonHorizontalPosition;
             };
             buttonStyle: {
-                /**
-                 * Minimum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-                 */
                 type: () => import("../../../neon").NeonButtonStyle;
                 default: import("../../../neon").NeonButtonStyle;
             };
@@ -1335,12 +1357,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -1352,8 +1372,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>, {
                 attrs: {
                     [x: string]: unknown;
@@ -1363,12 +1387,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 name: {
                     type: StringConstructor;
                     required: true; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                 }; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
                 color: {
                     type: () => NeonFunctionalColor;
@@ -1380,8 +1402,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 };
                 disabled: {
                     type: BooleanConstructor;
-                    default: boolean;
-                };
+                    default: boolean; /**
+                     * Disable date picker
+                     */
+                }; /**
+                 * Disable date picker
+                 */
             }>> & Readonly<{}>, {
                 disabled: boolean;
                 color: NeonFunctionalColor;
@@ -1411,9 +1437,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 }>;
                 activeRoute: import("vue").ComputedRef<boolean | "">;
                 exactRoute: import("vue").ComputedRef<boolean | "">;
-                onClick: () => void; /**
-                 * Maximum allowed date value in the <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
-                 */
+                onClick: () => void;
                 onSpace: () => Promise<void>;
             }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
                 href: {
@@ -1444,12 +1468,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                     name: {
                         type: StringConstructor;
                         required: true; /**
-                         * The selected date. A date string in the
-                         * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                         * Id for the date picker button.
                          */
                     }; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                     color: {
                         type: () => NeonFunctionalColor;
@@ -1461,8 +1483,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                     };
                     disabled: {
                         type: BooleanConstructor;
-                        default: boolean;
-                    };
+                        default: boolean; /**
+                         * Disable date picker
+                         */
+                    }; /**
+                     * Disable date picker
+                     */
                 }>, {
                     attrs: {
                         [x: string]: unknown;
@@ -1472,12 +1498,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                     name: {
                         type: StringConstructor;
                         required: true; /**
-                         * The selected date. A date string in the
-                         * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                         * Id for the date picker button.
                          */
                     }; /**
-                     * The selected date. A date string in the
-                     * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                     * Id for the date picker button.
                      */
                     color: {
                         type: () => NeonFunctionalColor;
@@ -1489,8 +1513,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                     };
                     disabled: {
                         type: BooleanConstructor;
-                        default: boolean;
-                    };
+                        default: boolean; /**
+                         * Disable date picker
+                         */
+                    }; /**
+                     * Disable date picker
+                     */
                 }>> & Readonly<{}>, {
                     disabled: boolean;
                     color: NeonFunctionalColor;
@@ -1597,9 +1625,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: number;
         };
         disabled: {
-            type: BooleanConstructor; /**
-             * This is the label of the input field which opens the calendar. This is technically a button.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
         stateHighlight: {
@@ -1693,9 +1719,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: number;
         };
         disabled: {
-            type: BooleanConstructor; /**
-             * This is the label of the input field which opens the calendar. This is technically a button.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
         stateHighlight: {
@@ -1744,12 +1768,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             name: {
                 type: StringConstructor;
                 required: true; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
             }; /**
-             * The selected date. A date string in the
-             * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+             * Id for the date picker button.
              */
             color: {
                 type: () => NeonFunctionalColor;
@@ -1761,8 +1783,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             disabled: {
                 type: BooleanConstructor;
-                default: boolean;
-            };
+                default: boolean; /**
+                 * Disable date picker
+                 */
+            }; /**
+             * Disable date picker
+             */
         }>, {
             attrs: {
                 [x: string]: unknown;
@@ -1772,12 +1798,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             name: {
                 type: StringConstructor;
                 required: true; /**
-                 * The selected date. A date string in the
-                 * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+                 * Id for the date picker button.
                  */
             }; /**
-             * The selected date. A date string in the
-             * <a href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601</a> format.
+             * Id for the date picker button.
              */
             color: {
                 type: () => NeonFunctionalColor;
@@ -1789,8 +1813,12 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             };
             disabled: {
                 type: BooleanConstructor;
-                default: boolean;
-            };
+                default: boolean; /**
+                 * Disable date picker
+                 */
+            }; /**
+             * Disable date picker
+             */
         }>> & Readonly<{}>, {
             disabled: boolean;
             color: NeonFunctionalColor;