@workday/canvas-kit-react 6.0.0-alpha.0-next.33 → 6.0.0-alpha.0-next.39

package/ts3.5/dist/commonjs/common/lib/styles/hideMouseFocus.d.ts

@@ -1,8 +1,9 @@
-import { CSSObject, Interpolation } from '@emotion/core';
+import { Interpolation } from '@emotion/core';
+import { CSSProperties } from '@workday/canvas-kit-react/tokens';
 /**
  * A utility to hide the default canvas style focus ring when using mouse input.
  * Requires wrapping your components in an InputProvider component.
  */
-export declare const hideMouseFocus: CSSObject;
+export declare const hideMouseFocus: CSSProperties;
 export declare const mouseFocusBehavior: (selectors: Record<string, Interpolation<undefined>>) => Record<string, Interpolation<undefined>>;
 //# sourceMappingURL=hideMouseFocus.d.ts.map

package/ts3.5/dist/commonjs/pagination/lib/Pagination/common/Stack.d.ts

@@ -16,7 +16,7 @@ declare type Options = {
     shouldUseRTL: boolean;
 };
 export declare const useStack: ({ direction, shouldUseRTL, spacing }: Options) => {
-    flexDirection: StackDirection;
+    flexDirection: import("@workday/canvas-kit-labs-react/layout").StackDirection;
     "& > *:not(style) ~ *:not(style)": {
         marginTop: "0px" | "4px" | "8px" | "12px" | "16px" | "24px" | "32px" | "40px" | "64px" | "80px";
     } | {

package/ts3.5/dist/commonjs/popup/lib/hooks/useReturnFocus.d.ts

@@ -3,7 +3,7 @@
  * `useInitialFocus`. This should be used with `useFocusRedirect` or `useFocusTrap` for a complete
  * focus management solution.
  *
- * This should ble used on popup elements that use `useInitialFocus`.
+ * This should be used on popup elements that use `useInitialFocus`.
  */
 export declare const useReturnFocus: (model: import("../../../common").Model<import("./usePopupModel").PopupState, import("./usePopupModel").PopupEvents>, elemProps?: {}) => {};
 //# sourceMappingURL=useReturnFocus.d.ts.map

package/ts3.5/dist/commonjs/tooltip/lib/Tooltip.d.ts

@@ -37,6 +37,14 @@ export interface TooltipProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
      * @default 'label'
      */
     type?: 'label' | 'describe' | 'muted';
+    /**
+     * Amount of time (in ms) to delay before showing the tooltip
+     */
+    showDelay?: number;
+    /**
+     * Amount of time (in ms) to delay before hiding the tooltip
+     */
+    hideDelay?: number;
 }
-export declare const Tooltip: ({ type, placement, title, children, ...elemProps }: TooltipProps) => JSX.Element;
+export declare const Tooltip: ({ type, placement, title, children, showDelay, hideDelay, ...elemProps }: TooltipProps) => JSX.Element;
 //# sourceMappingURL=Tooltip.d.ts.map

package/ts3.5/dist/commonjs/tooltip/lib/useTooltip.d.ts

@@ -3,7 +3,7 @@ import * as React from 'react';
  * Convenience hook for creating components with tooltips. It will return an object of properties to mix
  * into a target, popper and tooltip
  */
-export declare function useTooltip<T extends Element = Element>({ type, titleText, }?: {
+export declare function useTooltip<T extends Element = Element>({ type, titleText, showDelay, hideDelay, }?: {
     /**
      * Determines the tooltip type for accessibility.
      *
@@ -25,6 +25,14 @@ export declare function useTooltip<T extends Element = Element>({ type, titleTex
      * The content of the `aria-label` if `type` is `label.
      */
     titleText?: string;
+    /**
+     * Amount of time (in ms) to delay before showing the tooltip
+     */
+    showDelay?: number;
+    /**
+     * Amount of time (in ms) to delay before hiding the tooltip
+     */
+    hideDelay?: number;
 }): {
     /** Mix these properties into the target element. **Must be an Element** */
     targetProps: {

package/ts3.5/dist/es6/banner/index.d.ts

@@ -1,5 +1,3 @@
-import Banner from './lib/Banner';
-export default Banner;
-export { Banner };
 export * from './lib/Banner';
+export * from './lib/hooks/';
 //# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/banner/lib/Banner.d.ts

@@ -1,38 +1,22 @@
 import * as React from 'react';
-import { ErrorType, Themeable } from '@workday/canvas-kit-react/common';
-export declare enum BannerVariant {
-    Full = 0,
-    Sticky = 1
-}
-export interface BannerProps extends Themeable, React.ButtonHTMLAttributes<HTMLButtonElement> {
-    /**
-     * The function called when the Banner is clicked.
-     */
-    onClick?: (e: React.MouseEvent<HTMLButtonElement>) => void;
-    /**
-     * The label of the Banner.
-     */
-    label?: React.ReactNode;
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { Flex } from '@workday/canvas-kit-labs-react/layout';
+import { BannerModel, BannerModelConfig } from './hooks';
+export declare const BannerModelContext: React.Context<import("../../common").Model<{
+    hasError?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    id?: string | undefined;
+}, {}>>;
+export interface BannerProps extends BannerModelConfig, ExtractProps<typeof Flex, never> {
+    model?: BannerModel;
     /**
-     * The variant of the Banner. Accepts `Full` or `Sticky`.
-     * @default BannerVariant.Full
+     * Children of the Banner. Should contain a `<Banner.Label>` a <Banner.Icon> and an optional `<Banner.ActionText>`
      */
-    variant?: BannerVariant;
-    /**
-     * The type of error associated with the Banner (if applicable).
-     * @default ErrorType.Alert
-     */
-    error?: ErrorType;
-    /**
-     * The text of the Banner action. This prop is also used as the aria-label for the action in the banner
-     * @default 'View All'
-     */
-    actionText?: string;
-}
-declare class Banner extends React.Component<BannerProps> {
-    static Variant: typeof BannerVariant;
-    static ErrorType: typeof ErrorType;
-    render(): JSX.Element;
+    children?: React.ReactNode;
 }
-export default Banner;
+export declare const Banner: import("../../common").ElementComponent<"button", BannerProps> & {
+    Icon: import("../../common").ElementComponent<"span", import("./BannerIcon").BannerIconProps>;
+    Label: import("../../common").ElementComponent<"div", import("./BannerLabel").BannerLabelProps>;
+    ActionText: import("../../common").ElementComponent<"span", import("./BannerActionText").BannerActionTextProps>;
+};
 //# sourceMappingURL=Banner.d.ts.map

package/ts3.5/dist/es6/banner/lib/BannerActionText.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { Box } from '@workday/canvas-kit-labs-react/common';
+import { BannerModel } from './hooks';
+export interface BannerActionTextProps extends ExtractProps<typeof Box, never> {
+    model?: BannerModel;
+    /**
+     * The text of the Banner action.
+     * @default 'View All'
+     */
+    children?: React.ReactNode;
+}
+export declare const BannerActionText: import("../../common").ElementComponent<"span", BannerActionTextProps>;
+//# sourceMappingURL=BannerActionText.d.ts.map

package/ts3.5/dist/es6/banner/lib/BannerIcon.d.ts

@@ -0,0 +1,14 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { SystemIcon } from '@workday/canvas-kit-react/icon';
+import { CanvasSystemIcon } from '@workday/design-assets-types';
+import { BannerModel } from './hooks';
+export interface BannerIconProps extends Omit<ExtractProps<typeof SystemIcon, never>, 'icon'> {
+    model?: BannerModel;
+    /**
+     * Icon to show next to label
+     * @default exclamationTriangleIcon or exclamationCircleIcon when hasError is true
+     */
+    icon?: CanvasSystemIcon;
+}
+export declare const BannerIcon: import("../../common").ElementComponent<"span", BannerIconProps>;
+//# sourceMappingURL=BannerIcon.d.ts.map

package/ts3.5/dist/es6/banner/lib/BannerLabel.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { Flex } from '@workday/canvas-kit-labs-react/layout';
+import { BannerModel } from './hooks';
+export interface BannerLabelProps extends ExtractProps<typeof Flex, never> {
+    model?: BannerModel;
+    /**
+     * The text of the Banner.
+     */
+    children: React.ReactNode;
+}
+export declare const BannerLabel: import("../../common").ElementComponent<"div", BannerLabelProps>;
+//# sourceMappingURL=BannerLabel.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/index.d.ts

@@ -0,0 +1,7 @@
+export * from './useBannerModel';
+export * from './useThemedPalette';
+export * from './useBannerIcon';
+export * from './useBannerLabel';
+export * from './useBannerActionText';
+export * from './useBanner';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useBanner.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `Banner` component.
+ * Used by the Banner component
+ */
+export declare const useBanner: <P extends {}, R>(model: import("../../../common").Model<{
+    hasError?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    id?: string | undefined;
+}, {}>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    'aria-describedby': string;
+    'aria-labelledby': string;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useBanner.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useBannerActionText.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `ActionText` component.
+ * Used by the Banner.ActionText subcomponent
+ */
+export declare const useBannerActionText: <P extends {}, R>(model: import("../../../common").Model<{
+    hasError?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    id?: string | undefined;
+}, {}>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    id: string;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useBannerActionText.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useBannerIcon.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `Icon` component.
+ * Used by the Banner.Icon subcomponent
+ */
+export declare const useBannerIcon: <P extends {}, R>(model: import("../../../common").Model<{
+    hasError?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    id?: string | undefined;
+}, {}>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    icon: import("@workday/design-assets-types").CanvasSystemIcon;
+    color: string | undefined;
+    colorHover: string | undefined;
+    size: number;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useBannerIcon.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useBannerLabel.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `Label` component.
+ * Used by the Banner.Label subcomponent
+ */
+export declare const useBannerLabel: <P extends {}, R>(model: import("../../../common").Model<{
+    hasError?: boolean | undefined;
+    isSticky?: boolean | undefined;
+    id?: string | undefined;
+}, {}>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    id: string;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useBannerLabel.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useBannerModel.d.ts

@@ -0,0 +1,37 @@
+import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
+declare type BannerState = {
+    /**
+     * Optional flag to denote the banner has an error to display. When true the default `Banner.Icon`
+     * will be `exclamationCircleIcon`, and a themed error color will be applied.
+     * @default false
+     */
+    hasError?: boolean;
+    /**
+     * Optional flag to denote the banner is stuck to the side of the screen. When true the default `Banner.ActionText`
+     * will be hidden, and some basic styles will be applied.
+     * You will still need to manually set the css `position` value.
+     * @default false
+     */
+    isSticky?: boolean;
+    /**
+     * Optional `id` provided to `Banner`'s subcomponents as HTML attributes:
+     * - `Banner` will set `aria-describedby` to `label-${id}`
+     * - `Banner` will set `aria-label` to `action-${id}`
+     * - `Banner.Label` will set `id` to `label-${id}`
+     * - `Banner.ActionText` will set `id` to `action-${id}`
+     *
+     * If a value is not provided, a unique id will be automatically created by `useUniqueId()`.
+     * @default `useUniqueId()`
+     */
+    id?: string;
+};
+declare type BannerEvents = {};
+export declare type BannerModel = Model<BannerState, BannerEvents>;
+declare const BannerEventMap: {
+    guards: {};
+    callbacks: {};
+};
+export declare type BannerModelConfig = BannerState & Partial<ToModelConfig<BannerState, BannerEvents, typeof BannerEventMap>>;
+export declare const useBannerModel: (config?: BannerModelConfig) => Model<BannerState, BannerEvents>;
+export {};
+//# sourceMappingURL=useBannerModel.d.ts.map

package/ts3.5/dist/es6/banner/lib/hooks/useThemedPalette.d.ts

@@ -0,0 +1,11 @@
+import { EmotionCanvasTheme } from '@workday/canvas-kit-react/common';
+declare type paletteSelection = Exclude<keyof EmotionCanvasTheme['canvas']['palette'], 'common'>;
+interface BackgroundColors {
+    normal?: string;
+    hover?: string;
+    contrast?: string;
+}
+export declare function getPaletteColors(type: paletteSelection, theme: EmotionCanvasTheme): BackgroundColors;
+export declare const useThemedPalette: (type: "alert" | "error" | "primary" | "success" | "neutral") => BackgroundColors;
+export {};
+//# sourceMappingURL=useThemedPalette.d.ts.map

package/ts3.5/dist/es6/button/lib/IconButton.d.ts

@@ -3,9 +3,12 @@ import { Themeable } from '@workday/canvas-kit-react/common';
 import { CanvasSystemIcon } from '@workday/design-assets-types';
 export interface IconButtonProps extends Themeable {
     /**
-     * The accessibility label to indicate the action triggered by clicking the IconButton.
+     * The accessibility label to indicate the action triggered by clicking the IconButton. This is optional because there are
+     * instances where an Icon Button might already have an `aria-labelledby`. In a case where an `aria-labelledby` is provided
+     * it will take precedence over the `aria-label` as explained here: https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/ARIA_Techniques/Using_the_aria-labelledby_attribute
+     * We highly encourage consumers to either provide an `aria-label` OR an `aria-labelledby`
      */
-    'aria-label': string;
+    'aria-label'?: string;
     /**
      * The type of the IconButton.
      * @default 'circle'

package/ts3.5/dist/es6/common/lib/styles/hideMouseFocus.d.ts

@@ -1,8 +1,9 @@
-import { CSSObject, Interpolation } from '@emotion/core';
+import { Interpolation } from '@emotion/core';
+import { CSSProperties } from '@workday/canvas-kit-react/tokens';
 /**
  * A utility to hide the default canvas style focus ring when using mouse input.
  * Requires wrapping your components in an InputProvider component.
  */
-export declare const hideMouseFocus: CSSObject;
+export declare const hideMouseFocus: CSSProperties;
 export declare const mouseFocusBehavior: (selectors: Record<string, Interpolation<undefined>>) => Record<string, Interpolation<undefined>>;
 //# sourceMappingURL=hideMouseFocus.d.ts.map

package/ts3.5/dist/es6/pagination/lib/Pagination/common/Stack.d.ts

@@ -16,7 +16,7 @@ declare type Options = {
     shouldUseRTL: boolean;
 };
 export declare const useStack: ({ direction, shouldUseRTL, spacing }: Options) => {
-    flexDirection: StackDirection;
+    flexDirection: import("@workday/canvas-kit-labs-react/layout").StackDirection;
     "& > *:not(style) ~ *:not(style)": {
         marginTop: "0px" | "4px" | "8px" | "12px" | "16px" | "24px" | "32px" | "40px" | "64px" | "80px";
     } | {

package/ts3.5/dist/es6/popup/lib/hooks/useReturnFocus.d.ts

@@ -3,7 +3,7 @@
  * `useInitialFocus`. This should be used with `useFocusRedirect` or `useFocusTrap` for a complete
  * focus management solution.
  *
- * This should ble used on popup elements that use `useInitialFocus`.
+ * This should be used on popup elements that use `useInitialFocus`.
  */
 export declare const useReturnFocus: (model: import("../../../common").Model<import("./usePopupModel").PopupState, import("./usePopupModel").PopupEvents>, elemProps?: {}) => {};
 //# sourceMappingURL=useReturnFocus.d.ts.map

package/ts3.5/dist/es6/tooltip/lib/Tooltip.d.ts

@@ -37,6 +37,14 @@ export interface TooltipProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
      * @default 'label'
      */
     type?: 'label' | 'describe' | 'muted';
+    /**
+     * Amount of time (in ms) to delay before showing the tooltip
+     */
+    showDelay?: number;
+    /**
+     * Amount of time (in ms) to delay before hiding the tooltip
+     */
+    hideDelay?: number;
 }
-export declare const Tooltip: ({ type, placement, title, children, ...elemProps }: TooltipProps) => JSX.Element;
+export declare const Tooltip: ({ type, placement, title, children, showDelay, hideDelay, ...elemProps }: TooltipProps) => JSX.Element;
 //# sourceMappingURL=Tooltip.d.ts.map

package/ts3.5/dist/es6/tooltip/lib/useTooltip.d.ts

@@ -3,7 +3,7 @@ import * as React from 'react';
  * Convenience hook for creating components with tooltips. It will return an object of properties to mix
  * into a target, popper and tooltip
  */
-export declare function useTooltip<T extends Element = Element>({ type, titleText, }?: {
+export declare function useTooltip<T extends Element = Element>({ type, titleText, showDelay, hideDelay, }?: {
     /**
      * Determines the tooltip type for accessibility.
      *
@@ -25,6 +25,14 @@ export declare function useTooltip<T extends Element = Element>({ type, titleTex
      * The content of the `aria-label` if `type` is `label.
      */
     titleText?: string;
+    /**
+     * Amount of time (in ms) to delay before showing the tooltip
+     */
+    showDelay?: number;
+    /**
+     * Amount of time (in ms) to delay before hiding the tooltip
+     */
+    hideDelay?: number;
 }): {
     /** Mix these properties into the target element. **Must be an Element** */
     targetProps: {