UNPKG

@workday/canvas-kit-react

Version:

The parent module that contains all Workday Canvas Kit React components

428 lines • 16.1 kB
import * as React from 'react'; import { ExtractProps } from '@workday/canvas-kit-react/common'; import { Flex } from '@workday/canvas-kit-react/layout'; export interface TabListProps<T = any> extends Omit<ExtractProps<typeof Flex, never>, 'children'> { /** * If items are passed to a `TabsModel`, the child of `Tabs.List` should be a render prop. The * List will determine how and when the item will be rendered. * * @example * <Tabs.List> * {(item) => <Tabs.Item>{item.text}</Tabs.Item>} * </Tabs.List> */ children: ((item: T) => React.ReactNode) | React.ReactNode; overflowButton?: React.ReactNode; } export declare const useTabsList: import("@workday/canvas-kit-react/common").BehaviorHook<{ state: { getId: (item: any) => string; orientation: import("@workday/canvas-kit-react/collection").Orientation; panels: import("@workday/canvas-kit-react/collection").Item<any>[]; panelIndexRef: React.MutableRefObject<number>; hiddenIds: string[]; itemSizeCache: Record<string, number>; itemWidthCache: Record<string, number>; containerSize: number; containerWidth: number; containerGap: number; overflowTargetWidth: number; 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("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void; measure: () => void; }; UNSTABLE_defaultItemHeight: number; containerRef: React.RefObject<HTMLDivElement>; id: string; indexRef: React.MutableRefObject<number>; nonInteractiveIds: string[]; isVirtualized: boolean; items: import("@workday/canvas-kit-react/collection").Item<any>[]; }; events: { registerPanel: (data: { id: string; textValue: string; }) => void; unregisterPanel: (data: { id: string; }) => void; select(data: { id: string; }): void; setContainerSize(data: { width?: number | undefined; height?: number | undefined; }): void; setContainerWidth(data: { width?: number | undefined; }): void; setContainerGap(data: { size: number; }): void; setOverflowTargetSize(data: { width: number; height: number; }): void; setOverflowTargetWidth(data: { width: number; }): void; addItemWidth(data: { id: string; width: number; }): void; addItemSize(data: { id: string; width: number; height: number; }): void; removeItemSize(data: { id: string; }): void; removeItemWidth(data: { id: string; }): void; addHiddenKey(data: { id: string; }): void; removeHiddenKey(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: { id: string; textValue: string; }): void; unregisterItem(data: { id: string; }): void; updateItemHeight(data: { value: number; }): void; }; menu: { state: { stackRef: React.RefObject<HTMLDivElement>; targetRef: React.RefObject<HTMLButtonElement>; initialFocusRef: React.RefObject<any> | undefined; returnFocusRef: React.RefObject<any> | undefined; placement: import("@popperjs/core").Placement; id: string; visibility: "hidden" | "visible"; 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("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void; measure: () => void; }; UNSTABLE_defaultItemHeight: number; containerRef: React.RefObject<HTMLDivElement>; orientation: "horizontal" | "vertical"; indexRef: React.MutableRefObject<number>; nonInteractiveIds: string[]; isVirtualized: boolean; items: import("@workday/canvas-kit-react/collection").Item<any>[]; mode: "multiple" | "single"; }; events: { updatePlacement(data: { placement: import("@popperjs/core").Placement; }): void; show(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void; hide(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void; 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: { 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; }; 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 role: "tablist"; readonly overflowX: "auto" | undefined; }, import("@workday/canvas-kit-react/common").MergeProps<{ readonly ref: (instance: HTMLElement | null) => void; }, import("@workday/canvas-kit-react/common").MergeProps<{ readonly onKeyDown: (event: React.KeyboardEvent<Element>) => void; readonly onFocus: () => void; readonly onBlur: () => void; }, import("@workday/canvas-kit-react/common").MergeProps<{}, import("@workday/canvas-kit-react/common").MergeProps<{}, import("@workday/canvas-kit-react/common").MergeProps<{}, {}>>>>>>>>; export declare const TabsList: import("@workday/canvas-kit-react/common").ElementComponentM<"div", TabListProps<any>, { state: { getId: (item: any) => string; orientation: import("@workday/canvas-kit-react/collection").Orientation; panels: import("@workday/canvas-kit-react/collection").Item<any>[]; panelIndexRef: React.MutableRefObject<number>; hiddenIds: string[]; itemSizeCache: Record<string, number>; itemWidthCache: Record<string, number>; containerSize: number; containerWidth: number; containerGap: number; overflowTargetWidth: number; 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("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void; measure: () => void; }; UNSTABLE_defaultItemHeight: number; containerRef: React.RefObject<HTMLDivElement>; id: string; indexRef: React.MutableRefObject<number>; nonInteractiveIds: string[]; isVirtualized: boolean; items: import("@workday/canvas-kit-react/collection").Item<any>[]; }; events: { registerPanel: (data: { id: string; textValue: string; }) => void; unregisterPanel: (data: { id: string; }) => void; select(data: { id: string; }): void; setContainerSize(data: { width?: number | undefined; height?: number | undefined; }): void; setContainerWidth(data: { width?: number | undefined; }): void; setContainerGap(data: { size: number; }): void; setOverflowTargetSize(data: { width: number; height: number; }): void; setOverflowTargetWidth(data: { width: number; }): void; addItemWidth(data: { id: string; width: number; }): void; addItemSize(data: { id: string; width: number; height: number; }): void; removeItemSize(data: { id: string; }): void; removeItemWidth(data: { id: string; }): void; addHiddenKey(data: { id: string; }): void; removeHiddenKey(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: { id: string; textValue: string; }): void; unregisterItem(data: { id: string; }): void; updateItemHeight(data: { value: number; }): void; }; menu: { state: { stackRef: React.RefObject<HTMLDivElement>; targetRef: React.RefObject<HTMLButtonElement>; initialFocusRef: React.RefObject<any> | undefined; returnFocusRef: React.RefObject<any> | undefined; placement: import("@popperjs/core").Placement; id: string; visibility: "hidden" | "visible"; 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("../../collection/lib/react-virtual").ScrollToIndexOptions | undefined) => void; measure: () => void; }; UNSTABLE_defaultItemHeight: number; containerRef: React.RefObject<HTMLDivElement>; orientation: "horizontal" | "vertical"; indexRef: React.MutableRefObject<number>; nonInteractiveIds: string[]; isVirtualized: boolean; items: import("@workday/canvas-kit-react/collection").Item<any>[]; mode: "multiple" | "single"; }; events: { updatePlacement(data: { placement: import("@popperjs/core").Placement; }): void; show(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void; hide(event?: Event | React.SyntheticEvent<Element, Event> | undefined): void; 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: { 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; }; selection: import("@workday/canvas-kit-react/collection").SelectionManager; navigation: import("@workday/canvas-kit-react/collection").NavigationManager; getId: (item: any) => string; }>; export declare const useTouchDirection: () => { direction: string; isDragging: boolean; }; //# sourceMappingURL=TabsList.d.ts.map