@workday/canvas-kit-preview-react/dist/commonjs/segmented-control/lib/hooks/useSegmentedControlItem.d.ts

Canvas Kit Preview is made up of components that have the full design and a11y review, are part of the DS ecosystem and are approved for use in product. The API's could be subject to change, but not without strong communication and migration strategies.

import * as React from 'react';
export declare const useSegmentedControlItem: import("@workday/canvas-kit-react/common").BehaviorHook<{
    state: {
        selectedIds: string[] | "all";
        unselectedIds: string[];
        cursorId: string;
        columnCount: number;
        pageSizeRef: React.MutableRefObject<number>;
        cursorIndexRef: {
            readonly current: number;
        };
        UNSTABLE_virtual: {
            virtualItems: import("@workday/canvas-kit-react/collection").VirtualItem[];
            totalSize: number;
            scrollToOffset: (index: number, options?: import("@workday/canvas-kit-react/collection").ScrollToOffsetOptions | undefined) => void;
            scrollToIndex: (index: number, options?: import("@workday/canvas-kit-react/collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void;
            measure: () => void;
        };
        UNSTABLE_defaultItemHeight: number;
        containerRef: React.RefObject<HTMLDivElement>;
        id: string;
        orientation: "horizontal" | "vertical";
        indexRef: 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 | 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: {
            item: any;
            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;
}, import("@workday/canvas-kit-react/common").RemoveNulls<import("@workday/canvas-kit-react/common").MergeProps<{
    readonly onClick: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
}, import("@workday/canvas-kit-react/common").MergeProps<{
    readonly id: `${string}-${string}`;
    readonly 'aria-pressed': boolean;
}, import("@workday/canvas-kit-react/common").MergeProps<{
    readonly ref: (instance: HTMLElement | null) => void;
    readonly 'data-id': string;
    readonly disabled: true | undefined;
    readonly item: null;
    readonly virtual: null;
    readonly 'aria-setsize': number | undefined;
    readonly 'aria-posinset': number | undefined;
    readonly style: React.CSSProperties;
    readonly id: string;
}, import("@workday/canvas-kit-react/common").MergeProps<{
    readonly disabled: true | undefined;
}, import("@workday/canvas-kit-react/common").MergeProps<{}, import("@workday/canvas-kit-react/common").MergeProps<{}, {}>>>>>>>>;
//# sourceMappingURL=useSegmentedControlItem.d.ts.map