carbon-custom-elements
Version:
A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.
83 lines (81 loc) • 3.06 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 2020
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import BXDropdown from '../dropdown/dropdown';
import BXMultiSelectItem from './multi-select-item';
export { DROPDOWN_COLOR_SCHEME, DROPDOWN_SIZE, DROPDOWN_TYPE } from '../dropdown/dropdown';
/**
* Multi select.
* @element bx-multi-select
* @fires bx-multi-select-beingselected
* The custom event fired before a multi select item is selected upon a user gesture.
* Cancellation of this event stops changing the user-initiated selection.
* @fires bx-multi-select-selected - The custom event fired after a a multi select item is selected upon a user gesture.
*/
declare class BXMultiSelect extends BXDropdown {
/**
* The count of selected items.
*/
private _selectedItemsCount;
/**
* The selection button.
*/
private _selectionButtonNode;
/**
* The trigger button.
*/
private _triggerNode;
protected _selectionShouldChange(itemToSelect?: BXMultiSelectItem): boolean;
protected _selectionDidChange(itemToSelect?: BXMultiSelectItem): void;
protected _handleClickInner(event: MouseEvent): void;
protected _handleKeydownInner(event: KeyboardEvent): void;
protected _renderPrecedingTriggerContent(): import("lit-element").TemplateResult | undefined;
/**
* The `aria-label` attribute for the icon to clear selection.
*/
clearSelectionLabel: string;
/**
* An assistive text for screen reader to announce, telling that an item is unselected.
*/
unselectedItemAssistiveText: string;
/**
* An assistive text for screen reader to announce, telling that all items are unselected.
*/
unselectedAllAssistiveText: string;
shouldUpdate(changedProperties: any): boolean;
/**
* A selector to ignore the `click` events from.
* Primary for the checkbox label where the `click` event will happen from the associated check box.
*/
private static get selectorIgnoreClickInner();
/**
* A selector that will return highlighted items.
*/
static get selectorItemHighlighted(): string;
/**
* A selector that will return multi select items.
* We use a separate property from `.itemTagName` due to the nature in difference of tag name vs. selector.
*/
static get selectorItem(): string;
/**
* A selector that will return selected items.
*/
static get selectorItemSelected(): string;
/**
* The name of the custom event fired before a multi select item is selected upon a user gesture.
* Cancellation of this event stops changing the user-initiated selection.
*/
static get eventBeforeSelect(): string;
/**
* The name of the custom event fired after a a multi select item is selected upon a user gesture.
*/
static get eventSelect(): string;
static styles: any;
}
export default BXMultiSelect;
//# sourceMappingURL=multi-select.d.ts.map