@react-aria/selection 3.27.2 → 3.28.0

package/dist/types.d.ts

@@ -1,258 +0,0 @@
-import { DOMAttributes, Key, KeyboardDelegate, FocusStrategy, RefObject, DOMProps, FocusableElement, LayoutDelegate, Rect, Size, Collection, Direction, DisabledBehavior, Node, Orientation } from "@react-types/shared";
-import { MultipleSelectionManager } from "@react-stately/selection";
-export interface AriaTypeSelectOptions {
-    /**
-     * A delegate that returns collection item keys with respect to visual layout.
-     */
-    keyboardDelegate: KeyboardDelegate;
-    /**
-     * An interface for reading and updating multiple selection state.
-     */
-    selectionManager: MultipleSelectionManager;
-    /**
-     * Called when an item is focused by typing.
-     */
-    onTypeSelect?: (key: Key) => void;
-}
-export interface TypeSelectAria {
-    /**
-     * Props to be spread on the owner of the options.
-     */
-    typeSelectProps: DOMAttributes;
-}
-/**
- * Handles typeahead interactions with collections.
- */
-export function useTypeSelect(options: AriaTypeSelectOptions): TypeSelectAria;
-export interface AriaSelectableCollectionOptions {
-    /**
-     * An interface for reading and updating multiple selection state.
-     */
-    selectionManager: MultipleSelectionManager;
-    /**
-     * A delegate object that implements behavior for keyboard focus movement.
-     */
-    keyboardDelegate: KeyboardDelegate;
-    /**
-     * The ref attached to the element representing the collection.
-     */
-    ref: RefObject<HTMLElement | null>;
-    /**
-     * Whether the collection or one of its items should be automatically focused upon render.
-     * @default false
-     */
-    autoFocus?: boolean | FocusStrategy;
-    /**
-     * Whether focus should wrap around when the end/start is reached.
-     * @default false
-     */
-    shouldFocusWrap?: boolean;
-    /**
-     * Whether the collection allows empty selection.
-     * @default false
-     */
-    disallowEmptySelection?: boolean;
-    /**
-     * Whether the collection allows the user to select all items via keyboard shortcut.
-     * @default false
-     */
-    disallowSelectAll?: boolean;
-    /**
-     * Whether pressing the Escape should clear selection in the collection or not.
-     * @default 'clearSelection'
-     */
-    escapeKeyBehavior?: 'clearSelection' | 'none';
-    /**
-     * Whether selection should occur automatically on focus.
-     * @default false
-     */
-    selectOnFocus?: boolean;
-    /**
-     * Whether typeahead is disabled.
-     * @default false
-     */
-    disallowTypeAhead?: boolean;
-    /**
-     * Whether the collection items should use virtual focus instead of being focused directly.
-     */
-    shouldUseVirtualFocus?: boolean;
-    /**
-     * Whether navigation through tab key is enabled.
-     */
-    allowsTabNavigation?: boolean;
-    /**
-     * Whether the collection items are contained in a virtual scroller.
-     */
-    isVirtualized?: boolean;
-    /**
-     * The ref attached to the scrollable body. Used to provide automatic scrolling on item focus for non-virtualized collections.
-     * If not provided, defaults to the collection ref.
-     */
-    scrollRef?: RefObject<HTMLElement | null>;
-    /**
-     * The behavior of links in the collection.
-     * - 'action': link behaves like onAction.
-     * - 'selection': link follows selection interactions (e.g. if URL drives selection).
-     * - 'override': links override all other interactions (link items are not selectable).
-     * @default 'action'
-     */
-    linkBehavior?: 'action' | 'selection' | 'override';
-}
-export interface SelectableCollectionAria {
-    /** Props for the collection element. */
-    collectionProps: DOMAttributes;
-}
-/**
- * Handles interactions with selectable collections.
- */
-export function useSelectableCollection(options: AriaSelectableCollectionOptions): SelectableCollectionAria;
-export interface SelectableItemOptions extends DOMProps {
-    /**
-     * An interface for reading and updating multiple selection state.
-     */
-    selectionManager: MultipleSelectionManager;
-    /**
-     * A unique key for the item.
-     */
-    key: Key;
-    /**
-     * Ref to the item.
-     */
-    ref: RefObject<FocusableElement | null>;
-    /**
-     * By default, selection occurs on pointer down. This can be strange if selecting an
-     * item causes the UI to disappear immediately (e.g. menus).
-     */
-    shouldSelectOnPressUp?: boolean;
-    /**
-     * Whether selection requires the pointer/mouse down and up events to occur on the same target or triggers selection on
-     * the target of the pointer/mouse up event.
-     */
-    allowsDifferentPressOrigin?: boolean;
-    /**
-     * Whether the option is contained in a virtual scroller.
-     */
-    isVirtualized?: boolean;
-    /**
-     * Function to focus the item.
-     */
-    focus?: () => void;
-    /**
-     * Whether the option should use virtual focus instead of being focused directly.
-     */
-    shouldUseVirtualFocus?: boolean;
-    /** Whether the item is disabled. */
-    isDisabled?: boolean;
-    /**
-     * Handler that is called when a user performs an action on the item. The exact user event depends on
-     * the collection's `selectionBehavior` prop and the interaction modality.
-     */
-    onAction?: () => void;
-    /**
-     * The behavior of links in the collection.
-     * - 'action': link behaves like onAction.
-     * - 'selection': link follows selection interactions (e.g. if URL drives selection).
-     * - 'override': links override all other interactions (link items are not selectable).
-     * - 'none': links are disabled for both selection and actions (e.g. handled elsewhere).
-     * @default 'action'
-     */
-    linkBehavior?: 'action' | 'selection' | 'override' | 'none';
-}
-export interface SelectableItemStates {
-    /** Whether the item is currently in a pressed state. */
-    isPressed: boolean;
-    /** Whether the item is currently selected. */
-    isSelected: boolean;
-    /** Whether the item is currently focused. */
-    isFocused: boolean;
-    /**
-     * Whether the item is non-interactive, i.e. both selection and actions are disabled and the item may
-     * not be focused. Dependent on `disabledKeys` and `disabledBehavior`.
-     */
-    isDisabled: boolean;
-    /**
-     * Whether the item may be selected, dependent on `selectionMode`, `disabledKeys`, and `disabledBehavior`.
-     */
-    allowsSelection: boolean;
-    /**
-     * Whether the item has an action, dependent on `onAction`, `disabledKeys`,
-     * and `disabledBehavior`. It may also change depending on the current selection state
-     * of the list (e.g. when selection is primary). This can be used to enable or disable hover
-     * styles or other visual indications of interactivity.
-     */
-    hasAction: boolean;
-}
-export interface SelectableItemAria extends SelectableItemStates {
-    /**
-     * Props to be spread on the item root node.
-     */
-    itemProps: DOMAttributes;
-}
-/**
- * Handles interactions with an item in a selectable collection.
- */
-export function useSelectableItem(options: SelectableItemOptions): SelectableItemAria;
-export class DOMLayoutDelegate implements LayoutDelegate {
-    constructor(ref: RefObject<HTMLElement | null>);
-    getItemRect(key: Key): Rect | null;
-    getContentSize(): Size;
-    getVisibleRect(): Rect;
-}
-interface ListKeyboardDelegateOptions<T> {
-    collection: Collection<Node<T>>;
-    ref: RefObject<HTMLElement | null>;
-    collator?: Intl.Collator;
-    layout?: 'stack' | 'grid';
-    orientation?: Orientation;
-    direction?: Direction;
-    disabledKeys?: Set<Key>;
-    disabledBehavior?: DisabledBehavior;
-    layoutDelegate?: LayoutDelegate;
-}
-export class ListKeyboardDelegate<T> implements KeyboardDelegate {
-    constructor(collection: Collection<Node<T>>, disabledKeys: Set<Key>, ref: RefObject<HTMLElement | null>, collator?: Intl.Collator, expandedKeys?: Set<Key>);
-    constructor(options: ListKeyboardDelegateOptions<T>);
-    getNextKey(key: Key): Key | null;
-    getPreviousKey(key: Key): Key | null;
-    getKeyBelow(key: Key): Key | null;
-    getKeyAbove(key: Key): Key | null;
-    getKeyRightOf?(key: Key): Key | null;
-    getKeyLeftOf?(key: Key): Key | null;
-    getFirstKey(): Key | null;
-    getLastKey(): Key | null;
-    getKeyPageAbove(key: Key): Key | null;
-    getKeyPageBelow(key: Key): Key | null;
-    getKeyForSearch(search: string, fromKey?: Key): Key | null;
-}
-export interface AriaSelectableListOptions extends Omit<AriaSelectableCollectionOptions, 'keyboardDelegate'> {
-    /**
-     * State of the collection.
-     */
-    collection: Collection<Node<unknown>>;
-    /**
-     * A delegate object that implements behavior for keyboard focus movement.
-     */
-    keyboardDelegate?: KeyboardDelegate;
-    /**
-     * A delegate object that provides layout information for items in the collection.
-     * By default this uses the DOM, but this can be overridden to implement things like
-     * virtualized scrolling.
-     */
-    layoutDelegate?: LayoutDelegate;
-    /**
-     * The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.
-     */
-    disabledKeys: Set<Key>;
-}
-export interface SelectableListAria {
-    /**
-     * Props for the option element.
-     */
-    listProps: DOMAttributes;
-}
-/**
- * Handles interactions with a selectable list.
- */
-export function useSelectableList(props: AriaSelectableListOptions): SelectableListAria;
-
-//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"mappings":";;ACsBA;IACE;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACH,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAA;CAClC;AAED;IACE;;OAEG;IACH,eAAe,EAAE,aAAa,CAAA;CAC/B;AAED;;GAEG;AACH,8BAA8B,OAAO,EAAE,qBAAqB,GAAG,cAAc,CAyD5E;ACjFD;IACE;;OAEG;IACH,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IACnC;;OAEG;IACH,GAAG,EAAE,UAAU,WAAW,GAAG,IAAI,CAAC,CAAC;IACnC;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,GAAG,aAAa,CAAC;IACpC;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAAC;IAC9C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,WAAW,GAAG,IAAI,CAAC,CAAC;IAC1C;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,CAAA;CACnD;AAED;IACE,wCAAwC;IACxC,eAAe,EAAE,aAAa,CAAA;CAC/B;AAED;;GAEG;AACH,wCAAwC,OAAO,EAAE,+BAA+B,GAAG,wBAAwB,CAue1G;AC7jBD,sCAAuC,SAAQ,QAAQ;IACrD;;OAEG;IACH,gBAAgB,EAAE,wBAAwB,CAAC;IAC3C;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC;IACT;;OAEG;IACH,GAAG,EAAE,UAAU,gBAAgB,GAAG,IAAI,CAAC,CAAC;IACxC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,IAAI,CAAC;IACnB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,oCAAoC;IACpC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,IAAI,CAAC;IACtB;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,QAAQ,GAAG,WAAW,GAAG,UAAU,GAAG,MAAM,CAAA;CAC5D;AAED;IACE,wDAAwD;IACxD,SAAS,EAAE,OAAO,CAAC;IACnB,8CAA8C;IAC9C,UAAU,EAAE,OAAO,CAAC;IACpB,6CAA6C;IAC7C,SAAS,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;;;;OAKG;IACH,SAAS,EAAE,OAAO,CAAA;CACnB;AAED,mCAAoC,SAAQ,oBAAoB;IAC9D;;OAEG;IACH,SAAS,EAAE,aAAa,CAAA;CACzB;AAED;;GAEG;AACH,kCAAkC,OAAO,EAAE,qBAAqB,GAAG,kBAAkB,CAiTpF;AC9YD,8BAA+B,YAAW,cAAc;gBAG1C,GAAG,EAAE,UAAU,WAAW,GAAG,IAAI,CAAC;IAI9C,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,GAAG,IAAI;IAqBlC,cAAc,IAAI,IAAI;IAQtB,cAAc,IAAI,IAAI;CASvB;AC5CD,sCAAsC,CAAC;IACrC,UAAU,EAAE,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IAChC,GAAG,EAAE,UAAU,WAAW,GAAG,IAAI,CAAC,CAAC;IACnC,QAAQ,CAAC,EAAE,KAAK,QAAQ,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC1B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,YAAY,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACxB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,cAAc,CAAC,EAAE,cAAc,CAAA;CAChC;AAED,kCAAkC,CAAC,CAAE,YAAW,gBAAgB;gBAWlD,UAAU,EAAE,WAAW,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,UAAU,WAAW,GAAG,IAAI,CAAC,EAAE,QAAQ,CAAC,EAAE,KAAK,QAAQ,EAAE,YAAY,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC;gBAC9I,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAkDnD,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAMhC,cAAc,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAsCpC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAQjC,WAAW,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAYjC,aAAa,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAsBpC,YAAY,CAAC,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IAoBnC,WAAW,IAAI,GAAG,GAAG,IAAI;IAKzB,UAAU,IAAI,GAAG,GAAG,IAAI;IAKxB,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IA+BrC,eAAe,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;IA+BrC,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,GAAG,GAAG,IAAI;CAsB3D;AChRD,0CAA2C,SAAQ,IAAI,CAAC,+BAA+B,EAAE,kBAAkB,CAAC;IAC1G;;OAEG;IACH,UAAU,EAAE,WAAW,KAAK,OAAO,CAAC,CAAC,CAAC;IACtC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC;;;;OAIG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC;;OAEG;IACH,YAAY,EAAE,GAAG,CAAC,GAAG,CAAC,CAAA;CACvB;AAED;IACE;;OAEG;IACH,SAAS,EAAE,aAAa,CAAA;CACzB;AAED;;GAEG;AACH,kCAAkC,KAAK,EAAE,yBAAyB,GAAG,kBAAkB,CAmCtF","sources":["packages/@react-aria/selection/src/packages/@react-aria/selection/src/utils.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/useTypeSelect.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/useSelectableCollection.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/useSelectableItem.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/DOMLayoutDelegate.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/ListKeyboardDelegate.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/useSelectableList.ts","packages/@react-aria/selection/src/packages/@react-aria/selection/src/index.ts","packages/@react-aria/selection/src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,null,"/*\n * Copyright 2020 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nexport {useSelectableCollection} from './useSelectableCollection';\nexport {useSelectableItem} from './useSelectableItem';\nexport {useSelectableList} from './useSelectableList';\nexport {ListKeyboardDelegate} from './ListKeyboardDelegate';\nexport {DOMLayoutDelegate} from './DOMLayoutDelegate';\nexport {useTypeSelect} from './useTypeSelect';\n\nexport type {AriaSelectableCollectionOptions, SelectableCollectionAria} from './useSelectableCollection';\nexport type {AriaSelectableListOptions, SelectableListAria} from './useSelectableList';\nexport type {SelectableItemOptions, SelectableItemStates, SelectableItemAria} from './useSelectableItem';\nexport type {AriaTypeSelectOptions, TypeSelectAria} from './useTypeSelect';\n"],"names":[],"version":3,"file":"types.d.ts.map"}