@coreui/vue-pro 5.17.1 → 5.19.0

package/dist/cjs/components/multi-select/CMultiSelect.d.ts

@@ -25,6 +25,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Accessible label for the search input (when `search` is enabled).
+     *
+     * @since 5.19.0
+     */
+    ariaSearchLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Accessible label prefix for a tag's delete button (selection type `tags`). The selected option's label is appended, so screen readers announce e.g. "Remove Angular".
+     *
+     * @since 5.19.0
+     */
+    ariaTagDeleteLabel: {
+        type: StringConstructor;
+        default: string;
+    };
     /**
      * Enables selection cleaner element.
      *
@@ -49,6 +67,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
      * @since 4.9.0
      */
     clearSearchOnSelect: BooleanConstructor;
+    /**
+     * Sets the select all button label shown once everything is selected. The button is a toggle: it shows `selectAllLabel` (and selects all) until everything is selected, then shows `deselectAllLabel` (and deselects all).
+     *
+     * @since 5.19.0
+     */
+    deselectAllLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sets the deselect filtered button label (used with `selectAllMode="filtered"`).
+     *
+     * @since 5.19.0
+     */
+    deselectFilteredLabel: {
+        type: StringConstructor;
+        default: string;
+    };
     /**
      * Toggle the disabled state for the component.
      */
@@ -118,6 +154,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
         type: PropType<(Option | OptionsGroup)[]>;
         default: () => never[];
     };
+    /**
+     * Makes each options group label a toggle that selects or deselects all options in that group. With `optionsGroupsStyle="checkbox"` (and `multiple`) the label shows a tri-state checkbox indicator (`none` / `all` / `indeterminate`) reflecting the group's selection.
+     *
+     * @since 5.19.0
+     */
+    optionsGroupsSelectable: BooleanConstructor;
+    /**
+     * Sets the options group label style when `optionsGroupsSelectable` is enabled.
+     *
+     * @values 'checkbox', 'text'
+     * @default 'checkbox'
+     * @since 5.19.0
+     */
+    optionsGroupsStyle: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
     /**
      * Sets maxHeight of options list.
      *
@@ -189,12 +243,54 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
     /**
      * Sets the select all button label.
      *
-     * @default 'Select all options'
+     * @default 'Select all'
      */
     selectAllLabel: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Determines what the select all button operates on: all options (`'all'`) or only the currently filtered (search-visible) options (`'filtered'`).
+     *
+     * @values 'all', 'filtered'
+     * @default 'all'
+     * @since 5.19.0
+     */
+    selectAllMode: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Sets the select all button style. With `'checkbox'` (and `multiple`), the button shows a tri-state checkbox indicator (`none` / `all` / `indeterminate`) and toggles between selecting and deselecting.
+     *
+     * @values 'checkbox', 'text'
+     * @default 'checkbox'
+     * @since 5.19.0
+     */
+    selectAllStyle: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Sets the select filtered button label (used with `selectAllMode="filtered"`).
+     *
+     * @since 5.19.0
+     */
+    selectFilteredLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sets the maximum number of options that can be selected. The select all button stays enabled and selects options up to the limit, then toggles to deselect all once the limit is reached. The `selectionLimit` event fires when a user tries to select more options than allowed.
+     *
+     * @since 5.19.0
+     */
+    selectionLimit: {
+        type: NumberConstructor;
+        default: null;
+    };
     /**
      * Sets the selection style.
      *
@@ -281,7 +377,7 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
     };
 }>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("change" | "hide" | "show" | "filterChange")[], "change" | "hide" | "show" | "filterChange", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+}>[], {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("change" | "hide" | "show" | "filterChange" | "selectionLimit")[], "change" | "hide" | "show" | "filterChange" | "selectionLimit", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
     /**
      * Allow users to create options if they are not in the list of options.
      *
@@ -306,6 +402,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Accessible label for the search input (when `search` is enabled).
+     *
+     * @since 5.19.0
+     */
+    ariaSearchLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Accessible label prefix for a tag's delete button (selection type `tags`). The selected option's label is appended, so screen readers announce e.g. "Remove Angular".
+     *
+     * @since 5.19.0
+     */
+    ariaTagDeleteLabel: {
+        type: StringConstructor;
+        default: string;
+    };
     /**
      * Enables selection cleaner element.
      *
@@ -330,6 +444,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
      * @since 4.9.0
      */
     clearSearchOnSelect: BooleanConstructor;
+    /**
+     * Sets the select all button label shown once everything is selected. The button is a toggle: it shows `selectAllLabel` (and selects all) until everything is selected, then shows `deselectAllLabel` (and deselects all).
+     *
+     * @since 5.19.0
+     */
+    deselectAllLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sets the deselect filtered button label (used with `selectAllMode="filtered"`).
+     *
+     * @since 5.19.0
+     */
+    deselectFilteredLabel: {
+        type: StringConstructor;
+        default: string;
+    };
     /**
      * Toggle the disabled state for the component.
      */
@@ -399,6 +531,24 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
         type: PropType<(Option | OptionsGroup)[]>;
         default: () => never[];
     };
+    /**
+     * Makes each options group label a toggle that selects or deselects all options in that group. With `optionsGroupsStyle="checkbox"` (and `multiple`) the label shows a tri-state checkbox indicator (`none` / `all` / `indeterminate`) reflecting the group's selection.
+     *
+     * @since 5.19.0
+     */
+    optionsGroupsSelectable: BooleanConstructor;
+    /**
+     * Sets the options group label style when `optionsGroupsSelectable` is enabled.
+     *
+     * @values 'checkbox', 'text'
+     * @default 'checkbox'
+     * @since 5.19.0
+     */
+    optionsGroupsStyle: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
     /**
      * Sets maxHeight of options list.
      *
@@ -470,12 +620,54 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
     /**
      * Sets the select all button label.
      *
-     * @default 'Select all options'
+     * @default 'Select all'
      */
     selectAllLabel: {
         type: StringConstructor;
         default: string;
     };
+    /**
+     * Determines what the select all button operates on: all options (`'all'`) or only the currently filtered (search-visible) options (`'filtered'`).
+     *
+     * @values 'all', 'filtered'
+     * @default 'all'
+     * @since 5.19.0
+     */
+    selectAllMode: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Sets the select all button style. With `'checkbox'` (and `multiple`), the button shows a tri-state checkbox indicator (`none` / `all` / `indeterminate`) and toggles between selecting and deselecting.
+     *
+     * @values 'checkbox', 'text'
+     * @default 'checkbox'
+     * @since 5.19.0
+     */
+    selectAllStyle: {
+        type: StringConstructor;
+        default: string;
+        validator: (value: string) => boolean;
+    };
+    /**
+     * Sets the select filtered button label (used with `selectAllMode="filtered"`).
+     *
+     * @since 5.19.0
+     */
+    selectFilteredLabel: {
+        type: StringConstructor;
+        default: string;
+    };
+    /**
+     * Sets the maximum number of options that can be selected. The select all button stays enabled and selects options up to the limit, then toggles to deselect all once the limit is reached. The `selectionLimit` event fires when a user tries to select more options than allowed.
+     *
+     * @since 5.19.0
+     */
+    selectionLimit: {
+        type: NumberConstructor;
+        default: null;
+    };
     /**
      * Sets the selection style.
      *
@@ -565,6 +757,7 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
     onHide?: ((...args: any[]) => any) | undefined;
     onShow?: ((...args: any[]) => any) | undefined;
     onFilterChange?: ((...args: any[]) => any) | undefined;
+    onSelectionLimit?: ((...args: any[]) => any) | undefined;
 }>, {
     search: Search;
     invalid: boolean;
@@ -587,12 +780,22 @@ declare const CMultiSelect: import("vue").DefineComponent<import("vue").ExtractP
     resetSelectionOnOptionsChange: boolean;
     selectionType: string;
     multiple: boolean;
+    optionsGroupsSelectable: boolean;
+    optionsGroupsStyle: string;
     optionsStyle: string;
+    ariaTagDeleteLabel: string;
     selectionTypeCounterText: string;
+    selectionLimit: number;
     allowCreateOptions: boolean;
     ariaCleanerLabel: string;
     ariaIndicatorLabel: string;
+    ariaSearchLabel: string;
+    deselectAllLabel: string;
+    deselectFilteredLabel: string;
     selectAll: boolean;
     selectAllLabel: string;
+    selectAllMode: string;
+    selectAllStyle: string;
+    selectFilteredLabel: string;
 }, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
 export { CMultiSelect };