@workday/canvas-kit-docs 6.0.4 → 6.1.0

package/dist/commonjs/lib/specs.js

@@ -5395,6 +5395,140 @@ module.exports = {specifications: [
       }
     ]
   },
+  {
+    "type": "file",
+    "name": "TextAreaPreview.spec.ts",
+    "children": [
+      {
+        "type": "describe",
+        "name": "Text Area",
+        "children": [
+          {
+            "type": "describe",
+            "name": "given the 'Basic' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Alert' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Error' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Disabled' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "it",
+                "name": "should be disabled"
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Placeholder' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "it",
+                "name": "should render a placeholder text"
+              },
+              {
+                "type": "it",
+                "name": "should reflect the text typed"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "type": "file",
     "name": "TextInput.spec.ts",
@@ -5531,11 +5665,11 @@ module.exports = {specifications: [
   },
   {
     "type": "file",
-    "name": "TextInputLabs.spec.ts",
+    "name": "TextInputPreview.spec.ts",
     "children": [
       {
         "type": "describe",
-        "name": "TextInput",
+        "name": "Text Input",
         "children": [
           {
             "type": "describe",

package/dist/es6/lib/specs.js

@@ -5395,6 +5395,140 @@ module.exports = {specifications: [
       }
     ]
   },
+  {
+    "type": "file",
+    "name": "TextAreaPreview.spec.ts",
+    "children": [
+      {
+        "type": "describe",
+        "name": "Text Area",
+        "children": [
+          {
+            "type": "describe",
+            "name": "given the 'Basic' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Alert' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Error' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "describe",
+                "name": "when clicked",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should be focused"
+                  }
+                ]
+              },
+              {
+                "type": "describe",
+                "name": "when text is entered",
+                "children": [
+                  {
+                    "type": "it",
+                    "name": "should reflect the text typed"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Disabled' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "it",
+                "name": "should be disabled"
+              }
+            ]
+          },
+          {
+            "type": "describe",
+            "name": "given the 'Placeholder' story is rendered",
+            "children": [
+              {
+                "type": "it",
+                "name": "should not have any axe errors"
+              },
+              {
+                "type": "it",
+                "name": "should render a placeholder text"
+              },
+              {
+                "type": "it",
+                "name": "should reflect the text typed"
+              }
+            ]
+          }
+        ]
+      }
+    ]
+  },
   {
     "type": "file",
     "name": "TextInput.spec.ts",
@@ -5531,11 +5665,11 @@ module.exports = {specifications: [
   },
   {
     "type": "file",
-    "name": "TextInputLabs.spec.ts",
+    "name": "TextInputPreview.spec.ts",
     "children": [
       {
         "type": "describe",
-        "name": "TextInput",
+        "name": "Text Input",
         "children": [
           {
             "type": "describe",

package/dist/mdx/6.0-MIGRATION-GUIDE.mdx

@@ -216,6 +216,9 @@ const CustomGlobalHeader = props => {
 };
 ```
 
+You may continue to use this component exactly as you did in v5, but note that we plan to hard-deprecate it in Canvas Kit v7.
+If you would like to migrate away from this deprecated component now, you can reference [this example](https://workday.github.io/canvas-kit/?path=/story/examples-global-header-react--basic) instead.
+
 ### Page Header
 
 We are [soft-deprecating](#soft-deprecation) `PageHeader`. It has been renamed to
@@ -267,6 +270,9 @@ export const CustomPageHeader = (props: CustomPageHeaderProps) => {
 };
 ```
 
+You may continue to use this component exactly as you did in v5, but note that we plan to hard-deprecate it in Canvas Kit v7.
+If you would like to migrate away from this deprecated component now, you can reference [this example](https://workday.github.io/canvas-kit/?path=/story/examples-page-header-react--basic) instead.
+
 ## Component Migrations
 
 ### Search Bar

package/dist/mdx/preview-react/form-field/FormField.mdx

@@ -0,0 +1,27 @@
+import {Specifications} from '@workday/canvas-kit-docs';
+
+import {FormField} from '@workday/canvas-kit-preview-react/form-field';
+
+import Custom from './examples/Custom';
+
+
+# Canvas Kit Form Field
+
+FormField allows users to wrap input components to make them accessible. You usually won't want to
+use FormField directly but instead should use the specific component you need, e.g. `TextInput`.
+
+## Installation
+
+```sh
+yarn add @workday/canvas-kit-preview-react
+```
+
+## Usage
+
+### Customizing With Behavior Hooks Example
+
+If you need full customization you can use the form field behavior hooks to build your own solution.
+It is also easy it work with custom components or third party libraries and get the CKR
+accessibility guarantees by using the `as` prop.
+
+<ExampleCodeBlock code={Custom} />

package/dist/mdx/preview-react/form-field/examples/Custom.tsx

@@ -0,0 +1,57 @@
+import React from 'react';
+import {
+  useFormFieldHint,
+  useFormFieldInput,
+  useFormFieldLabel,
+  useFormFieldModel,
+  useFormFieldOrientation,
+  FormFieldModelContext,
+} from '@workday/canvas-kit-preview-react/form-field';
+import {useModelContext} from '@workday/canvas-kit-react/common';
+import {Stack} from '@workday/canvas-kit-labs-react/layout';
+
+const Label = ({model, children}) => {
+  const localModel = useModelContext(FormFieldModelContext, model);
+  const props = useFormFieldLabel(localModel);
+
+  return (
+    <label {...props}>
+      {children}
+      {model.state.isRequired ? '*' : ''}
+    </label>
+  );
+};
+
+const Hint = ({model, children}) => {
+  const localModel = useModelContext(FormFieldModelContext, model);
+  const props = useFormFieldHint(localModel);
+
+  return <span {...props}>{children}</span>;
+};
+
+const Input = ({model, ...elementProps}) => {
+  const localModel = useModelContext(FormFieldModelContext, model);
+  const props = useFormFieldInput(localModel, elementProps);
+
+  return <input type="text" required={model.state.isRequired ? true : false} {...props} />;
+};
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {
+    setValue(event.target.value);
+  };
+
+  const model = useFormFieldModel({isRequired: true});
+
+  const layoutProps = useFormFieldOrientation('vertical')
+
+  return (
+    <Stack {...layoutProps}>
+      <Label model={model}>My Custom Field</Label>
+      <Input model={model} value={value} onChange={handleChange} />
+      <Hint model={model}>You can be anything</Hint>
+    </Stack>
+  );
+};

package/dist/mdx/preview-react/text-area/TextArea.mdx

@@ -0,0 +1,122 @@
+import {Specifications} from '@workday/canvas-kit-docs';
+
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+
+import Alert from './examples/Alert';
+import Basic from './examples/Basic';
+import Disabled from './examples/Disabled';
+import Error from './examples/Error';
+import Grow from './examples/Grow';
+import LabelPositionVertical from './examples/LabelPositionVertical';
+import LabelPositionHorizontal from './examples/LabelPositionHorizontal';
+import HiddenLabel from './examples/HiddenLabel';
+import Placeholder from './examples/Placeholder';
+import RefForwarding from './examples/RefForwarding';
+import Required from './examples/Required';
+import ResizeConstraints from './examples/ResizeConstraints';
+
+
+# Canvas Kit Text Area
+
+TextArea's allow users to enter and edit multiple lines of text.
+
+[> Workday Design Reference](https://design.workday.com/components/inputs/text-area)
+
+## Installation
+
+```sh
+yarn add @workday/canvas-kit-preview-react
+```
+
+## Usage
+
+### Basic Example
+
+<ExampleCodeBlock code={Basic} />
+
+### Disabled
+
+Use `TextArea.Field`'s `disabled` prop to prevent users from interacting with the field.
+
+<ExampleCodeBlock code={Disabled} />
+
+### Placeholder
+
+Use `TextArea.Field`'s `placeholder` prop to display a sample of its expected format or value before
+a value has been provided.
+
+<ExampleCodeBlock code={Placeholder} />
+
+### Required
+
+Use `TextArea.Field`'s `isRequired` prop (or use with the `useTextAreaModel` hook) to indicate that
+the field is required. This will also add a red asterisk to `TextArea.Label`.
+
+<ExampleCodeBlock code={Required} />
+
+### Ref Forwarding
+
+`TextArea` supports [ref forwarding](https://reactjs.org/docs/forwarding-refs.html). It will forward
+`ref` to its underlying `<textarea>` element.
+
+<ExampleCodeBlock code={RefForwarding} />
+
+### Resize Constraints
+
+Use the `resize` css attribute to restrict resizing of it to certain dimensions.
+
+<ExampleCodeBlock code={ResizeConstraints} />
+
+### Grow
+
+There are lots of ways to accomplish this. The `TextArea.Field` extends from Box so it is easy to
+extend full width, e.g. setting width prop to 100%, or you can set the `alignItems` prop to
+`stretch` on `TextArea`, etc.
+
+<ExampleCodeBlock code={Grow} />
+
+### Label Position
+
+Use the `orientation` property to set `TextArea.Label`'s position. You can override the default
+spacing using the `spacing` prop. Below are examples of both positions:
+
+#### Horizontal
+
+<ExampleCodeBlock code={LabelPositionHorizontal} />
+
+#### Vertical
+
+<ExampleCodeBlock code={LabelPositionVertical} />
+
+### Visually Hiding The Label
+
+If your label is just for screen reader users you can use the `accessibleHide` utility class from
+`@workday/canvas-kit-react/common`. You will likely want to set the `spacing` prop on `TextArea` to
+`zero`.
+
+<ExampleCodeBlock code={HiddenLabel} />
+
+### Error States
+
+Use the `hasError` property from `useTextAreaModel` to set the `TextArea` to the Error state. If you
+have an accompanying hint you can use the `TextArea.Hint` subcomponent.
+
+<ExampleCodeBlock code={Error} />
+
+### Other Visual States
+
+Use the `useThemedRing` hook to change the visual state of the `<textarea>` element.
+
+#### Alert
+
+<ExampleCodeBlock code={Alert} />
+
+## Props
+
+Undocumented props are spread to the underlying `<textarea>` element.
+
+<ArgsTable of={TextArea} />
+
+## Specifications
+
+<Specifications file="TextAreaPreview.spec.ts" name="Text Area" />

package/dist/mdx/preview-react/text-area/examples/Alert.tsx

@@ -0,0 +1,31 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/core'
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+import {useThemedRing} from '@workday/canvas-kit-labs-react/common';
+import {space, colors} from '@workday/canvas-kit-react/tokens';
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    setValue(event.target.value.slice(0, 10));
+  };
+
+  const alertStyles = useThemedRing(
+    value.length < 3 ? 'success' : value.length < 7 ? 'alert' : 'error'
+  );
+
+  const hintColor = value.length < 3 ? colors.greenApple600 : value.length < 7 ? colors.cantaloupe600 : colors.cinnamon500
+
+  return (
+    <TextArea orientation='vertical'>
+      <TextArea.Label>Add a comment</TextArea.Label>
+      <TextArea.Field css={alertStyles} onChange={handleChange} value={value} />
+      <TextArea.Hint paddingTop={space.xxs}>
+        <strong>Character Limit: </strong>
+        <span css={{color: hintColor}}>{10 - value.length} Left</span>
+      </TextArea.Hint>
+    </TextArea>
+  );
+};

package/dist/mdx/preview-react/text-area/examples/Basic.tsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    setValue(event.target.value);
+  };
+
+  return (
+    <TextArea orientation='vertical'>
+      <TextArea.Label>Leave a review</TextArea.Label>
+      <TextArea.Field onChange={handleChange} value={value} />
+    </TextArea>
+  );
+};

package/dist/mdx/preview-react/text-area/examples/Disabled.tsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    setValue(event.target.value);
+  };
+
+  return (
+    <TextArea orientation='vertical'>
+      <TextArea.Label>Leave a review</TextArea.Label>
+      <TextArea.Field disabled onChange={handleChange} value={value} />
+    </TextArea>
+  );
+};

package/dist/mdx/preview-react/text-area/examples/Error.tsx

@@ -0,0 +1,40 @@
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+import {space} from '@workday/canvas-kit-react/tokens';
+
+export default () => {
+  const [value, setValue] = React.useState('four');
+  const [hint, setHint] = React.useState('');
+  const [hasError, setHasError] = React.useState(false);
+
+  const validateInput = (value: string) => {
+    const stringLength = value.length;
+    if (stringLength !== 3) {
+      setHasError(true);
+      const hintStart = 'Word length must be';
+      setHint(stringLength < 3 ? `${hintStart} greater than 2` : `${hintStart} less than 4`);
+    } else {
+      setHasError(false);
+      setHint('');
+    }
+  };
+
+  React.useEffect(() => {
+    validateInput(value);
+    // Only run on load
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    validateInput(event.target.value);
+    setValue(event.target.value);
+  };
+
+  return (
+    <TextArea hasError={hasError} orientation='vertical'>
+      <TextArea.Label>A three letter word</TextArea.Label>
+      <TextArea.Field onChange={handleChange} value={value} />
+      <TextArea.Hint paddingTop={space.xxs}>{hint}</TextArea.Hint>
+    </TextArea>
+  );
+};

package/dist/mdx/preview-react/text-area/examples/Grow.tsx

@@ -0,0 +1,17 @@
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    setValue(event.target.value);
+  };
+
+  return (
+    <TextArea orientation='vertical' alignItems='stretch'>
+      <TextArea.Label>Leave a review</TextArea.Label>
+      <TextArea.Field onChange={handleChange} value={value} />
+    </TextArea>
+  );
+};

package/dist/mdx/preview-react/text-area/examples/HiddenLabel.tsx

@@ -0,0 +1,20 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/core'
+import React from 'react';
+import {TextArea} from '@workday/canvas-kit-preview-react/text-area';
+import { accessibleHide } from '@workday/canvas-kit-react/common';
+
+export default () => {
+  const [value, setValue] = React.useState('');
+
+  const handleChange = (event: React.ChangeEvent<HTMLTextAreaElement>) => {
+    setValue(event.target.value);
+  };
+
+  return (
+    <TextArea orientation='vertical' spacing='zero'>
+      <TextArea.Label css={{...accessibleHide}}>Email</TextArea.Label>
+      <TextArea.Field onChange={handleChange} value={value} />
+    </TextArea>
+  );
+};