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

package/ts3.5/dist/es6/form-field/lib/FormFieldHint.d.ts

@@ -0,0 +1,13 @@
+import React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { Box } from '@workday/canvas-kit-labs-react/common';
+import { FormFieldModel } from './hooks';
+export interface FormFieldHintProps extends ExtractProps<typeof Box, never> {
+    model?: FormFieldModel;
+    /**
+     * Hint text to show to the user regarding the Error/Alert
+     */
+    children?: React.ReactNode;
+}
+export declare const FormFieldHint: import("@workday/canvas-kit-react/common").ElementComponent<"p", FormFieldHintProps>;
+//# sourceMappingURL=FormFieldHint.d.ts.map

package/ts3.5/dist/es6/form-field/lib/FormFieldInput.d.ts

@@ -0,0 +1,8 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { Box } from '@workday/canvas-kit-labs-react/common';
+import { FormFieldModel } from './hooks';
+export interface FormFieldInputProps extends ExtractProps<typeof Box, never> {
+    model?: FormFieldModel;
+}
+export declare const FormFieldInput: import("@workday/canvas-kit-react/common").ElementComponent<"input", FormFieldInputProps>;
+//# sourceMappingURL=FormFieldInput.d.ts.map

package/ts3.5/dist/es6/form-field/lib/FormFieldLabel.d.ts

@@ -0,0 +1,18 @@
+import React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { HStack, StackSpacing } from '@workday/canvas-kit-labs-react/layout';
+import { FormFieldModel } from './hooks';
+export interface FormFieldLabelProps extends Omit<ExtractProps<typeof HStack, never>, 'spacing'> {
+    model?: FormFieldModel;
+    /**
+     * The text of the label.
+     */
+    children: React.ReactNode;
+    /**
+     * When the input is required, this is spacing between label and asterisk.
+     * @default xxxs
+     */
+    spacing?: StackSpacing;
+}
+export declare const FormFieldLabel: import("@workday/canvas-kit-react/common").ElementComponent<"label", FormFieldLabelProps>;
+//# sourceMappingURL=FormFieldLabel.d.ts.map

package/ts3.5/dist/es6/form-field/lib/hooks/index.d.ts

@@ -0,0 +1,6 @@
+export * from './useFormFieldOrientation';
+export * from './useFormFieldHint';
+export * from './useFormFieldInput';
+export * from './useFormFieldModel';
+export * from './useFormFieldLabel';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/form-field/lib/hooks/useFormFieldHint.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `Hint` component.
+ * Used by the FormField.Hint subcomponent and other input type components
+ */
+export declare const useFormFieldHint: <P extends {}, R>(model: import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | 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=useFormFieldHint.d.ts.map

package/ts3.5/dist/es6/form-field/lib/hooks/useFormFieldInput.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to an `Input` component.
+ * Used by the FormField.Input subcomponent and other input type components
+ */
+export declare const useFormFieldInput: <P extends {}, R>(model: import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | undefined;
+}, {}>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    required: boolean | undefined;
+    'aria-invalid': boolean | undefined;
+    'aria-describedby': string;
+    id: string;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useFormFieldInput.d.ts.map

package/ts3.5/dist/es6/form-field/lib/hooks/useFormFieldLabel.d.ts

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

package/ts3.5/dist/es6/form-field/lib/hooks/useFormFieldModel.d.ts

@@ -0,0 +1,36 @@
+import { Model, ToModelConfig } from '@workday/canvas-kit-react/common';
+declare type FormFieldState = {
+    /**
+     * Optional flag to denote if this field has an error to display. When true the `FormField.Input` will have
+     * `required` set to true, and usually some subcomponents will have a error color applied.
+     * @default false
+     */
+    hasError?: boolean;
+    /**
+     * Optional `id` provided to `FormField`'s subcomponents as HTML attributes:
+     * - `FormField.Input` will set `aria-describedby` to `hint-${id}`
+     * - `FormField.Input` will set `id` to `input-${id}`
+     * - `FormField.Label` will set `htmlFor` to `input-${id}`
+     * - `FormField.Hint` will set `id` to `hint-${id}`
+     *
+     * If a value is not provided, a unique id will be automatically created by `useUniqueId()`.
+     * @default `useUniqueId()`
+     */
+    id?: string;
+    /**
+     * Optional flag to denote if this field is required. When true the `FormField.Input` will have
+     * `required` set to true, and an asterisk will be appended to the `FormField.Label`.
+     * @default false
+     */
+    isRequired?: boolean;
+};
+declare type FormFieldEvents = {};
+export declare type FormFieldModel = Model<FormFieldState, FormFieldEvents>;
+declare const formFieldEventMap: {
+    guards: {};
+    callbacks: {};
+};
+export declare type FormFieldModelConfig = FormFieldState & Partial<ToModelConfig<FormFieldState, FormFieldEvents, typeof formFieldEventMap>>;
+export declare const useFormFieldModel: (config?: FormFieldModelConfig) => Model<FormFieldState, FormFieldEvents>;
+export {};
+//# sourceMappingURL=useFormFieldModel.d.ts.map

package/ts3.5/dist/es6/form-field/lib/hooks/useFormFieldOrientation.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Adds the necessary layout props to a `FormField` component.
+ */
+export declare const useFormFieldOrientation: (orientation: "horizontal" | "vertical") => {
+    flexDirection: "column" | "column-reverse" | "row" | "row-reverse" | undefined;
+    alignItems: (string & {}) | "-moz-initial" | "inherit" | "initial" | "revert" | "unset" | "stretch" | "center" | "end" | "flex-end" | "flex-start" | "start" | "baseline" | "normal" | "self-end" | "self-start" | undefined;
+    spacing: number | (string & {}) | "s" | "zero" | "m" | "l" | "xl" | "xxxs" | "xxs" | "xs" | "xxl" | "xxxl";
+};
+//# sourceMappingURL=useFormFieldOrientation.d.ts.map

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

@@ -1,6 +1,9 @@
 export * from './breadcrumbs';
 export * from './color-picker';
+export * from './form-field';
 export * from './menu';
 export * from './select';
 export * from './side-panel';
+export * from './text-area';
+export * from './text-input';
 //# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/select/lib/SelectBase.d.ts

@@ -17,6 +17,9 @@ export interface NormalizedOption extends Option {
     id: string;
     label: string;
 }
+export interface RenderSelectedFunction {
+    (option: NormalizedOption): React.ReactNode;
+}
 export interface RenderableOption extends NormalizedOption {
     focused: boolean;
     selected: boolean;
@@ -47,6 +50,22 @@ export interface CoreSelectBaseProps extends Themeable, GrowthBehavior, Pick<Rea
      * @default defaultRenderOption
      */
     renderOption?: RenderOptionFunction;
+    /**
+     * The function called to render the selected option.
+     *
+     * The `option` argument passed to the function is an object which contains the following:
+     *
+     * * `data: object` (data object carried over from the corresponding option originally passed into the component)
+     * * `disabled: boolean`
+     * * `id: string`
+     * * `label: string`
+     * * `value: string`
+     *
+     * If you omit the `renderSelected` prop, each option will be rendered using a `defaultRenderSelected` function provided by the component.
+     *
+     * @default defaultRenderSelected
+     */
+    renderSelected?: RenderSelectedFunction;
     /**
      * The value of the Select.
      */
@@ -118,6 +137,6 @@ export interface SelectBaseProps extends CoreSelectBaseProps, StyledType {
 }
 export declare const buttonBorderWidth = 1;
 export declare const buttonDefaultWidth = 280;
-declare const SelectBase: ({ "aria-labelledby": ariaLabelledBy, "aria-required": ariaRequired, as, forwardedButtonRef, localButtonRef, disabled, error, focusedOptionIndex, grow, inputRef, menuPlacement, menuRef, menuVisibility, onChange, onKeyDown, onClose, onOptionSelection, options, renderOption, required, shouldMenuAutoFlip, shouldMenuAutoFocus, value, ...elemProps }: SelectBaseProps) => JSX.Element;
+declare const SelectBase: ({ "aria-labelledby": ariaLabelledBy, "aria-required": ariaRequired, as, forwardedButtonRef, localButtonRef, disabled, error, focusedOptionIndex, grow, inputRef, menuPlacement, menuRef, menuVisibility, onChange, onKeyDown, onClose, onOptionSelection, options, renderOption, renderSelected, required, shouldMenuAutoFlip, shouldMenuAutoFocus, value, ...elemProps }: SelectBaseProps) => JSX.Element;
 export default SelectBase;
 //# sourceMappingURL=SelectBase.d.ts.map

package/ts3.5/dist/es6/side-panel/lib/hooks.d.ts

@@ -9,12 +9,12 @@ export interface UseSidePanelProps {
     initialExpanded?: boolean;
     /**
      * sets the `id` for the panel
-     * @default `uuid`-generated string
+     * @default unique identifier
      */
     panelId?: string;
     /**
      * sets the `id` for the label
-     * @default `uuid`-generated string
+     * @default unique identifier
      */
     labelId?: string;
 }
@@ -28,12 +28,12 @@ export interface PanelProps {
     expanded: boolean;
     /**
      * the accessible `id`
-     * - this will either be a `uuid`-generated value or the `panelId` provided in the config
+     * - this will either be a unique identifier value or the `panelId` provided in the config
      */
     id: string;
     /**
      * the accessible label `id`
-     * - this will either be a `uuid`-generated value or the `labelId` provided in the config
+     * - this will either be a unique identifier value or the `labelId` provided in the config
      */
     'aria-labelledby': string;
     /**
@@ -45,14 +45,14 @@ export interface PanelProps {
 export interface LabelProps {
     /**
      * the accessible `id`
-     * - this will either be a `uuid`-generated value or the `labelId` provided in the config
+     * - this will either be a unique identifier value or the `labelId` provided in the config
      */
     id: string;
 }
 export interface ControlProps {
     /**
      * the accessible `id` that connects the panel to this control
-     * - this will either be a `uuid`-generated value or the `panelId` provided in the config
+     * - this will either be a unique identifier value or the `panelId` provided in the config
      */
     'aria-controls': string;
     /**
@@ -62,7 +62,7 @@ export interface ControlProps {
     'aria-expanded': boolean;
     /**
      * the accessible label `id`
-     * - this will either be a `uuid`-generated value or the `labelId` provided in the config
+     * - this will either be a unique identifier value or the `labelId` provided in the config
      */
     'aria-labelledby': string;
     /**

package/ts3.5/dist/es6/text-area/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/TextArea';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/text-area/lib/TextArea.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+import { TextAreaModel } from './hooks';
+export declare const TextAreaModelContext: React.Context<import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | undefined;
+}, {}>>;
+export interface TextAreaProps extends ExtractProps<typeof FormField, never> {
+    model?: TextAreaModel;
+    /**
+     * Children of the Text Input. Should contain a `<TextArea.Field>`, a `<TextArea.Label>` and an optional `<TextArea.Hint>`
+     */
+    children: React.ReactNode;
+}
+export declare const TextArea: import("@workday/canvas-kit-react/common").Component<TextAreaProps> & {
+    Field: import("@workday/canvas-kit-react/common").ElementComponent<"textarea", import("./TextAreaField").TextAreaFieldProps>;
+    Label: import("@workday/canvas-kit-react/common").ElementComponent<"label", import("../../form-field/lib/FormFieldLabel").FormFieldLabelProps>;
+    Hint: import("@workday/canvas-kit-react/common").ElementComponent<"p", import("../../form-field/lib/FormFieldHint").FormFieldHintProps>;
+};
+//# sourceMappingURL=TextArea.d.ts.map

package/ts3.5/dist/es6/text-area/lib/TextAreaField.d.ts

@@ -0,0 +1,8 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+import { TextAreaModel } from './hooks';
+export interface TextAreaFieldProps extends ExtractProps<typeof FormField.Input, never> {
+    model?: TextAreaModel;
+}
+export declare const TextAreaField: import("@workday/canvas-kit-react/common").ElementComponent<"textarea", TextAreaFieldProps>;
+//# sourceMappingURL=TextAreaField.d.ts.map

package/ts3.5/dist/es6/text-area/lib/TextAreaHint.d.ts

@@ -0,0 +1,5 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+export declare type TextAreaHintProps = ExtractProps<typeof FormField.Hint, never>;
+export declare const TextAreaHint: import("@workday/canvas-kit-react/common").ElementComponent<"p", import("../../form-field/lib/FormFieldHint").FormFieldHintProps>;
+//# sourceMappingURL=TextAreaHint.d.ts.map

package/ts3.5/dist/es6/text-area/lib/TextAreaLabel.d.ts

@@ -0,0 +1,5 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+export declare type TextAreaLabelProps = ExtractProps<typeof FormField.Label, never>;
+export declare const TextAreaLabel: import("@workday/canvas-kit-react/common").ElementComponent<"label", import("../../form-field/lib/FormFieldLabel").FormFieldLabelProps>;
+//# sourceMappingURL=TextAreaLabel.d.ts.map

package/ts3.5/dist/es6/text-area/lib/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from './useTextAreaModel';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/text-area/lib/hooks/useTextAreaModel.d.ts

@@ -0,0 +1,8 @@
+import { FormFieldModel } from '@workday/canvas-kit-preview-react/form-field';
+export declare const useTextAreaModel: (config?: import("../../../form-field").FormFieldModelConfig) => import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | undefined;
+}, {}>;
+export declare type TextAreaModel = FormFieldModel;
+//# sourceMappingURL=useTextAreaModel.d.ts.map

package/ts3.5/dist/es6/text-input/index.d.ts

@@ -0,0 +1,3 @@
+export * from './lib/TextInput';
+export * from './lib/hooks';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/text-input/lib/TextInput.d.ts

@@ -0,0 +1,22 @@
+import React from 'react';
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+import { TextInputModel } from './hooks';
+export declare const TextInputModelContext: React.Context<import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | undefined;
+}, {}>>;
+export interface TextInputProps extends ExtractProps<typeof FormField, never> {
+    model?: TextInputModel;
+    /**
+     * Children of the Text Input. Should contain a `<TextInput.Field>`, a `<TextInput.Label>` and an optional `<TextInput.Hint>`
+     */
+    children: React.ReactNode;
+}
+export declare const TextInput: import("@workday/canvas-kit-react/common").Component<TextInputProps> & {
+    Field: import("@workday/canvas-kit-react/common").ElementComponent<"input", import("./TextInputField").TextInputFieldProps>;
+    Label: import("@workday/canvas-kit-react/common").ElementComponent<"label", import("../../form-field/lib/FormFieldLabel").FormFieldLabelProps>;
+    Hint: import("@workday/canvas-kit-react/common").ElementComponent<"p", import("../../form-field/lib/FormFieldHint").FormFieldHintProps>;
+};
+//# sourceMappingURL=TextInput.d.ts.map

package/ts3.5/dist/es6/text-input/lib/TextInputField.d.ts

@@ -0,0 +1,8 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+import { TextInputModel } from './hooks';
+export interface TextInputFieldProps extends ExtractProps<typeof FormField.Input, never> {
+    model?: TextInputModel;
+}
+export declare const TextInputField: import("@workday/canvas-kit-react/common").ElementComponent<"input", TextInputFieldProps>;
+//# sourceMappingURL=TextInputField.d.ts.map

package/ts3.5/dist/es6/text-input/lib/TextInputHint.d.ts

@@ -0,0 +1,5 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+export declare type TextInputHintProps = ExtractProps<typeof FormField.Hint, never>;
+export declare const TextInputHint: import("@workday/canvas-kit-react/common").ElementComponent<"p", import("../../form-field/lib/FormFieldHint").FormFieldHintProps>;
+//# sourceMappingURL=TextInputHint.d.ts.map

package/ts3.5/dist/es6/text-input/lib/TextInputLabel.d.ts

@@ -0,0 +1,5 @@
+import { ExtractProps } from '@workday/canvas-kit-react/common';
+import { FormField } from '@workday/canvas-kit-preview-react/form-field';
+export declare type TextInputLabelProps = ExtractProps<typeof FormField.Label, never>;
+export declare const TextInputLabel: import("@workday/canvas-kit-react/common").ElementComponent<"label", import("../../form-field/lib/FormFieldLabel").FormFieldLabelProps>;
+//# sourceMappingURL=TextInputLabel.d.ts.map

package/ts3.5/dist/es6/text-input/lib/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useTextInputField';
+export * from './useTextInputModel';
+//# sourceMappingURL=index.d.ts.map

package/ts3.5/dist/es6/text-input/lib/hooks/useTextInputField.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="@emotion/core" />
+/**
+ * Adds the necessary props to a `Field` component. Used by the TextInput.Field subcomponent.
+ */
+export declare const useTextInputField: <P extends {}, R>(model: import("@workday/canvas-kit-react/common").Model<any, any>, elemProps?: P | undefined, ref?: ((instance: R | null) => void) | import("react").RefObject<R> | null | undefined) => {
+    type: string;
+} & P & (R extends HTMLOrSVGElement ? {
+    ref: import("react").Ref<R>;
+} : {});
+//# sourceMappingURL=useTextInputField.d.ts.map

package/ts3.5/dist/es6/text-input/lib/hooks/useTextInputModel.d.ts

@@ -0,0 +1,8 @@
+import { FormFieldModel } from '@workday/canvas-kit-preview-react/form-field';
+export declare const useTextInputModel: (config?: import("../../../form-field").FormFieldModelConfig) => import("@workday/canvas-kit-react/common").Model<{
+    hasError?: boolean | undefined;
+    id?: string | undefined;
+    isRequired?: boolean | undefined;
+}, {}>;
+export declare type TextInputModel = FormFieldModel;
+//# sourceMappingURL=useTextInputModel.d.ts.map