@workday/canvas-kit-react 5.3.17 → 5.4.0-next.1

package/tabs/lib/list/hooks.tsx

@@ -1,45 +0,0 @@
-import React from 'react';
-
-import {useMountLayout} from '@workday/canvas-kit-react/common';
-
-import {ListModel} from './useListModel';
-
-/**
- * Handle list registration. Returns an identifier used to identify this item in the list
- * @param model A ListModel
- * @param localRef A RefObject that will be used to register an item
- * @param id Desired identifier for the List Model. If not provided, it will fall back to the index
- * in the list
- * @param index (Optional) Specify the position of the item if the order is expected to change
- */
-export const useRegisterItem = (
-  {state, events}: ListModel,
-  localRef: React.RefObject<any>,
-  id = '',
-  index?: number
-): string => {
-  const [localId, setLocalId] = React.useState(id);
-  const firstRender = React.useRef(true);
-
-  React.useLayoutEffect(() => {
-    if (index !== undefined && !firstRender.current) {
-      events.updateItemPosition({id: localId, index});
-    }
-    // we only care about the index changing
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [index]);
-
-  useMountLayout(() => {
-    const defaultId = state.indexRef.current;
-    const itemId = id || String(defaultId);
-    events.registerItem({item: {id: itemId, ref: localRef}, index});
-    setLocalId(itemId);
-    firstRender.current = false;
-
-    return () => {
-      events.unregisterItem({id: itemId});
-    };
-  });
-
-  return localId;
-};

package/ts3.5/dist/commonjs/tabs/lib/Tab.d.ts

@@ -1,49 +0,0 @@
-import * as React from 'react';
-import { TabsModel } from './useTabsModel';
-export interface TabProps {
-    /**
-     * Optionally pass index to tab item. This should be done if `Tabs.Item` components were created
-     * via a `Array::map` function. This index will ensure keyboard navigation works even if items are
-     * inserted out of order.
-     */
-    index?: number;
-    /**
-     * The label text of the Tab.
-     */
-    children: React.ReactNode;
-    /**
-     * The name of the tab. This name will be used in change events and for `initialTab`. Must match
-     * the `name` of the associated tab panel. If this property is not provided, it will default to a
-     * string representation of the the zero-based index of the Tab when it was initialized.
-     */
-    name?: string;
-    /**
-     * Optionally pass a model directly to this component. Default is to implicitly use the same
-     * model as the container component which uses React context. Only use this for advanced use-cases
-     */
-    model?: TabsModel;
-    /**
-     * Optional id. If not set, it will inherit the ID passed to the `Tabs` component and append the
-     * index at the end. Only set this for advanced cases.
-     */
-    id?: string;
-    /**
-     * Part of the ARIA specification for tabs. This attributes links a `role=tab` to a
-     * `role=tabpanel`. This value must be the same as the associated `id` attribute of the tab panel.
-     * This is automatically set by the component and should only be used in advanced cases.
-     */
-    'aria-controls'?: string;
-    /**
-     * Part of the ARIA specification for tabs. Lets screen readers know which tab is active. This
-     * should either be `true` or `undefined` and never `false`. This is automatically set by the
-     * component and should only be used in advanced cases.
-     */
-    'aria-selected'?: boolean;
-    /**
-     * Part of the ARIA specification for tabs. The currently active tab should not have a `tabIndex` set while
-     * all inactive tabs should have a `tabIndex={-1}`
-     */
-    tabIndex?: number;
-}
-export declare const Tab: import("../../common").ElementComponent<"button", TabProps>;
-//# sourceMappingURL=Tab.d.ts.map

package/ts3.5/dist/commonjs/tabs/lib/cursor/hooks.d.ts

@@ -1,39 +0,0 @@
-import React from 'react';
-export declare const orientationKeyMap: {
-    readonly horizontal: {
-        readonly ArrowLeft: "previous";
-        readonly Left: "previous";
-        readonly ArrowRight: "next";
-        readonly Right: "next";
-        readonly Home: "first";
-        readonly End: "last";
-    };
-    readonly vertical: {
-        readonly ArrowUp: "previous";
-        readonly Up: "previous";
-        readonly ArrowDown: "next";
-        readonly Down: "next";
-        readonly Home: "first";
-        readonly End: "last";
-    };
-};
-/**
- * Handles the roving focus behavior of a Cursor model. It should be added to the element
- * representing the list. It does not handle the tabIndex.
- *
- * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
- */
-export declare const useRovingFocusList: (model: import("../../../common").Model<import("./useCursorModel").CursorState, import("./useCursorModel").CursorEvents>, elemProps?: {}) => {
-    onKeyDown(event: React.KeyboardEvent<Element>): void;
-};
-/**
- * Handles the roving focus behavior of a Cursor model. It should be added to the element
- * representing a list item. It does not handle the tabIndex.
- *
- * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
- */
-export declare const useRovingFocusItem: ({ state }: import("../../../common").Model<import("./useCursorModel").CursorState, import("./useCursorModel").CursorEvents>, elemProps?: {}) => {
-    onFocus(event: React.FocusEvent<Element>): void;
-    onBlur(event: React.FocusEvent<Element>): void;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/ts3.5/dist/commonjs/tabs/lib/hooks.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-/**
- * Reset the cursor to the active tab when the tab list looses focus
- */
-export declare const useResetCursorOnBlur: ({ state, events }: import("../../common").Model<import("./useTabsModel").TabsState, import("./useTabsModel").TabsEvents>, elemProps?: {}) => {
-    onKeyDown(event: React.KeyboardEvent<Element>): void;
-    onFocus(): void;
-    onBlur(): void;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/ts3.5/dist/commonjs/tabs/lib/list/hooks.d.ts

@@ -1,11 +0,0 @@
-import React from 'react';
-/**
- * Handle list registration. Returns an identifier used to identify this item in the list
- * @param model A ListModel
- * @param localRef A RefObject that will be used to register an item
- * @param id Desired identifier for the List Model. If not provided, it will fall back to the index
- * in the list
- * @param index (Optional) Specify the position of the item if the order is expected to change
- */
-export declare const useRegisterItem: ({ state, events }: import("../../../common").Model<import("./useListModel").ListState, import("./useListModel").ListEvents>, localRef: React.RefObject<any>, id?: string, index?: number | undefined) => string;
-//# sourceMappingURL=hooks.d.ts.map

package/ts3.5/dist/es6/tabs/lib/Tab.d.ts

@@ -1,49 +0,0 @@
-import * as React from 'react';
-import { TabsModel } from './useTabsModel';
-export interface TabProps {
-    /**
-     * Optionally pass index to tab item. This should be done if `Tabs.Item` components were created
-     * via a `Array::map` function. This index will ensure keyboard navigation works even if items are
-     * inserted out of order.
-     */
-    index?: number;
-    /**
-     * The label text of the Tab.
-     */
-    children: React.ReactNode;
-    /**
-     * The name of the tab. This name will be used in change events and for `initialTab`. Must match
-     * the `name` of the associated tab panel. If this property is not provided, it will default to a
-     * string representation of the the zero-based index of the Tab when it was initialized.
-     */
-    name?: string;
-    /**
-     * Optionally pass a model directly to this component. Default is to implicitly use the same
-     * model as the container component which uses React context. Only use this for advanced use-cases
-     */
-    model?: TabsModel;
-    /**
-     * Optional id. If not set, it will inherit the ID passed to the `Tabs` component and append the
-     * index at the end. Only set this for advanced cases.
-     */
-    id?: string;
-    /**
-     * Part of the ARIA specification for tabs. This attributes links a `role=tab` to a
-     * `role=tabpanel`. This value must be the same as the associated `id` attribute of the tab panel.
-     * This is automatically set by the component and should only be used in advanced cases.
-     */
-    'aria-controls'?: string;
-    /**
-     * Part of the ARIA specification for tabs. Lets screen readers know which tab is active. This
-     * should either be `true` or `undefined` and never `false`. This is automatically set by the
-     * component and should only be used in advanced cases.
-     */
-    'aria-selected'?: boolean;
-    /**
-     * Part of the ARIA specification for tabs. The currently active tab should not have a `tabIndex` set while
-     * all inactive tabs should have a `tabIndex={-1}`
-     */
-    tabIndex?: number;
-}
-export declare const Tab: import("../../common").ElementComponent<"button", TabProps>;
-//# sourceMappingURL=Tab.d.ts.map

package/ts3.5/dist/es6/tabs/lib/cursor/hooks.d.ts

@@ -1,39 +0,0 @@
-import React from 'react';
-export declare const orientationKeyMap: {
-    readonly horizontal: {
-        readonly ArrowLeft: "previous";
-        readonly Left: "previous";
-        readonly ArrowRight: "next";
-        readonly Right: "next";
-        readonly Home: "first";
-        readonly End: "last";
-    };
-    readonly vertical: {
-        readonly ArrowUp: "previous";
-        readonly Up: "previous";
-        readonly ArrowDown: "next";
-        readonly Down: "next";
-        readonly Home: "first";
-        readonly End: "last";
-    };
-};
-/**
- * Handles the roving focus behavior of a Cursor model. It should be added to the element
- * representing the list. It does not handle the tabIndex.
- *
- * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
- */
-export declare const useRovingFocusList: (model: import("../../../common").Model<import("./useCursorModel").CursorState, import("./useCursorModel").CursorEvents>, elemProps?: {}) => {
-    onKeyDown(event: React.KeyboardEvent<Element>): void;
-};
-/**
- * Handles the roving focus behavior of a Cursor model. It should be added to the element
- * representing a list item. It does not handle the tabIndex.
- *
- * @see https://www.w3.org/TR/wai-aria-practices/#kbd_roving_tabindex
- */
-export declare const useRovingFocusItem: ({ state }: import("../../../common").Model<import("./useCursorModel").CursorState, import("./useCursorModel").CursorEvents>, elemProps?: {}) => {
-    onFocus(event: React.FocusEvent<Element>): void;
-    onBlur(event: React.FocusEvent<Element>): void;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/ts3.5/dist/es6/tabs/lib/hooks.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-/**
- * Reset the cursor to the active tab when the tab list looses focus
- */
-export declare const useResetCursorOnBlur: ({ state, events }: import("../../common").Model<import("./useTabsModel").TabsState, import("./useTabsModel").TabsEvents>, elemProps?: {}) => {
-    onKeyDown(event: React.KeyboardEvent<Element>): void;
-    onFocus(): void;
-    onBlur(): void;
-};
-//# sourceMappingURL=hooks.d.ts.map

package/ts3.5/dist/es6/tabs/lib/list/hooks.d.ts

@@ -1,11 +0,0 @@
-import React from 'react';
-/**
- * Handle list registration. Returns an identifier used to identify this item in the list
- * @param model A ListModel
- * @param localRef A RefObject that will be used to register an item
- * @param id Desired identifier for the List Model. If not provided, it will fall back to the index
- * in the list
- * @param index (Optional) Specify the position of the item if the order is expected to change
- */
-export declare const useRegisterItem: ({ state, events }: import("../../../common").Model<import("./useListModel").ListState, import("./useListModel").ListEvents>, localRef: React.RefObject<any>, id?: string, index?: number | undefined) => string;
-//# sourceMappingURL=hooks.d.ts.map