@aotearoan/neon 19.0.2 → 21.0.0

package/dist/src/components/user-input/search/NeonSearch.d.ts

@@ -89,7 +89,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     dropdown: import("vue").Ref<import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -107,7 +109,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -137,16 +141,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>> & Readonly<{
@@ -170,6 +175,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             escapeKeyListener: (event: KeyboardEvent) => void;
             close: () => void;
         } | null>;
+        isButtonStyle: import("vue").ComputedRef<boolean>;
         onClose: () => void;
         close: () => void;
         toggleOpen: () => void;
@@ -756,7 +762,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }, Readonly<import("vue").ExtractPropTypes<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -774,7 +782,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -804,16 +814,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>> & Readonly<{
@@ -837,6 +848,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             escapeKeyListener: (event: KeyboardEvent) => void;
             close: () => void;
         } | null>;
+        isButtonStyle: import("vue").ComputedRef<boolean>;
         onClose: () => void;
         close: () => void;
         toggleOpen: () => void;
@@ -859,7 +871,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }> | null, import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("vue").ExtractPropTypes<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -877,7 +891,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -907,16 +923,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>> & Readonly<{
@@ -940,6 +957,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             escapeKeyListener: (event: KeyboardEvent) => void;
             close: () => void;
         } | null>;
+        isButtonStyle: import("vue").ComputedRef<boolean>;
         onClose: () => void;
         close: () => void;
         toggleOpen: () => void;
@@ -1526,7 +1544,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }, Readonly<import("vue").ExtractPropTypes<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -1544,7 +1564,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -1574,16 +1596,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>> & Readonly<{
@@ -1607,6 +1630,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             escapeKeyListener: (event: KeyboardEvent) => void;
             close: () => void;
         } | null>;
+        isButtonStyle: import("vue").ComputedRef<boolean>;
         onClose: () => void;
         close: () => void;
         toggleOpen: () => void;
@@ -2473,7 +2497,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     NeonDropdown: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -2491,7 +2517,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -2521,16 +2549,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>, {
@@ -2548,6 +2577,7 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             escapeKeyListener: (event: KeyboardEvent) => void;
             close: () => void;
         } | null>;
+        isButtonStyle: import("vue").ComputedRef<boolean>;
         onClose: () => void;
         close: () => void;
         toggleOpen: () => void;
@@ -2556,7 +2586,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
     }, {}, {}, {}, 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<{
         id: {
             type: StringConstructor;
-        };
+        }; /**
+         * Placeholder to display in search input when there is no search string entered.
+         */
         modelValue: {
             type: BooleanConstructor;
             required: true;
@@ -2574,7 +2606,9 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
             default: null;
         };
         icon: {
-            type: StringConstructor;
+            type: StringConstructor; /**
+             * The color of the search.
+             */
             default: null;
         };
         indicator: {
@@ -2604,16 +2638,17 @@ declare const _default: import("vue").DefineComponent<import("vue").ExtractPropT
         placement: {
             type: () => NeonDropdownPlacement;
             default: NeonDropdownPlacement;
-        };
+        }; /**
+         * emitted when the user changes the selection.
+         * @type {string | NeonSearchOption[]} either the selected option's key (single select) or an array of the
+         * selected options (multi-select).
+         */
         placementContainer: {
             type: () => HTMLElement;
             default: null;
         };
         openOnHover: {
-            type: BooleanConstructor; /**
-             * emitted when the user types in filter box.
-             * @type {string} the current filter criteria. This can be used by the application to filter the displayed options.
-             */
+            type: BooleanConstructor;
             default: boolean;
         };
     }>> & Readonly<{