@workday/canvas-kit-labs-react 16.1.4 → 16.2.0-0604-next.0

package/dist/commonjs/selection-group/lib/hooks/useSelectionGroupItem.d.ts

@@ -0,0 +1,146 @@
+export declare const useSelectionGroupItem: import("@workday/canvas-kit-react/common").BehaviorHook<{
+    state: {
+        selectedIds: string[] | "all";
+        unselectedIds: string[];
+        cursorId: string | string[];
+        columnCount: number;
+        pageSizeRef: import("react").MutableRefObject<number>;
+        cursorIndexRef: {
+            readonly current: number;
+        };
+        UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
+        UNSTABLE_defaultItemHeight: number;
+        containerRef: import("react").RefObject<HTMLDivElement>;
+        id: string;
+        orientation: "horizontal" | "vertical";
+        indexRef: import("react").MutableRefObject<number>;
+        nonInteractiveIds: string[];
+        isVirtualized: boolean;
+        items: import("@workday/canvas-kit-react/collection").Item<any>[];
+    };
+    events: {
+        select(data: {
+            id: string;
+        }): void;
+        selectAll(): void;
+        unselectAll(): void;
+        setSelectedIds(ids: string[] | "all"): void;
+        remove(data: {
+            id: string;
+            nextId?: string | undefined;
+            event?: Event | import("react").SyntheticEvent<Element, Event> | undefined;
+        }): void;
+        goTo(data: {
+            id: string;
+        }): void;
+        goToNext(): void;
+        goToPrevious(): void;
+        goToPreviousRow(): void;
+        goToNextRow(): void;
+        goToFirst(): void;
+        goToLast(): void;
+        goToFirstOfRow(): void;
+        goToLastOfRow(): void;
+        goToNextPage(): void;
+        goToPreviousPage(): void;
+        registerItem(data: {
+            id: string;
+            textValue: string;
+        }): void;
+        unregisterItem(data: {
+            id: string;
+        }): void;
+        updateItemHeight(data: {
+            value: number;
+        }): void;
+    };
+    selection: import("@workday/canvas-kit-react/collection").SelectionManager;
+    navigation: import("@workday/canvas-kit-react/collection").NavigationManager;
+    getId: (item: any) => string;
+    getTextValue: (item: any) => string;
+    UNSTABLE_parentModel: {
+        state: {
+            selectedIds: string[] | "all";
+            unselectedIds: string[];
+            cursorId: string | string[];
+            columnCount: number;
+            pageSizeRef: import("react").MutableRefObject<number>;
+            cursorIndexRef: {
+                readonly current: number;
+            };
+            UNSTABLE_virtual: import("@tanstack/virtual-core").Virtualizer<HTMLDivElement, Element>;
+            UNSTABLE_defaultItemHeight: number;
+            containerRef: import("react").RefObject<HTMLDivElement>;
+            id: string;
+            orientation: "horizontal" | "vertical";
+            indexRef: import("react").MutableRefObject<number>;
+            nonInteractiveIds: string[];
+            isVirtualized: boolean;
+            items: import("@workday/canvas-kit-react/collection").Item<any>[];
+        };
+        events: {
+            select(data: {
+                id: string;
+            }): void;
+            selectAll(): void;
+            unselectAll(): void;
+            setSelectedIds(ids: string[] | "all"): void;
+            remove(data: {
+                id: string;
+                nextId?: string | undefined;
+                event?: Event | import("react").SyntheticEvent<Element, Event> | undefined;
+            }): void;
+            goTo(data: {
+                id: string;
+            }): void;
+            goToNext(): void;
+            goToPrevious(): void;
+            goToPreviousRow(): void;
+            goToNextRow(): void;
+            goToFirst(): void;
+            goToLast(): void;
+            goToFirstOfRow(): void;
+            goToLastOfRow(): void;
+            goToNextPage(): void;
+            goToPreviousPage(): void;
+            registerItem(data: {
+                id: string;
+                textValue: string;
+            }): void;
+            unregisterItem(data: {
+                id: string;
+            }): void;
+            updateItemHeight(data: {
+                value: number;
+            }): void;
+        };
+        selection: import("@workday/canvas-kit-react/collection").SelectionManager;
+        navigation: import("@workday/canvas-kit-react/collection").NavigationManager;
+        getId: (item: any) => string;
+        getTextValue: (item: any) => string;
+    } | undefined;
+}, import("@workday/canvas-kit-react/common").RemoveNulls<import("@workday/canvas-kit-react/common").MergeProps<{
+    readonly onClick: (event: import("react").MouseEvent<HTMLElement, MouseEvent>) => null | undefined;
+}, import("@workday/canvas-kit-react/common").MergeProps<{
+    readonly onKeyDown: (event: import("react").KeyboardEvent<HTMLElement>) => void;
+    readonly onClick: () => void;
+    readonly 'data-focus-id': string;
+    readonly tabIndex: 0 | -1;
+}, import("@workday/canvas-kit-react/common").MergeProps<{
+    readonly tabIndex?: 0 | undefined;
+    readonly role: "checkbox" | "radio";
+    readonly 'aria-checked': boolean;
+    readonly type: "button";
+}, import("@workday/canvas-kit-react/common").MergeProps<{
+    readonly ref: (instance: Element | null | undefined) => void;
+    readonly 'data-id': string;
+    readonly disabled: true | undefined;
+    readonly 'aria-setsize': number | undefined;
+    readonly 'aria-posinset': number | undefined;
+    readonly 'data-index': number | undefined;
+    readonly style: import("react").CSSProperties;
+    readonly id: string;
+}, import("@workday/canvas-kit-react/common").MergeProps<{
+    readonly disabled?: true | undefined;
+}, import("@workday/canvas-kit-react/common").MergeProps<{}, {}>>>>>>>>;
+//# sourceMappingURL=useSelectionGroupItem.d.ts.map

package/dist/commonjs/selection-group/lib/hooks/useSelectionGroupItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSelectionGroupItem.d.ts","sourceRoot":"","sources":["../../../../../selection-group/lib/hooks/useSelectionGroupItem.tsx"],"names":[],"mappings":"AAuCA,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uEAMjC,CAAC"}

package/dist/commonjs/selection-group/lib/hooks/useSelectionGroupItem.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSelectionGroupItem = void 0;
+const collection_1 = require("@workday/canvas-kit-react/collection");
+const common_1 = require("@workday/canvas-kit-react/common");
+const useSelectionGroupModel_1 = require("./useSelectionGroupModel");
+const useSelectionGroupItemProps = (0, common_1.createElemPropsHook)(useSelectionGroupModel_1.useSelectionGroupModel)((model, _ref, elemProps = {}) => {
+    const name = elemProps['data-id'] || '';
+    return {
+        role: model.state.mode === 'single' ? 'radio' : 'checkbox',
+        'aria-checked': !!name && (0, collection_1.isSelected)(name, model.state),
+        type: 'button',
+        // A single-select group is a radio group and uses a single roving tab stop. A multi-select
+        // group is a checkbox group, where every item is its own tab stop, so the roving tabindex
+        // applied by `useListItemRovingFocus` is overridden here.
+        ...(model.state.mode === 'multiple' ? { tabIndex: 0 } : {}),
+    };
+});
+const useSelectionGroupItemDisabled = (0, common_1.createElemPropsHook)(useSelectionGroupModel_1.useSelectionGroupModel)(({ state }) => {
+    return {
+        // `useListItemRegister` resolves the item's own `disabled` prop and `nonInteractiveIds`, but
+        // it doesn't know about the group-level `disabled`. The key is only added when the group is
+        // disabled so that an `undefined` doesn't overwrite what `useListItemRegister` resolved. The
+        // native `disabled` attribute already conveys the state to assistive technology, so no
+        // `aria-disabled` is added alongside it.
+        ...(state.disabled ? { disabled: true } : {}),
+    };
+});
+exports.useSelectionGroupItem = (0, common_1.composeHooks)(collection_1.useListItemSelect, collection_1.useListItemRovingFocus, useSelectionGroupItemProps, collection_1.useListItemRegister, useSelectionGroupItemDisabled);