@aotearoan/neon 21.0.2 → 22.0.0

package/dist/src/components/navigation/dropdown-menu/NeonDropdownMenu.d.ts

@@ -37,6 +37,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Placement of the dropdown contents.
+     */
+    placement: {
+        type: () => NeonDropdownPlacement;
+        default: NeonDropdownPlacement;
+    };
     /**
      * Instead of opening on click (default), open on hover.
      */
@@ -47,16 +54,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
 }>, {
     dropdown: import("vue").Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -66,7 +73,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -117,7 +127,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         onBlur?: ((...args: any[]) => any) | undefined;
         "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
         "onDropdown-placement"?: ((...args: any[]) => any) | undefined;
-        "onButton-ref"?: ((...args: any[]) => any) | undefined;
     }>, {
         dropdownButton: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
         dropdownContent: import("vue").Ref<HTMLDivElement | null, HTMLDivElement | null>;
@@ -139,7 +148,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         toggleOpen: () => void;
         onBlur: () => void;
         onFocus: () => void;
-    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement" | "button-ref")[], import("vue").PublicProps, {
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement")[], import("vue").PublicProps, {
         disabled: boolean;
         label: string;
         placement: NeonDropdownPlacement;
@@ -186,13 +195,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -233,13 +244,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -325,7 +338,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {
@@ -420,7 +435,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {
@@ -721,16 +738,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         Defaults: {};
     }, Readonly<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -740,7 +757,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -791,7 +811,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         onBlur?: ((...args: any[]) => any) | undefined;
         "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
         "onDropdown-placement"?: ((...args: any[]) => any) | undefined;
-        "onButton-ref"?: ((...args: any[]) => any) | undefined;
     }>, {
         dropdownButton: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
         dropdownContent: import("vue").Ref<HTMLDivElement | null, HTMLDivElement | null>;
@@ -829,16 +848,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         openOnHover: boolean;
     }> | null, import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -848,7 +867,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -899,7 +921,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         onBlur?: ((...args: any[]) => any) | undefined;
         "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
         "onDropdown-placement"?: ((...args: any[]) => any) | undefined;
-        "onButton-ref"?: ((...args: any[]) => any) | undefined;
     }>, {
         dropdownButton: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
         dropdownContent: import("vue").Ref<HTMLDivElement | null, HTMLDivElement | null>;
@@ -921,7 +942,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         toggleOpen: () => void;
         onBlur: () => void;
         onFocus: () => void;
-    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement" | "button-ref")[], import("vue").PublicProps, {
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement")[], import("vue").PublicProps, {
         disabled: boolean;
         label: string;
         placement: NeonDropdownPlacement;
@@ -968,13 +989,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -1015,13 +1038,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -1107,7 +1132,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {
@@ -1202,7 +1229,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {
@@ -1503,16 +1532,16 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         Defaults: {};
     }, Readonly<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -1522,7 +1551,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -1573,7 +1605,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         onBlur?: ((...args: any[]) => any) | undefined;
         "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
         "onDropdown-placement"?: ((...args: any[]) => any) | undefined;
-        "onButton-ref"?: ((...args: any[]) => any) | undefined;
     }>, {
         dropdownButton: import("vue").Ref<HTMLElement | null, HTMLElement | null>;
         dropdownContent: import("vue").Ref<HTMLDivElement | null, HTMLDivElement | null>;
@@ -1617,7 +1648,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     attrs: {
         [x: string]: unknown;
     };
-    emit: (event: "click" | "button-ref", ...args: any[]) => void;
+    emit: (event: "click", ...args: any[]) => void;
     changeHighlighted: (key: string) => void;
     keyboardHandler: ($event: KeyboardEvent) => void;
     onBlur: () => void;
@@ -1625,7 +1656,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     clickItem: (item: NeonDropdownMenuItem) => void;
     navigateBy: (offset: number, $event: KeyboardEvent) => void;
     onPlacement: (placement: NeonDropdownPlacement) => void;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("click" | "button-ref")[], "click" | "button-ref", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "click"[], "click", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * A list of menu items to render in the dropdown menu.
      */
@@ -1654,6 +1685,13 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         type: BooleanConstructor;
         default: boolean;
     };
+    /**
+     * Placement of the dropdown contents.
+     */
+    placement: {
+        type: () => NeonDropdownPlacement;
+        default: NeonDropdownPlacement;
+    };
     /**
      * Instead of opening on click (default), open on hover.
      */
@@ -1663,25 +1701,25 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     };
 }>> & Readonly<{
     onClick?: ((...args: any[]) => any) | undefined;
-    "onButton-ref"?: ((...args: any[]) => any) | undefined;
 }>, {
     disabled: boolean;
+    placement: NeonDropdownPlacement;
     size: NeonSize;
     color: NeonFunctionalColor;
     openOnHover: boolean;
 }, {}, {
     NeonDropdown: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -1691,7 +1729,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -1758,18 +1799,18 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         toggleOpen: () => void;
         onBlur: () => void;
         onFocus: () => void;
-    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement" | "button-ref")[], "update:modelValue" | "focus" | "blur" | "dropdown-placement" | "button-ref", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    }, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "focus" | "blur" | "dropdown-placement")[], "update:modelValue" | "focus" | "blur" | "dropdown-placement", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
         id: {
-            type: StringConstructor;
-        };
-        modelValue: {
-            type: BooleanConstructor;
-            required: true; /**
-             * Instead of opening on click (default), open on hover.
+            type: StringConstructor; /**
+             * Whether the dropdown button is disabled or not.
              */
         }; /**
-         * Instead of opening on click (default), open on hover.
+         * Whether the dropdown button is disabled or not.
          */
+        modelValue: {
+            type: BooleanConstructor;
+            required: true;
+        };
         label: {
             type: StringConstructor;
             default: null;
@@ -1779,7 +1820,10 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         imageAlt: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * emitted when the user clicks on a menu item.
+             * @type {NeonDropdownMenuItem} the menu item the user clicked on.
+             */
             default: null;
         };
         icon: {
@@ -1830,7 +1874,6 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         onBlur?: ((...args: any[]) => any) | undefined;
         "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
         "onDropdown-placement"?: ((...args: any[]) => any) | undefined;
-        "onButton-ref"?: ((...args: any[]) => any) | undefined;
     }>, {
         disabled: boolean;
         label: string;
@@ -1878,13 +1921,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -1925,13 +1970,15 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             disabled: {
                 type: BooleanConstructor;
                 default: boolean; /**
-                 * Instead of opening on click (default), open on hover.
+                 * Placement of the dropdown contents.
                  */
             }; /**
-             * Instead of opening on click (default), open on hover.
+             * Placement of the dropdown contents.
              */
             jazziconId: {
-                type: StringConstructor;
+                type: StringConstructor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             imageAlt: {
@@ -2017,7 +2064,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {
@@ -2112,7 +2161,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
                 default: boolean;
             };
             alternateColor: {
-                type: () => NeonFunctionalColor;
+                type: () => NeonFunctionalColor; /**
+                 * Instead of opening on click (default), open on hover.
+                 */
                 default: null;
             };
             icon: {