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.
97 lines (95 loc) • 3.37 kB
TypeScript
/**
* @license
*
* Copyright IBM Corp. 2019, 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 { LitElement } from 'lit-element';
import BXSwitch from './content-switcher-item';
/**
* Navigation direction, associated with key symbols.
*/
export declare const NAVIGATION_DIRECTION: {
Left: number;
ArrowLeft: number;
Right: number;
ArrowRight: number;
};
/**
* Content switcher.
* @element bx-content-switcher
* @fires bx-content-switcher-beingselected
* The custom event fired before a content switcher item is selected upon a user gesture.
* Cancellation of this event stops changing the user-initiated selection.
* @fires bx-content-switcher-selected - The custom event fired after a a content switcher item is selected upon a user gesture.
*/
declare class BXContentSwitcher extends LitElement {
/**
* Handles `mouseover`/`mouseout` events on `<slot>`.
* @param event The event.
*/
private _handleHover;
/**
* @param currentItem The currently selected item.
* @param direction The navigation direction.
* @returns The item to be selected.
*/
protected _getNextItem(currentItem: BXSwitch, direction: number): Element | null;
/**
* Handles `click` event on the top-level element in the shadow DOM.
* @param event The event.
*/
protected _handleClick({ target }: MouseEvent): void;
/**
* Handles `keydown` event on the top-level element in the shadow DOM.
* @param event The event.
*/
protected _handleKeydown({ key }: KeyboardEvent): void;
/**
* Handles user-initiated selection of a content switcher item.
* @param [item] The content switcher item user wants to select.
*/
protected _handleUserInitiatedSelectItem(item: BXSwitch): void;
/**
* Navigates through content switcher items.
* @param direction `-1` to navigate backward, `1` to navigate forward.
*/
protected _navigate(direction: number): void;
/**
* A callback that runs after change in content switcher selection upon user interaction is confirmed.
* @param itemToSelect A content switcher item.
*/
protected _selectionDidChange(itemToSelect: BXSwitch): void;
/**
* The value of the selected item.
*/
value: string;
shouldUpdate(changedProperties: any): boolean;
/**
* A selector that will return content switcher items.
*/
static get selectorItem(): string;
/**
* A selector that will return enabled content switcher items.
*/
static get selectorItemEnabled(): string;
/**
* A selector that will return selected items.
*/
static get selectorItemSelected(): string;
/**
* The name of the custom event fired before a content switcher 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 content switcher item is selected upon a user gesture.
*/
static get eventSelect(): string;
render(): import("lit-element").TemplateResult;
static styles: any;
}
export default BXContentSwitcher;
//# sourceMappingURL=content-switcher.d.ts.map