@angular/cdk-experimental 20.0.0-next.0 → 20.0.0-next.1

package/ui-patterns/index.d.ts

@@ -1,391 +1,2 @@
-import { Signal } from '@angular/core';
-import { WritableSignal } from '@angular/core';
-
-/** A basic event handler. */
-declare type EventHandler<T extends Event> = (event: T) => void;
-
-/** A config that specifies how to handle a particular event. */
-declare interface EventHandlerConfig<T extends Event> extends EventHandlerOptions {
-    matcher: EventMatcher<T>;
-    handler: EventHandler<T>;
-}
-
-/**
- * Options that are applicable to all event handlers.
- *
- * This library has not yet had a need for stopPropagationImmediate.
- */
-declare interface EventHandlerOptions {
-    stopPropagation: boolean;
-    preventDefault: boolean;
-}
-
-/**
- * Abstract base class for all event managers.
- *
- * Event managers are designed to normalize how event handlers are authored and create a safety net
- * for common event handling gotchas like remembering to call preventDefault or stopPropagation.
- */
-declare abstract class EventManager<T extends Event> {
-    protected configs: EventHandlerConfig<T>[];
-    abstract options: EventHandlerOptions;
-    /** Runs the handlers that match with the given event. */
-    handle(event: T): void;
-    /** Configures the event manager to handle specific events. (See subclasses for more). */
-    abstract on(...args: [...unknown[]]): this;
-}
-
-/** A function that determines whether an event is to be handled. */
-declare type EventMatcher<T extends Event> = (event: T) => boolean;
-
-/**
- * An event manager that is specialized for handling keyboard events. By default this manager stops
- * propagation and prevents default on all events it handles.
- */
-declare class KeyboardEventManager<T extends KeyboardEvent> extends EventManager<T> {
-    options: EventHandlerOptions;
-    /** Configures this event manager to handle events with a specific key and no modifiers. */
-    on(key: KeyCode, handler: EventHandler<T>): this;
-    /**  Configures this event manager to handle events with a specific modifer and key combination. */
-    on(modifiers: ModifierInputs, key: KeyCode, handler: EventHandler<T>): this;
-    private _normalizeInputs;
-    private _isMatch;
-}
-
-/**
- * Used to represent a keycode.
- *
- * This is used to match whether an events keycode should be handled. The ability to match using a
- * string, Signal, or Regexp gives us more flexibility when authoring event handlers.
- */
-declare type KeyCode = string | Signal<string> | RegExp;
-
-/** Represents the required inputs for a listbox. */
-export declare type ListboxInputs = ListNavigationInputs<OptionPattern> & ListSelectionInputs<OptionPattern> & ListTypeaheadInputs & ListFocusInputs<OptionPattern> & {
-    disabled: Signal<boolean>;
-};
-
-/** Controls the state of a listbox. */
-export declare class ListboxPattern {
-    readonly inputs: ListboxInputs;
-    /** Controls navigation for the listbox. */
-    navigation: ListNavigation<OptionPattern>;
-    /** Controls selection for the listbox. */
-    selection: ListSelection<OptionPattern>;
-    /** Controls typeahead for the listbox. */
-    typeahead: ListTypeahead<OptionPattern>;
-    /** Controls focus for the listbox. */
-    focusManager: ListFocus<OptionPattern>;
-    /** Whether the list is vertically or horizontally oriented. */
-    orientation: Signal<'vertical' | 'horizontal'>;
-    /** Whether the listbox is disabled. */
-    disabled: Signal<boolean>;
-    /** The tabindex of the listbox. */
-    tabindex: Signal<0 | -1>;
-    /** The id of the current active item. */
-    activedescendant: Signal<String | undefined>;
-    /** Whether multiple items in the list can be selected at once. */
-    multiselectable: Signal<boolean>;
-    /** The number of items in the listbox. */
-    setsize: Signal<number>;
-    /** Whether the listbox selection follows focus. */
-    followFocus: Signal<boolean>;
-    /** The key used to navigate to the previous item in the list. */
-    prevKey: Signal<"ArrowUp" | "ArrowRight" | "ArrowLeft">;
-    /** The key used to navigate to the next item in the list. */
-    nextKey: Signal<"ArrowRight" | "ArrowLeft" | "ArrowDown">;
-    /** The regexp used to decide if a key should trigger typeahead. */
-    typeaheadRegexp: RegExp;
-    /** The keydown event manager for the listbox. */
-    keydown: Signal<KeyboardEventManager<KeyboardEvent>>;
-    /** The pointerdown event manager for the listbox. */
-    pointerdown: Signal<PointerEventManager<PointerEvent>>;
-    constructor(inputs: ListboxInputs);
-    /** Handles keydown events for the listbox. */
-    onKeydown(event: KeyboardEvent): void;
-    onPointerdown(event: PointerEvent): void;
-    /** Navigates to the first option in the listbox. */
-    first(opts?: SelectOptions): void;
-    /** Navigates to the last option in the listbox. */
-    last(opts?: SelectOptions): void;
-    /** Navigates to the next option in the listbox. */
-    next(opts?: SelectOptions): void;
-    /** Navigates to the previous option in the listbox. */
-    prev(opts?: SelectOptions): void;
-    /** Navigates to the given item in the listbox. */
-    goto(event: PointerEvent, opts?: SelectOptions): void;
-    /** Handles typeahead search navigation for the listbox. */
-    search(char: string, opts?: SelectOptions): void;
-    /** Handles updating selection for the listbox. */
-    private _updateSelection;
-    private _getItem;
-}
-
-/**
- * Represents the properties exposed by a listbox that need to be accessed by an option.
- * This exists to avoid circular dependency errors between the listbox and option.
- */
-declare interface ListboxPattern_2 {
-    focusManager: ListFocus<OptionPattern>;
-    selection: ListSelection<OptionPattern>;
-    navigation: ListNavigation<OptionPattern>;
-}
-
-/** Controls focus for a list of items. */
-declare class ListFocus<T extends ListFocusItem> {
-    readonly inputs: ListFocusInputs<T> & {
-        navigation: ListNavigation<T>;
-    };
-    /** The navigation controller of the parent list. */
-    navigation: ListNavigation<ListFocusItem>;
-    constructor(inputs: ListFocusInputs<T> & {
-        navigation: ListNavigation<T>;
-    });
-    /** The id of the current active item. */
-    getActiveDescendant(): String | undefined;
-    /** The tabindex for the list. */
-    getListTabindex(): -1 | 0;
-    /** Returns the tabindex for the given item. */
-    getItemTabindex(item: T): -1 | 0;
-    /** Focuses the current active item. */
-    focus(): void;
-}
-
-/** Represents the required inputs for a collection that contains focusable items. */
-declare interface ListFocusInputs<T extends ListFocusItem> {
-    /** The focus strategy used by the list. */
-    focusMode: Signal<'roving' | 'activedescendant'>;
-}
-
-/** Represents an item in a collection, such as a listbox option, than may receive focus. */
-declare interface ListFocusItem extends ListNavigationItem {
-    /** A unique identifier for the item. */
-    id: Signal<string>;
-    /** The html element that should receive focus. */
-    element: Signal<HTMLElement>;
-}
-
-/** Controls navigation for a list of items. */
-declare class ListNavigation<T extends ListNavigationItem> {
-    readonly inputs: ListNavigationInputs<T>;
-    /** The last index that was active. */
-    prevActiveIndex: WritableSignal<number>;
-    constructor(inputs: ListNavigationInputs<T>);
-    /** Navigates to the given item. */
-    goto(item: T): void;
-    /** Navigates to the next item in the list. */
-    next(): void;
-    /** Navigates to the previous item in the list. */
-    prev(): void;
-    /** Navigates to the first item in the list. */
-    first(): void;
-    /** Navigates to the last item in the list. */
-    last(): void;
-    /** Returns true if the given item can be navigated to. */
-    isFocusable(item: T): boolean;
-    /** Advances to the next or previous focusable item in the list based on the given delta. */
-    private _advance;
-}
-
-/** Represents the required inputs for a collection that has navigable items. */
-declare interface ListNavigationInputs<T extends ListNavigationItem> {
-    /** Whether focus should wrap when navigating. */
-    wrap: Signal<boolean>;
-    /** The items in the list. */
-    items: Signal<T[]>;
-    /** Whether disabled items in the list should be skipped when navigating. */
-    skipDisabled: Signal<boolean>;
-    /** The current index that has been navigated to. */
-    activeIndex: WritableSignal<number>;
-    /** Whether the list is vertically or horizontally oriented. */
-    orientation: Signal<'vertical' | 'horizontal'>;
-    /** The direction that text is read based on the users locale. */
-    textDirection: Signal<'rtl' | 'ltr'>;
-}
-
-/** Represents an item in a collection, such as a listbox option, than can be navigated to. */
-declare interface ListNavigationItem {
-    /** Whether an item is disabled. */
-    disabled: Signal<boolean>;
-}
-
-/** Controls selection for a list of items. */
-declare class ListSelection<T extends ListSelectionItem> {
-    readonly inputs: ListSelectionInputs<T> & {
-        navigation: ListNavigation<T>;
-    };
-    /** The id of the most recently selected item. */
-    previousSelectedId: WritableSignal<string | undefined>;
-    /** The navigation controller of the parent list. */
-    navigation: ListNavigation<T>;
-    constructor(inputs: ListSelectionInputs<T> & {
-        navigation: ListNavigation<T>;
-    });
-    /** Selects the item at the current active index. */
-    select(item?: T): void;
-    /** Deselects the item at the current active index. */
-    deselect(item?: T): void;
-    /** Toggles the item at the current active index. */
-    toggle(): void;
-    /** Toggles only the item at the current active index. */
-    toggleOne(): void;
-    /** Selects all items in the list. */
-    selectAll(): void;
-    /** Deselects all items in the list. */
-    deselectAll(): void;
-    /** Selects the items in the list starting at the last selected item. */
-    selectFromPrevSelectedItem(): void;
-    /** Selects the items in the list starting at the last active item. */
-    selectFromActive(): void;
-    /** Selects the items in the list starting at the given index. */
-    private _selectFromIndex;
-    /** Sets the selection to only the current active item. */
-    selectOne(): void;
-    /** Sets the anchor to the current active index. */
-    private _anchor;
-}
-
-/** Represents the required inputs for a collection that contains selectable items. */
-declare interface ListSelectionInputs<T extends ListSelectionItem> {
-    /** The items in the list. */
-    items: Signal<T[]>;
-    /** Whether multiple items in the list can be selected at once. */
-    multiselectable: Signal<boolean>;
-    /** The ids of the current selected items. */
-    selectedIds: WritableSignal<string[]>;
-    /** The selection strategy used by the list. */
-    selectionMode: Signal<'follow' | 'explicit'>;
-}
-
-/** Represents an item in a collection, such as a listbox option, than can be selected. */
-declare interface ListSelectionItem extends ListNavigationItem {
-    /** A unique identifier for the item. */
-    id: Signal<string>;
-    /** Whether an item is disabled. */
-    disabled: Signal<boolean>;
-}
-
-/** Controls typeahead for a list of items. */
-declare class ListTypeahead<T extends ListTypeaheadItem> {
-    readonly inputs: ListTypeaheadInputs & {
-        navigation: ListNavigation<T>;
-    };
-    /** A reference to the timeout for resetting the typeahead search. */
-    timeout?: ReturnType<typeof setTimeout> | undefined;
-    /** The navigation controller of the parent list. */
-    navigation: ListNavigation<T>;
-    /** Keeps track of the characters that typeahead search is being called with. */
-    private _query;
-    /** The index where that the typeahead search was initiated from. */
-    private _startIndex;
-    constructor(inputs: ListTypeaheadInputs & {
-        navigation: ListNavigation<T>;
-    });
-    /** Performs a typeahead search, appending the given character to the search string. */
-    search(char: string): void;
-    /**
-     * Returns the first item whose search term matches the
-     * current query starting from the the current anchor index.
-     */
-    private _getItem;
-}
-
-/**
- * Represents the required inputs for a collection that contains items that can be navigated to by
- * typeahead.
- */
-declare interface ListTypeaheadInputs {
-    /** The amount of time before the typeahead search is reset. */
-    typeaheadDelay: Signal<number>;
-}
-
-/**
- * Represents an item in a collection, such as a listbox option, than can be navigated to by
- * typeahead.
- */
-declare interface ListTypeaheadItem extends ListNavigationItem {
-    /** The text used by the typeahead search. */
-    searchTerm: Signal<string>;
-}
-
-declare type ModifierInputs = ModifierKey | ModifierKey[];
-
-/** Bit flag representation of the possible modifier keys that can be present on an event. */
-declare enum ModifierKey {
-    None = 0,
-    Ctrl = 1,
-    Shift = 2,
-    Alt = 4,
-    Meta = 8
-}
-
-/**
- * The different mouse buttons that may appear on a pointer event.
- */
-declare enum MouseButton {
-    Main = 0,
-    Auxiliary = 1,
-    Secondary = 2
-}
-
-/** Represents the required inputs for an option in a listbox. */
-export declare interface OptionInputs extends ListNavigationItem, ListSelectionItem, ListTypeaheadItem, ListFocusItem {
-    listbox: Signal<ListboxPattern_2>;
-}
-
-/** Represents an option in a listbox. */
-export declare class OptionPattern {
-    /** A unique identifier for the option. */
-    id: Signal<string>;
-    /** The position of the option in the list. */
-    index: Signal<number>;
-    /** Whether the option is selected. */
-    selected: Signal<boolean>;
-    /** Whether the option is disabled. */
-    disabled: Signal<boolean>;
-    /** The text used by the typeahead search. */
-    searchTerm: Signal<string>;
-    /** A reference to the parent listbox. */
-    listbox: Signal<ListboxPattern_2>;
-    /** The tabindex of the option. */
-    tabindex: Signal<0 | -1>;
-    /** The html element that should receive focus. */
-    element: Signal<HTMLElement>;
-    constructor(args: OptionInputs);
-}
-
-/** An event manager that is specialized for handling pointer events. */
-declare class PointerEventManager<T extends PointerEvent> extends EventManager<T> {
-    options: EventHandlerOptions;
-    /**
-     * Configures this event manager to handle events with a specific modifer and mouse button
-     * combination.
-     */
-    on(button: MouseButton, modifiers: ModifierInputs, handler: EventHandler<T>): this;
-    /**
-     * Configures this event manager to handle events with a specific mouse button and no modifiers.
-     */
-    on(modifiers: ModifierInputs, handler: EventHandler<T>): this;
-    /**
-     * Configures this event manager to handle events with the main mouse button and no modifiers.
-     *
-     * @param handler The handler function
-     * @param options Options for whether to stop propagation or prevent default.
-     */
-    on(handler: EventHandler<T>): this;
-    private _normalizeInputs;
-    _isMatch(event: PointerEvent, button: MouseButton, modifiers: ModifierInputs): boolean;
-}
-
-/** The selection operations that the listbox can perform. */
-declare interface SelectOptions {
-    select?: boolean;
-    toggle?: boolean;
-    toggleOne?: boolean;
-    selectOne?: boolean;
-    selectAll?: boolean;
-    selectFromAnchor?: boolean;
-    selectFromActive?: boolean;
-}
-
-export { }
+export { a as ListboxInputs, L as ListboxPattern, b as OptionInputs, O as OptionPattern } from '../listbox.d-8e28229b.js';
+import '@angular/core';