@workday/canvas-kit-react 5.3.0-next.9 → 5.3.3

package/ts3.5/dist/commonjs/pagination/lib/Pagination/GoTo/Label.d.ts

@@ -3,6 +3,9 @@ import * as React from 'react';
 import { PaginationModel } from '../types';
 export interface GoToLabelProps extends React.LabelHTMLAttributes<HTMLLabelElement> {
     model: PaginationModel;
+    /**
+     * Accepts child elements or a render prop.
+     */
     children?: (model: PaginationModel) => React.ReactNode | React.ReactNode;
 }
 export declare const GoToLabel: ({ css: cssProp, model, children, ...elemProps }: GoToLabelProps) => JSX.Element;

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

@@ -1,16 +1,55 @@
 export interface PaginationState {
+    /**
+     * The page number for the current page
+     */
     currentPage: number;
+    /**
+     * The page number for the first page
+     */
     firstPage: number;
+    /**
+     * The page number for the last page (it can also be used as a total page
+     * count)
+     */
     lastPage: number;
+    /**
+     * An array of page numbers included in the pagination range
+     */
     range: number[];
+    /**
+     * The size of the pagination range
+     */
     rangeSize: number;
 }
 export interface PaginationEvents {
+    /**
+     * Sets the current page to a given page number (no safeguards)
+     */
     setCurrentPage: (page: number) => void;
+    /**
+     * Sets the current page to the first page
+     */
     first: () => void;
+    /**
+     * Sets the current page to the last page
+     */
     last: () => void;
+    /**
+     * Increments the current page by 1
+     */
     next: () => void;
+    /**
+     * Decrements the current page by 1
+     */
     previous: () => void;
+    /**
+     * Sets the current page to a given page number (with safeguards). `goTo`
+     * is very similar to `setCurrentPage`, but it has some built-in safeguards.
+     * If the page number provided is below the first page (e.g: `0`),
+     * `currentPage` will be set to the `firstPage`. Similarly, if the number
+     * provided is larger than the `lastPage`, it will set `currentPage` to the
+     * `lastPage`.
+     */
     goTo: (page: number) => void;
 }
 export interface PaginationModel {

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

@@ -1,9 +1,28 @@
 import { PaginationModel } from './types';
 export declare type UsePaginationModelConfig = {
+    /**
+     * The page number for the last page (it can also be used as a total page
+     * count)
+     */
     lastPage: number;
+    /**
+     * The page number for the first page
+     * @default 1
+     */
     firstPage?: number;
+    /**
+     * The initial current page
+     * @default 1
+     */
     initialCurrentPage?: number;
+    /**
+     * The function called when the page changes
+     */
     onPageChange?: (pageNumber: number) => void;
+    /**
+     * The size of the pagination range
+     * @default 5
+     */
     rangeSize?: number;
 };
 export declare const usePaginationModel: ({ firstPage, initialCurrentPage, lastPage, rangeSize, onPageChange, }: UsePaginationModelConfig) => PaginationModel;

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

@@ -1,5 +1,15 @@
 import * as React from 'react';
 import { Placement } from '@workday/canvas-kit-react/popup';
+/**
+ * Look for an element within the tree for an overflow element (auto, scroll, clip, or hidden).
+ * This could be the passed element, or a descendant. If no element is found, `null` is returned.
+ */
+export declare const findOverflowElement: (element: Element) => Element | null;
+/**
+ * Look for an element within the tree for a `text-overflow` CSS property of `ellipsis`.
+ * This could be the passed element, or a descendant. If no element is found, `null` is returned.
+ */
+export declare const findEllipsisElement: (element: Element) => Element | null;
 export interface OverflowTooltipProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
     /**
      * The target (anchor element) for the Tooltip.

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/common/lib/styles/accessibleHide.d.ts

@@ -1,7 +1,7 @@
-import { CSSProperties } from '@workday/canvas-kit-react/tokens';
+import { CSSObject } from '@emotion/core';
 /**
  * A utility to hide content normal users while still making accessible to screenreaders
  * See https://a11y-101.com/development/skip-link
  */
-export declare const accessibleHide: CSSProperties;
+export declare const accessibleHide: CSSObject;
 //# sourceMappingURL=accessibleHide.d.ts.map

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

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

package/ts3.5/dist/es6/cookie-banner/lib/CookieBanner.d.ts

@@ -1,13 +1,5 @@
 import * as React from 'react';
-/**
- * ### Deprecated Cookie Banner Props
- *
- * As of Canvas Kit v6, CookieBanner is being soft-deprecated.
- * It will be hard-deprecated (completely removed) in v7. Please see the
- * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
- * for more information.
- */
-export interface DeprecatedCookieBannerProps {
+export interface CookieBannerProps {
     /**
      * If true, set the CookieBanner to the closed state.
      * @default false
@@ -32,16 +24,7 @@ export interface DeprecatedCookieBannerProps {
      */
     settingsLabel?: string;
 }
-/**
- * ### Deprecated Cookie Banner
- *
- * As of Canvas Kit v6, this component is being soft-deprecated.
- * It will be hard-deprecated (completely removed) in v7. Please see the
- * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
- * for more information.
- */
-export default class DeprecatedCookieBanner extends React.Component<DeprecatedCookieBannerProps> {
-    componentDidMount(): void;
+export default class CookieBanner extends React.Component<CookieBannerProps> {
     static DefaultNotice: string;
     render(): React.ReactNode;
 }

package/ts3.5/dist/es6/page-header/index.d.ts

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

package/ts3.5/dist/es6/page-header/lib/PageHeader.d.ts

@@ -1,13 +1,5 @@
 import * as React from 'react';
-/**
- * ### Deprecated Page Header Props
- *
- * As of Canvas Kit v6, PageHeader is being soft-deprecated.
- * It will be hard-deprecated (completely removed) in v7. Please see the
- * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
- * for more information.
- */
-export interface DeprecatedPageHeaderProps {
+export interface PageHeaderProps {
     /**
      * The text of the PageHeader title.
      */
@@ -23,16 +15,7 @@ export interface DeprecatedPageHeaderProps {
      */
     breakpoint?: number;
 }
-/**
- * ### Deprecated Page Header
- *
- * As of Canvas Kit v6, this component is being soft-deprecated.
- * It will be hard-deprecated (completely removed) in v7. Please see the
- * [migration guide](https://workday.github.io/canvas-kit/?path=/story/welcome-migration-guides-v6-0--page)
- * for more information.
- */
-export default class DeprecatedPageHeader extends React.Component<DeprecatedPageHeaderProps> {
-    componentDidMount(): void;
+export default class PageHeader extends React.Component<PageHeaderProps> {
     private renderChildren;
     render(): JSX.Element;
 }

package/ts3.5/dist/es6/pagination/lib/Pagination/GoTo/Label.d.ts

@@ -3,6 +3,9 @@ import * as React from 'react';
 import { PaginationModel } from '../types';
 export interface GoToLabelProps extends React.LabelHTMLAttributes<HTMLLabelElement> {
     model: PaginationModel;
+    /**
+     * Accepts child elements or a render prop.
+     */
     children?: (model: PaginationModel) => React.ReactNode | React.ReactNode;
 }
 export declare const GoToLabel: ({ css: cssProp, model, children, ...elemProps }: GoToLabelProps) => JSX.Element;

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

@@ -1,16 +1,55 @@
 export interface PaginationState {
+    /**
+     * The page number for the current page
+     */
     currentPage: number;
+    /**
+     * The page number for the first page
+     */
     firstPage: number;
+    /**
+     * The page number for the last page (it can also be used as a total page
+     * count)
+     */
     lastPage: number;
+    /**
+     * An array of page numbers included in the pagination range
+     */
     range: number[];
+    /**
+     * The size of the pagination range
+     */
     rangeSize: number;
 }
 export interface PaginationEvents {
+    /**
+     * Sets the current page to a given page number (no safeguards)
+     */
     setCurrentPage: (page: number) => void;
+    /**
+     * Sets the current page to the first page
+     */
     first: () => void;
+    /**
+     * Sets the current page to the last page
+     */
     last: () => void;
+    /**
+     * Increments the current page by 1
+     */
     next: () => void;
+    /**
+     * Decrements the current page by 1
+     */
     previous: () => void;
+    /**
+     * Sets the current page to a given page number (with safeguards). `goTo`
+     * is very similar to `setCurrentPage`, but it has some built-in safeguards.
+     * If the page number provided is below the first page (e.g: `0`),
+     * `currentPage` will be set to the `firstPage`. Similarly, if the number
+     * provided is larger than the `lastPage`, it will set `currentPage` to the
+     * `lastPage`.
+     */
     goTo: (page: number) => void;
 }
 export interface PaginationModel {

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

@@ -1,9 +1,28 @@
 import { PaginationModel } from './types';
 export declare type UsePaginationModelConfig = {
+    /**
+     * The page number for the last page (it can also be used as a total page
+     * count)
+     */
     lastPage: number;
+    /**
+     * The page number for the first page
+     * @default 1
+     */
     firstPage?: number;
+    /**
+     * The initial current page
+     * @default 1
+     */
     initialCurrentPage?: number;
+    /**
+     * The function called when the page changes
+     */
     onPageChange?: (pageNumber: number) => void;
+    /**
+     * The size of the pagination range
+     * @default 5
+     */
     rangeSize?: number;
 };
 export declare const usePaginationModel: ({ firstPage, initialCurrentPage, lastPage, rangeSize, onPageChange, }: UsePaginationModelConfig) => PaginationModel;

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

@@ -1,5 +1,15 @@
 import * as React from 'react';
 import { Placement } from '@workday/canvas-kit-react/popup';
+/**
+ * Look for an element within the tree for an overflow element (auto, scroll, clip, or hidden).
+ * This could be the passed element, or a descendant. If no element is found, `null` is returned.
+ */
+export declare const findOverflowElement: (element: Element) => Element | null;
+/**
+ * Look for an element within the tree for a `text-overflow` CSS property of `ellipsis`.
+ * This could be the passed element, or a descendant. If no element is found, `null` is returned.
+ */
+export declare const findEllipsisElement: (element: Element) => Element | null;
 export interface OverflowTooltipProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'title'> {
     /**
      * The target (anchor element) for the Tooltip.

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: {