@carbon/web-components 2.0.0-beta.2 → 2.0.0-beta.4

package/es/components/data-table/table-row.d.ts

@@ -7,9 +7,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { LitElement } from 'lit';
-declare const BXTableRow_base: {
+declare const CDSTableRow_base: {
     new (...args: any[]): {
-        focus(): void;
+        _handles: Set<import("../../globals/internal/handle").default>;
+        connectedCallback(): void;
+        disconnectedCallback(): void;
         accessKey: string;
         readonly accessKeyLabel: string;
         autocapitalize: string;
@@ -311,6 +313,319 @@ declare const BXTableRow_base: {
         nonce?: string | undefined;
         tabIndex: number;
         blur(): void;
+        focus(options?: FocusOptions | undefined): void;
+    };
+    _hostListeners: {
+        [listenerName: string]: {
+            [type: string]: {
+                options?: boolean | AddEventListenerOptions | undefined;
+            };
+        };
+    };
+} & {
+    new (...args: any[]): {
+        focus(): void;
+        accessKey: string;
+        readonly accessKeyLabel: string;
+        autocapitalize: string;
+        dir: string;
+        draggable: boolean;
+        hidden: boolean;
+        inert: boolean;
+        innerText: string;
+        lang: string;
+        readonly offsetHeight: number;
+        readonly offsetLeft: number;
+        readonly offsetParent: Element | null;
+        readonly offsetTop: number;
+        readonly offsetWidth: number;
+        outerText: string;
+        spellcheck: boolean;
+        title: string;
+        translate: boolean;
+        attachInternals(): ElementInternals;
+        click(): void;
+        addEventListener<K_10 extends keyof HTMLElementEventMap>(type: K_10, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_10]) => any, options?: boolean | AddEventListenerOptions | undefined): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions | undefined): void;
+        removeEventListener<K_11 extends keyof HTMLElementEventMap>(type: K_11, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_11]) => any, options?: boolean | EventListenerOptions | undefined): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions | undefined): void;
+        readonly attributes: NamedNodeMap;
+        readonly classList: DOMTokenList;
+        className: string;
+        readonly clientHeight: number;
+        readonly clientLeft: number;
+        readonly clientTop: number;
+        readonly clientWidth: number;
+        id: string;
+        readonly localName: string;
+        readonly namespaceURI: string | null;
+        onfullscreenchange: ((this: Element, ev: Event) => any) | null;
+        onfullscreenerror: ((this: Element, ev: Event) => any) | null;
+        outerHTML: string;
+        readonly ownerDocument: Document;
+        readonly part: DOMTokenList;
+        readonly prefix: string | null;
+        readonly scrollHeight: number;
+        scrollLeft: number;
+        scrollTop: number;
+        readonly scrollWidth: number;
+        readonly shadowRoot: ShadowRoot | null;
+        slot: string;
+        readonly tagName: string;
+        attachShadow(init: ShadowRootInit): ShadowRoot;
+        closest<K_12 extends keyof HTMLElementTagNameMap>(selector: K_12): HTMLElementTagNameMap[K_12] | null;
+        closest<K_13 extends keyof SVGElementTagNameMap>(selector: K_13): SVGElementTagNameMap[K_13] | null;
+        closest<E_3 extends Element = Element>(selectors: string): E_3 | null;
+        getAttribute(qualifiedName: string): string | null;
+        getAttributeNS(namespace: string | null, localName: string): string | null;
+        getAttributeNames(): string[];
+        getAttributeNode(qualifiedName: string): Attr | null;
+        getAttributeNodeNS(namespace: string | null, localName: string): Attr | null;
+        getBoundingClientRect(): DOMRect;
+        getClientRects(): DOMRectList;
+        getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
+        getElementsByTagName<K_14 extends keyof HTMLElementTagNameMap>(qualifiedName: K_14): HTMLCollectionOf<HTMLElementTagNameMap[K_14]>;
+        getElementsByTagName<K_15 extends keyof SVGElementTagNameMap>(qualifiedName: K_15): HTMLCollectionOf<SVGElementTagNameMap[K_15]>;
+        getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
+        getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
+        getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>;
+        hasAttribute(qualifiedName: string): boolean;
+        hasAttributeNS(namespace: string | null, localName: string): boolean;
+        hasAttributes(): boolean;
+        hasPointerCapture(pointerId: number): boolean;
+        insertAdjacentElement(where: InsertPosition, element: Element): Element | null;
+        insertAdjacentHTML(position: InsertPosition, text: string): void;
+        insertAdjacentText(where: InsertPosition, data: string): void;
+        matches(selectors: string): boolean;
+        releasePointerCapture(pointerId: number): void;
+        removeAttribute(qualifiedName: string): void;
+        removeAttributeNS(namespace: string | null, localName: string): void;
+        removeAttributeNode(attr: Attr): Attr;
+        requestFullscreen(options?: FullscreenOptions | undefined): Promise<void>;
+        requestPointerLock(): void;
+        scroll(options?: ScrollToOptions | undefined): void;
+        scroll(x: number, y: number): void;
+        scrollBy(options?: ScrollToOptions | undefined): void;
+        scrollBy(x: number, y: number): void;
+        scrollIntoView(arg?: boolean | ScrollIntoViewOptions | undefined): void;
+        scrollTo(options?: ScrollToOptions | undefined): void;
+        scrollTo(x: number, y: number): void;
+        setAttribute(qualifiedName: string, value: string): void;
+        setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void;
+        setAttributeNode(attr: Attr): Attr | null;
+        setAttributeNodeNS(attr: Attr): Attr | null;
+        setPointerCapture(pointerId: number): void;
+        toggleAttribute(qualifiedName: string, force?: boolean | undefined): boolean;
+        webkitMatchesSelector(selectors: string): boolean;
+        readonly baseURI: string;
+        readonly childNodes: NodeListOf<ChildNode>;
+        readonly firstChild: ChildNode | null;
+        readonly isConnected: boolean;
+        readonly lastChild: ChildNode | null;
+        readonly nextSibling: ChildNode | null;
+        readonly nodeName: string;
+        readonly nodeType: number;
+        nodeValue: string | null;
+        readonly parentElement: HTMLElement | null;
+        readonly parentNode: ParentNode | null;
+        readonly previousSibling: ChildNode | null;
+        textContent: string | null;
+        appendChild<T extends Node>(node: T): T;
+        cloneNode(deep?: boolean | undefined): Node;
+        compareDocumentPosition(other: Node): number;
+        contains(other: Node | null): boolean;
+        getRootNode(options?: GetRootNodeOptions | undefined): Node;
+        hasChildNodes(): boolean;
+        insertBefore<T_4 extends Node>(node: T_4, child: Node | null): T_4;
+        isDefaultNamespace(namespace: string | null): boolean;
+        isEqualNode(otherNode: Node | null): boolean;
+        isSameNode(otherNode: Node | null): boolean;
+        lookupNamespaceURI(prefix: string | null): string | null;
+        lookupPrefix(namespace: string | null): string | null;
+        normalize(): void;
+        removeChild<T_2 extends Node>(child: T_2): T_2;
+        replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
+        readonly ATTRIBUTE_NODE: number;
+        readonly CDATA_SECTION_NODE: number;
+        readonly COMMENT_NODE: number;
+        readonly DOCUMENT_FRAGMENT_NODE: number;
+        readonly DOCUMENT_NODE: number;
+        readonly DOCUMENT_POSITION_CONTAINED_BY: number;
+        readonly DOCUMENT_POSITION_CONTAINS: number;
+        readonly DOCUMENT_POSITION_DISCONNECTED: number;
+        readonly DOCUMENT_POSITION_FOLLOWING: number;
+        readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
+        readonly DOCUMENT_POSITION_PRECEDING: number;
+        readonly DOCUMENT_TYPE_NODE: number;
+        readonly ELEMENT_NODE: number;
+        readonly ENTITY_NODE: number;
+        readonly ENTITY_REFERENCE_NODE: number;
+        readonly NOTATION_NODE: number;
+        readonly PROCESSING_INSTRUCTION_NODE: number;
+        readonly TEXT_NODE: number;
+        dispatchEvent(event: Event): boolean;
+        ariaAtomic: string | null;
+        ariaAutoComplete: string | null;
+        ariaBusy: string | null;
+        ariaChecked: string | null;
+        ariaColCount: string | null;
+        ariaColIndex: string | null;
+        ariaColSpan: string | null;
+        ariaCurrent: string | null;
+        ariaDisabled: string | null;
+        ariaExpanded: string | null;
+        ariaHasPopup: string | null;
+        ariaHidden: string | null;
+        ariaKeyShortcuts: string | null;
+        ariaLabel: string | null;
+        ariaLevel: string | null;
+        ariaLive: string | null;
+        ariaModal: string | null;
+        ariaMultiLine: string | null;
+        ariaMultiSelectable: string | null;
+        ariaOrientation: string | null;
+        ariaPlaceholder: string | null;
+        ariaPosInSet: string | null;
+        ariaPressed: string | null;
+        ariaReadOnly: string | null;
+        ariaRequired: string | null;
+        ariaRoleDescription: string | null;
+        ariaRowCount: string | null;
+        ariaRowIndex: string | null;
+        ariaRowSpan: string | null;
+        ariaSelected: string | null;
+        ariaSetSize: string | null;
+        ariaSort: string | null;
+        ariaValueMax: string | null;
+        ariaValueMin: string | null;
+        ariaValueNow: string | null;
+        ariaValueText: string | null;
+        animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions | undefined): Animation;
+        getAnimations(options?: GetAnimationsOptions | undefined): Animation[];
+        after(...nodes: (string | Node)[]): void;
+        before(...nodes: (string | Node)[]): void;
+        remove(): void;
+        replaceWith(...nodes: (string | Node)[]): void;
+        innerHTML: string;
+        readonly nextElementSibling: Element | null;
+        readonly previousElementSibling: Element | null;
+        readonly childElementCount: number;
+        readonly children: HTMLCollection;
+        readonly firstElementChild: Element | null;
+        readonly lastElementChild: Element | null;
+        append(...nodes: (string | Node)[]): void;
+        prepend(...nodes: (string | Node)[]): void;
+        querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6] | null;
+        querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7] | null;
+        querySelector<E_1 extends Element = Element>(selectors: string): E_1 | null;
+        querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
+        querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
+        querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
+        replaceChildren(...nodes: (string | Node)[]): void;
+        readonly assignedSlot: HTMLSlotElement | null;
+        oncopy: ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any) | null;
+        oncut: ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any) | null;
+        onpaste: ((this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any) | null;
+        readonly style: CSSStyleDeclaration;
+        contentEditable: string;
+        enterKeyHint: string;
+        inputMode: string;
+        readonly isContentEditable: boolean;
+        onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null;
+        onauxclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oncontextmenu: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null;
+        ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onended: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onerror: OnErrorEventHandler;
+        onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null;
+        onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null;
+        ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null;
+        onload: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null;
+        onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null;
+        onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any) | null;
+        onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null;
+        onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null;
+        onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null;
+        onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontoggle: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined;
+        ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null;
+        onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null;
+        onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null;
+        autofocus: boolean;
+        readonly dataset: DOMStringMap;
+        nonce?: string | undefined;
+        tabIndex: number;
+        blur(): void;
     };
 } & typeof LitElement;
 /**
@@ -323,17 +638,44 @@ declare const BXTableRow_base: {
  *   The custom event fired before this row is selected/unselected upon a user gesture.
  *   Cancellation of this event stops the user-initiated change in selection.
  */
-declare class BXTableRow extends BXTableRow_base {
+declare class CDSTableRow extends CDSTableRow_base {
+    /**
+     * Handles `click` event on the radio button.
+     *
+     * @param event The event.
+     */
+    private _handleClickSelectionRadio;
     /**
      * Handles `click` event on the check box.
      *
      * @param event The event.
      */
     private _handleClickSelectionCheckbox;
+    /**
+     * Handles `click` event on the expando button.
+     */
+    private _handleClickExpando;
+    /**
+     * Handles `mouseover`/`mouseout` event handler on this element.
+     *
+     * @param event The event.
+     */
+    private _handleMouseOverOut;
+    /**
+     * Handles user-initiated toggle request of the expando button in this table row.
+     *
+     * @param expanded The new expanded state.
+     */
+    _handleUserInitiatedToggleExpando(expanded?: boolean): void;
+    protected _renderExpandButton(): import("lit-html").TemplateResult<1>;
     /**
      * @returns The first set of table cells.
      */
     protected _renderFirstCells(): import("lit-html").TemplateResult<1> | undefined;
+    /**
+     * `true` if this table should support batch expansion
+     */
+    batchExpansion: boolean;
     /**
      * `true` if this table row should be disabled.
      */
@@ -345,6 +687,31 @@ declare class BXTableRow extends BXTableRow_base {
      * @private
      */
     even: boolean;
+    /**
+     * `true` if this table row can be expanded to show content underneath
+     *
+     * @private
+     */
+    expandable: boolean;
+    /**
+     * `true` when the table row expanded is showing
+     *
+     * @private
+     */
+    expanded: boolean;
+    /**
+     * `true` if this table row should be filtered out.
+     */
+    filtered: boolean;
+    /**
+     * Specify whether the checkbox should be present in the DOM,
+     * but invisible and uninteractable.
+     */
+    hideCheckbox: boolean;
+    /**
+     * `true` if the table row should be highlighted.
+     */
+    highlighted: boolean;
     /**
      * `true` if this table row is placed at an odd position in parent `<cds-table-body>`.
      * `<cds-table-body>` sets this property, _only_ in zebra stripe mode.
@@ -352,6 +719,16 @@ declare class BXTableRow extends BXTableRow_base {
      * @private
      */
     odd: boolean;
+    /**
+     * Specify whether the overflow menu (if it exists) should be shown always, or only on hover
+     */
+    overflowMenuOnHover: boolean;
+    /**
+     * Specify whether the control should be a radio button or inline checkbox
+     *
+     * @private
+     */
+    radio: boolean;
     /**
      * `true` if this table row should be selected.
      */
@@ -369,19 +746,50 @@ declare class BXTableRow extends BXTableRow_base {
      * The `value` attribute for the `<input>` for selection.
      */
     selectionValue: string;
+    /**
+     * TODO: Uncomment when Carbon fully implements sticky header
+     * Specify whether the header should be sticky.
+     * Still experimental: may not work with every combination of table props
+     */
     connectedCallback(): void;
+    updated(changedProperties: any): void;
     render(): import("lit-html").TemplateResult<1>;
+    /**
+     * The name of the custom event fired after this radio button changes its checked state.
+     */
+    static get eventRadioChange(): string;
+    /**
+     * The name of the custom event fired after this radio button changes its checked state.
+     */
+    static get eventCheckboxChange(): string;
     /**
      * The name of the custom event fired before this row is selected/unselected upon a user gesture.
      * Cancellation of this event stops the user-initiated change in selection.
      */
     static get eventBeforeChangeSelection(): string;
     /**
-     * The CSS selector to find the table.
+     * A selector that will return the parent table
      */
     static get selectorTable(): string;
+    /**
+     * The CSS selector to find the overflow menu on the table cell
+     */
+    static get selectorTableCellOverflowMenu(): string;
+    /**
+     * A selector that will return the corresponding expanded row.
+     */
+    static get selectorExpandedRow(): string;
+    /**
+     * The name of the custom event fired before the expanded state this row is being toggled upon a user gesture.
+     * Cancellation of this event stops the user-initiated action of toggling the expanded state.
+     */
+    static get eventBeforeExpandoToggle(): string;
+    /**
+     * The name of the custom event fired after the expanded state this row is toggled upon a user gesture.
+     */
+    static get eventExpandoToggle(): string;
     static styles: any;
 }
-export default BXTableRow;
+export default CDSTableRow;
 
 //# sourceMappingURL=table-row.d.ts.map

package/es/components/data-table/table-row.d.ts.map

@@ -1 +1 @@
-{"version":3,"sources":["components/data-table/table-row.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAQ,MAAM,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAMvC;;;;;;;;;GASG;AACH,cACM,UAAW,SAAQ,eAAsB;IAC7C;;;;OAIG;IACH,OAAO,CAAC,6BAA6B;IAoBrC;;OAEG;IACH,SAAS,CAAC,iBAAiB;IAmC3B;;OAEG;IAEH,QAAQ,UAAS;IAEjB;;;;;OAKG;IAEH,IAAI,UAAS;IAEb;;;;;OAKG;IAEH,GAAG,UAAS;IAEZ;;OAEG;IAEH,QAAQ,UAAS;IAEjB;;OAEG;IAEH,cAAc,SAAM;IAEpB;;;OAGG;IAEH,aAAa,SAAM;IAEnB;;OAEG;IAEH,cAAc,SAAM;IAEpB,iBAAiB;IAOjB,MAAM;IAIN;;;OAGG;IACH,MAAM,KAAK,0BAA0B,WAEpC;IAED;;OAEG;IACH,MAAM,KAAK,aAAa,WAEvB;IAED,MAAM,CAAC,MAAM,MAAU;CACxB;AAED,eAAe,UAAU,CAAC","file":"table-row.d.ts","sourcesContent":["/**\n * @license\n *\n * Copyright IBM Corp. 2019, 2023\n *\n * This source code is licensed under the Apache-2.0 license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport { LitElement, html } from 'lit';\nimport { property, customElement } from 'lit/decorators.js';\nimport { prefix } from '../../globals/settings';\nimport FocusMixin from '../../globals/mixins/focus';\nimport styles from './data-table.scss';\n\n/**\n * Data table row.\n *\n * @element cds-table-row\n * @csspart selection-container The container of the checkbox.\n * @csspart selection The checkbox.\n * @fires cds-table-row-change-selection\n *   The custom event fired before this row is selected/unselected upon a user gesture.\n *   Cancellation of this event stops the user-initiated change in selection.\n */\n@customElement(`${prefix}-table-row`)\nclass BXTableRow extends FocusMixin(LitElement) {\n  /**\n   * Handles `click` event on the check box.\n   *\n   * @param event The event.\n   */\n  private _handleClickSelectionCheckbox(event: Event) {\n    const selected = (event.target as HTMLInputElement).checked;\n    const init = {\n      bubbles: true,\n      cancelable: true,\n      composed: true,\n      detail: {\n        selected,\n      },\n    };\n    const constructor = this.constructor as typeof BXTableRow;\n    if (\n      this.dispatchEvent(\n        new CustomEvent(constructor.eventBeforeChangeSelection, init)\n      )\n    ) {\n      this.selected = selected;\n    }\n  }\n\n  /**\n   * @returns The first set of table cells.\n   */\n  protected _renderFirstCells() {\n    const {\n      disabled,\n      selected,\n      selectionLabel,\n      selectionName,\n      selectionValue,\n    } = this;\n    // Using `@click` instead of `@change` to support `.preventDefault()`\n    return !selectionName\n      ? undefined\n      : html`\n          <div\n            part=\"selection-container\"\n            class=\"${prefix}--table-column-checkbox\">\n            ${html`\n              <input\n                id=\"selection\"\n                part=\"selection\"\n                class=\"${prefix}--checkbox\"\n                type=\"checkbox\"\n                value=\"${selectionValue}\"\n                name=\"${selectionName}\"\n                ?disabled=\"${disabled}\"\n                .checked=${selected}\n                @click=${this._handleClickSelectionCheckbox} />\n              <label\n                for=\"selection\"\n                class=\"${prefix}--checkbox-label\"\n                aria-label=\"${selectionLabel}\"></label>\n            `}\n          </div>\n        `;\n  }\n\n  /**\n   * `true` if this table row should be disabled.\n   */\n  @property({ type: Boolean, reflect: true })\n  disabled = false;\n\n  /**\n   * `true` if this table row is placed at an even position in parent `<cds-table-body>`.\n   * `<cds-table-body>` sets this property, _only_ in zebra stripe mode.\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  even = false;\n\n  /**\n   * `true` if this table row is placed at an odd position in parent `<cds-table-body>`.\n   * `<cds-table-body>` sets this property, _only_ in zebra stripe mode.\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  odd = false;\n\n  /**\n   * `true` if this table row should be selected.\n   */\n  @property({ type: Boolean, reflect: true })\n  selected = false;\n\n  /**\n   * The `aria-label` attribute for the `<label>` for selection.\n   */\n  @property({ attribute: 'selection-label' })\n  selectionLabel = '';\n\n  /**\n   * The `name` attribute for the `<input>` for selection.\n   * If present, this table row will be a selectable one.\n   */\n  @property({ attribute: 'selection-name' })\n  selectionName = '';\n\n  /**\n   * The `value` attribute for the `<input>` for selection.\n   */\n  @property({ attribute: 'selection-value' })\n  selectionValue = '';\n\n  connectedCallback() {\n    if (!this.hasAttribute('role')) {\n      this.setAttribute('role', 'row');\n    }\n    super.connectedCallback();\n  }\n\n  render() {\n    return html` ${this._renderFirstCells()}<slot></slot> `;\n  }\n\n  /**\n   * The name of the custom event fired before this row is selected/unselected upon a user gesture.\n   * Cancellation of this event stops the user-initiated change in selection.\n   */\n  static get eventBeforeChangeSelection() {\n    return `${prefix}-table-row-change-selection`;\n  }\n\n  /**\n   * The CSS selector to find the table.\n   */\n  static get selectorTable() {\n    return `${prefix}-table`;\n  }\n\n  static styles = styles;\n}\n\nexport default BXTableRow;\n"]}
+{"version":3,"sources":["components/data-table/table-row.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAQ,MAAM,KAAK,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAYvC;;;;;;;;;GASG;AACH,cACM,WAAY,SAAQ,gBAAyC;IACjE;;;;OAIG;IAGH,OAAO,CAAC,0BAA0B;IA0BlC;;;;OAIG;IAGH,OAAO,CAAC,6BAA6B;IA0BrC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAI3B;;;;OAIG;IAIH,OAAO,CAAC,mBAAmB;IAoB3B;;;;OAIG;IACH,iCAAiC,CAAC,QAAQ,UAAiB;IA2B3D,SAAS,CAAC,mBAAmB;IAa7B;;OAEG;IACH,SAAS,CAAC,iBAAiB;IA6B3B;;OAEG;IAEH,cAAc,UAAS;IAEvB;;OAEG;IAEH,QAAQ,UAAS;IAEjB;;;;;OAKG;IAEH,IAAI,UAAS;IAEb;;;;OAIG;IAEH,UAAU,UAAS;IAEnB;;;;OAIG;IAEH,QAAQ,UAAS;IAEjB;;OAEG;IAEH,QAAQ,UAAS;IAEjB;;;OAGG;IAEH,YAAY,UAAS;IAErB;;OAEG;IAEH,WAAW,UAAS;IAEpB;;;;;OAKG;IAEH,GAAG,UAAS;IAEZ;;OAEG;IAMH,mBAAmB,UAAS;IAE5B;;;;OAIG;IAEH,KAAK,UAAS;IAEd;;OAEG;IAEH,QAAQ,UAAS;IAEjB;;OAEG;IAEH,cAAc,SAAM;IAEpB;;;OAGG;IAEH,aAAa,SAAM;IAEnB;;OAEG;IAEH,cAAc,SAAM;IAEpB;;;;OAIG;IAIH,iBAAiB;IAOjB,OAAO,CAAC,iBAAiB,KAAA;IAkBzB,MAAM;IAaN;;OAEG;IACH,MAAM,KAAK,gBAAgB,WAE1B;IAED;;OAEG;IACH,MAAM,KAAK,mBAAmB,WAE7B;IAED;;;OAGG;IACH,MAAM,KAAK,0BAA0B,WAEpC;IAED;;OAEG;IACH,MAAM,KAAK,aAAa,WAEvB;IAED;;OAEG;IACH,MAAM,KAAK,6BAA6B,WAEvC;IAED;;OAEG;IACH,MAAM,KAAK,mBAAmB,WAE7B;IAED;;;OAGG;IACH,MAAM,KAAK,wBAAwB,WAElC;IAED;;OAEG;IACH,MAAM,KAAK,kBAAkB,WAE5B;IAED,MAAM,CAAC,MAAM,MAAU;CACxB;AAED,eAAe,WAAW,CAAC","file":"table-row.d.ts","sourcesContent":["/**\n * @license\n *\n * Copyright IBM Corp. 2019, 2023\n *\n * This source code is licensed under the Apache-2.0 license found in the\n * LICENSE file in the root directory of this source tree.\n */\n\nimport { LitElement, html } from 'lit';\nimport { property, customElement } from 'lit/decorators.js';\nimport { prefix } from '../../globals/settings';\nimport ChevronRight16 from '@carbon/web-components/es/icons/chevron--right/16';\nimport FocusMixin from '../../globals/mixins/focus';\nimport styles from './data-table.scss';\n\nimport HostListener from '../../globals/decorators/host-listener';\nimport HostListenerMixin from '../../globals/mixins/host-listener';\nimport CDSTableExpandedRow from './table-expanded-row';\nimport CDSTableCell from './table-cell';\n\n/**\n * Data table row.\n *\n * @element cds-table-row\n * @csspart selection-container The container of the checkbox.\n * @csspart selection The checkbox.\n * @fires cds-table-row-change-selection\n *   The custom event fired before this row is selected/unselected upon a user gesture.\n *   Cancellation of this event stops the user-initiated change in selection.\n */\n@customElement(`${prefix}-table-row`)\nclass CDSTableRow extends HostListenerMixin(FocusMixin(LitElement)) {\n  /**\n   * Handles `click` event on the radio button.\n   *\n   * @param event The event.\n   */\n  @HostListener('eventRadioChange')\n  // @ts-ignore\n  private _handleClickSelectionRadio(event: CustomEvent) {\n    const { detail } = event;\n    const selected = detail.checked;\n    const init = {\n      bubbles: true,\n      cancelable: true,\n      composed: true,\n      detail: {\n        selected,\n      },\n    };\n    const constructor = this.constructor as typeof CDSTableRow;\n    if (\n      this.dispatchEvent(\n        new CustomEvent(constructor.eventBeforeChangeSelection, init)\n      )\n    ) {\n      this.selected = selected;\n      const { selectorExpandedRow } = this.constructor as typeof CDSTableRow;\n\n      if (this.nextElementSibling?.matches(selectorExpandedRow)) {\n        (this.nextElementSibling as CDSTableExpandedRow).selected = selected;\n      }\n    }\n  }\n\n  /**\n   * Handles `click` event on the check box.\n   *\n   * @param event The event.\n   */\n  @HostListener('eventCheckboxChange')\n  // @ts-ignore\n  private _handleClickSelectionCheckbox(event: CustomEvent) {\n    const { detail } = event;\n    const selected = detail.checked;\n    const init = {\n      bubbles: true,\n      cancelable: true,\n      composed: true,\n      detail: {\n        selected,\n      },\n    };\n    const constructor = this.constructor as typeof CDSTableRow;\n    if (\n      this.dispatchEvent(\n        new CustomEvent(constructor.eventBeforeChangeSelection, init)\n      )\n    ) {\n      this.selected = selected;\n      const { selectorExpandedRow } = this.constructor as typeof CDSTableRow;\n\n      if (this.nextElementSibling?.matches(selectorExpandedRow)) {\n        (this.nextElementSibling as CDSTableExpandedRow).selected = selected;\n      }\n    }\n  }\n\n  /**\n   * Handles `click` event on the expando button.\n   */\n  private _handleClickExpando() {\n    this._handleUserInitiatedToggleExpando();\n  }\n\n  /**\n   * Handles `mouseover`/`mouseout` event handler on this element.\n   *\n   * @param event The event.\n   */\n  @HostListener('mouseover')\n  @HostListener('mouseout')\n  // @ts-ignore: The decorator refers to this method but TS thinks this method is not referred to\n  private _handleMouseOverOut(event: MouseEvent) {\n    const { selectorExpandedRow, selectorTableCellOverflowMenu } = this\n      .constructor as typeof CDSTableRow;\n    const { nextElementSibling } = this;\n    if (nextElementSibling?.matches(selectorExpandedRow)) {\n      (nextElementSibling as CDSTableExpandedRow).highlighted =\n        event.type === 'mouseover';\n    }\n    if (this.overflowMenuOnHover) {\n      const overflowMenu = this.querySelector(selectorTableCellOverflowMenu);\n      const parentCell = overflowMenu?.parentElement;\n\n      if (event.type === 'mouseout') {\n        (parentCell as CDSTableCell).overflowMenuOnHover = true;\n      } else {\n        (parentCell as CDSTableCell).overflowMenuOnHover = false;\n      }\n    }\n  }\n\n  /**\n   * Handles user-initiated toggle request of the expando button in this table row.\n   *\n   * @param expanded The new expanded state.\n   */\n  _handleUserInitiatedToggleExpando(expanded = !this.expanded) {\n    const init = {\n      bubbles: true,\n      cancelable: true,\n      composed: true,\n      detail: {\n        expanded,\n      },\n    };\n    if (\n      this.dispatchEvent(\n        new CustomEvent(\n          (this.constructor as typeof CDSTableRow).eventBeforeExpandoToggle,\n          init\n        )\n      )\n    ) {\n      this.expanded = expanded;\n      this.dispatchEvent(\n        new CustomEvent(\n          (this.constructor as typeof CDSTableRow).eventExpandoToggle,\n          init\n        )\n      );\n    }\n  }\n\n  protected _renderExpandButton() {\n    const { _handleClickExpando: handleClickExpando } = this;\n    return html`\n      <div class=\"${prefix}--table-expand\">\n        <button\n          class=\"${prefix}--table-expand__button\"\n          @click=\"${handleClickExpando}\">\n          ${ChevronRight16({ class: `${prefix}--table-expand__svg` })}\n        </button>\n      </div>\n    `;\n  }\n\n  /**\n   * @returns The first set of table cells.\n   */\n  protected _renderFirstCells() {\n    const {\n      disabled,\n      hideCheckbox,\n      radio,\n      selected,\n      selectionLabel,\n      selectionName,\n      selectionValue,\n    } = this;\n    return !selectionName\n      ? undefined\n      : html`\n          <div class=\"${prefix}--table-column-checkbox\">\n            ${radio\n              ? html`<cds-radio-button data-table></cds-radio-button>`\n              : html`<cds-checkbox\n                  hide-label\n                  ?hide-checkbox=\"${hideCheckbox}\"\n                  label-text=\"${selectionLabel}\"\n                  name=${selectionName}\n                  data-table\n                  ?disabled=${disabled}\n                  ?checked=${selected}\n                  value=${selectionValue}></cds-checkbox> `}\n          </div>\n        `;\n  }\n\n  /**\n   * `true` if this table should support batch expansion\n   */\n  @property({ type: Boolean, reflect: true, attribute: 'batch-expansion' })\n  batchExpansion = false;\n\n  /**\n   * `true` if this table row should be disabled.\n   */\n  @property({ type: Boolean, reflect: true })\n  disabled = false;\n\n  /**\n   * `true` if this table row is placed at an even position in parent `<cds-table-body>`.\n   * `<cds-table-body>` sets this property, _only_ in zebra stripe mode.\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  even = false;\n\n  /**\n   * `true` if this table row can be expanded to show content underneath\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  expandable = false;\n\n  /**\n   * `true` when the table row expanded is showing\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  expanded = false;\n\n  /**\n   * `true` if this table row should be filtered out.\n   */\n  @property({ type: Boolean, reflect: true })\n  filtered = false;\n\n  /**\n   * Specify whether the checkbox should be present in the DOM,\n   * but invisible and uninteractable.\n   */\n  @property({ type: Boolean, reflect: true, attribute: 'hide-checkbox' })\n  hideCheckbox = false;\n\n  /**\n   * `true` if the table row should be highlighted.\n   */\n  @property({ type: Boolean, reflect: true })\n  highlighted = false;\n\n  /**\n   * `true` if this table row is placed at an odd position in parent `<cds-table-body>`.\n   * `<cds-table-body>` sets this property, _only_ in zebra stripe mode.\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  odd = false;\n\n  /**\n   * Specify whether the overflow menu (if it exists) should be shown always, or only on hover\n   */\n  @property({\n    type: Boolean,\n    reflect: true,\n    attribute: 'overflow-menu-on-hover',\n  })\n  overflowMenuOnHover = false;\n\n  /**\n   * Specify whether the control should be a radio button or inline checkbox\n   *\n   * @private\n   */\n  @property({ type: Boolean, reflect: true })\n  radio = false;\n\n  /**\n   * `true` if this table row should be selected.\n   */\n  @property({ type: Boolean, reflect: true })\n  selected = false;\n\n  /**\n   * The `aria-label` attribute for the `<label>` for selection.\n   */\n  @property({ attribute: 'selection-label' })\n  selectionLabel = '';\n\n  /**\n   * The `name` attribute for the `<input>` for selection.\n   * If present, this table row will be a selectable one.\n   */\n  @property({ attribute: 'selection-name' })\n  selectionName = '';\n\n  /**\n   * The `value` attribute for the `<input>` for selection.\n   */\n  @property({ attribute: 'selection-value' })\n  selectionValue = '';\n\n  /**\n   * TODO: Uncomment when Carbon fully implements sticky header\n   * Specify whether the header should be sticky.\n   * Still experimental: may not work with every combination of table props\n   */\n  // @property({ type: Boolean, reflect: true, attribute: 'sticky-header' })\n  // stickyHeader = false;\n\n  connectedCallback() {\n    if (!this.hasAttribute('role')) {\n      this.setAttribute('role', 'row');\n    }\n    super.connectedCallback();\n  }\n\n  updated(changedProperties) {\n    if (changedProperties.has('expanded')) {\n      const { selectorExpandedRow } = this.constructor as typeof CDSTableRow;\n      const { expanded, nextElementSibling } = this;\n      if (nextElementSibling?.matches(selectorExpandedRow)) {\n        (nextElementSibling as CDSTableExpandedRow).expanded = expanded;\n      }\n    }\n\n    if (changedProperties.has('highlighted')) {\n      const { selectorExpandedRow } = this.constructor as typeof CDSTableRow;\n      const { highlighted, nextElementSibling } = this;\n      if (nextElementSibling?.matches(selectorExpandedRow)) {\n        (nextElementSibling as CDSTableExpandedRow).highlighted = highlighted;\n      }\n    }\n  }\n\n  render() {\n    if (this.selectionName) {\n      this.closest(\n        (this.constructor as typeof CDSTableRow).selectorTable\n      )?.setAttribute('is-selectable', '');\n    }\n    return html`\n      ${this.expandable ? this._renderExpandButton() : ''}\n      ${this._renderFirstCells()}\n      <slot></slot>\n    `;\n  }\n\n  /**\n   * The name of the custom event fired after this radio button changes its checked state.\n   */\n  static get eventRadioChange() {\n    return `${prefix}-radio-button-changed`;\n  }\n\n  /**\n   * The name of the custom event fired after this radio button changes its checked state.\n   */\n  static get eventCheckboxChange() {\n    return `${prefix}-checkbox-changed`;\n  }\n\n  /**\n   * The name of the custom event fired before this row is selected/unselected upon a user gesture.\n   * Cancellation of this event stops the user-initiated change in selection.\n   */\n  static get eventBeforeChangeSelection() {\n    return `${prefix}-table-row-change-selection`;\n  }\n\n  /**\n   * A selector that will return the parent table\n   */\n  static get selectorTable() {\n    return `${prefix}-table`;\n  }\n\n  /**\n   * The CSS selector to find the overflow menu on the table cell\n   */\n  static get selectorTableCellOverflowMenu() {\n    return `${prefix}-table-cell ${prefix}-overflow-menu`;\n  }\n\n  /**\n   * A selector that will return the corresponding expanded row.\n   */\n  static get selectorExpandedRow() {\n    return `${prefix}-table-expanded-row`;\n  }\n\n  /**\n   * The name of the custom event fired before the expanded state this row is being toggled upon a user gesture.\n   * Cancellation of this event stops the user-initiated action of toggling the expanded state.\n   */\n  static get eventBeforeExpandoToggle() {\n    return `${prefix}-table-row-expando-beingtoggled`;\n  }\n\n  /**\n   * The name of the custom event fired after the expanded state this row is toggled upon a user gesture.\n   */\n  static get eventExpandoToggle() {\n    return `${prefix}-table-row-expando-toggled`;\n  }\n\n  static styles = styles;\n}\n\nexport default CDSTableRow;\n"]}