index.api.md

API Report File for "@angular/aria_grid"

Do not edit this file. It is a report generated by API Extractor.

import * as _angular_cdk_bidi from '@angular/cdk/bidi';
import * as _angular_core from '@angular/core';
import { ElementRef } from '@angular/core';
import { Signal } from '@angular/core';

// @public
export class Grid {
    constructor();
    readonly colWrap: _angular_core.InputSignal<"continuous" | "loop" | "nowrap">;
    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly element: HTMLElement;
    readonly enableSelection: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly focusMode: _angular_core.InputSignal<"roving" | "activedescendant">;
    readonly multi: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly _pattern: GridPattern;
    readonly rowWrap: _angular_core.InputSignal<"continuous" | "loop" | "nowrap">;
    readonly selectionMode: _angular_core.InputSignal<"follow" | "explicit">;
    readonly softDisabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
    // (undocumented)
    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<Grid, "[ngGrid]", ["ngGrid"], { "enableSelection": { "alias": "enableSelection"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "softDisabled": { "alias": "softDisabled"; "required": false; "isSignal": true; }; "focusMode": { "alias": "focusMode"; "required": false; "isSignal": true; }; "rowWrap": { "alias": "rowWrap"; "required": false; "isSignal": true; }; "colWrap": { "alias": "colWrap"; "required": false; "isSignal": true; }; "multi": { "alias": "multi"; "required": false; "isSignal": true; }; "selectionMode": { "alias": "selectionMode"; "required": false; "isSignal": true; }; }, {}, ["_rows"], never, true, never>;
    // (undocumented)
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<Grid, never>;
}

// @public
export class GridCell {
    constructor();
    readonly active: Signal<boolean>;
    readonly colIndex: _angular_core.InputSignal<number | undefined>;
    readonly colSpan: _angular_core.InputSignal<number>;
    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly element: HTMLElement;
    readonly id: _angular_core.InputSignal<string>;
    readonly orientation: _angular_core.InputSignal<"vertical" | "horizontal">;
    readonly _pattern: GridCellPattern;
    readonly role: _angular_core.InputSignal<"gridcell" | "columnheader" | "rowheader">;
    readonly rowIndex: _angular_core.InputSignal<number | undefined>;
    readonly rowSpan: _angular_core.InputSignal<number>;
    readonly selectable: _angular_core.InputSignal<boolean>;
    readonly selected: _angular_core.ModelSignal<boolean>;
    protected readonly _tabIndex: Signal<number>;
    readonly tabindex: _angular_core.InputSignal<number | undefined>;
    readonly textDirection: _angular_core.WritableSignal<_angular_cdk_bidi.Direction>;
    readonly wrap: _angular_core.InputSignalWithTransform<boolean, unknown>;
    // (undocumented)
    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridCell, "[ngGridCell]", ["ngGridCell"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "role": { "alias": "role"; "required": false; "isSignal": true; }; "rowSpan": { "alias": "rowSpan"; "required": false; "isSignal": true; }; "colSpan": { "alias": "colSpan"; "required": false; "isSignal": true; }; "rowIndex": { "alias": "rowIndex"; "required": false; "isSignal": true; }; "colIndex": { "alias": "colIndex"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "selected": { "alias": "selected"; "required": false; "isSignal": true; }; "selectable": { "alias": "selectable"; "required": false; "isSignal": true; }; "orientation": { "alias": "orientation"; "required": false; "isSignal": true; }; "wrap": { "alias": "wrap"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; }, { "selected": "selectedChange"; }, ["_widgets"], never, true, never>;
    // (undocumented)
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridCell, never>;
}

// @public
export class GridCellWidget {
    constructor();
    activate(): void;
    readonly activated: _angular_core.OutputEmitterRef<KeyboardEvent | FocusEvent | undefined>;
    readonly active: Signal<boolean>;
    deactivate(): void;
    readonly deactivated: _angular_core.OutputEmitterRef<KeyboardEvent | FocusEvent | undefined>;
    readonly disabled: _angular_core.InputSignalWithTransform<boolean, unknown>;
    readonly element: HTMLElement;
    readonly focusTarget: _angular_core.InputSignal<ElementRef<any> | HTMLElement | undefined>;
    readonly id: _angular_core.InputSignal<string>;
    get isActivated(): Signal<boolean>;
    readonly _pattern: GridCellWidgetPattern;
    protected readonly _tabIndex: Signal<number>;
    readonly tabindex: _angular_core.InputSignal<number | undefined>;
    readonly widgetType: _angular_core.InputSignal<"simple" | "complex" | "editable">;
    // (undocumented)
    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridCellWidget, "[ngGridCellWidget]", ["ngGridCellWidget"], { "id": { "alias": "id"; "required": false; "isSignal": true; }; "widgetType": { "alias": "widgetType"; "required": false; "isSignal": true; }; "disabled": { "alias": "disabled"; "required": false; "isSignal": true; }; "focusTarget": { "alias": "focusTarget"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; }, { "activated": "activated"; "deactivated": "deactivated"; }, never, never, true, never>;
    // (undocumented)
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridCellWidget, never>;
}

// @public
export class GridRow {
    readonly element: HTMLElement;
    readonly _gridPattern: Signal<GridPattern>;
    readonly _pattern: GridRowPattern;
    readonly rowIndex: _angular_core.InputSignal<number | undefined>;
    // (undocumented)
    static ɵdir: _angular_core.ɵɵDirectiveDeclaration<GridRow, "[ngGridRow]", ["ngGridRow"], { "rowIndex": { "alias": "rowIndex"; "required": false; "isSignal": true; }; }, {}, ["_cells"], never, true, never>;
    // (undocumented)
    static ɵfac: _angular_core.ɵɵFactoryDeclaration<GridRow, never>;
}

// (No @packageDocumentation comment for this package)