@workday/canvas-kit-docs 6.3.4 → 6.3.8

package/dist/mdx/preview-react/_examples/SelectWithFormik.mdx

@@ -0,0 +1,8 @@
+import SelectWithFormik from './examples/SelectWithFormik';
+
+
+# Canvas Kit Examples
+
+## Select With Formik
+
+<ExampleCodeBlock code={SelectWithFormik} />

package/dist/mdx/preview-react/_examples/TextInputWithFormik.mdx

@@ -0,0 +1,8 @@
+import TextInputWithFormik from './examples/TextInputWithFormik';
+
+
+# Canvas Kit Examples
+
+## Text Input With Formik
+
+<ExampleCodeBlock code={TextInputWithFormik} />

package/dist/mdx/preview-react/_examples/examples/SelectWithFormik.tsx

@@ -0,0 +1,47 @@
+import * as React from 'react';
+import {useFormik} from 'formik';
+import {Select} from '@workday/canvas-kit-preview-react/select';
+import {
+  FormField,
+  useFormFieldInput,
+  useFormFieldModel,
+} from '@workday/canvas-kit-preview-react/form-field';
+
+export default () => {
+  const formik = useFormik({
+    initialValues: {
+      selectedBook: '',
+    },
+    onSubmit: data => {
+      console.log(data);
+    },
+  });
+
+  const model = useFormFieldModel();
+  const formFieldInputProps = useFormFieldInput(model);
+
+  return (
+    <form onSubmit={formik.handleSubmit}>
+      <FormField orientation="vertical" alignItems="stretch">
+        <FormField.Label>Choose a book</FormField.Label>
+        <Select
+          name="selectedBook"
+          options={bookList}
+          onChange={event => formik.setFieldValue('selectedBook', event.currentTarget.value)}
+          value={formik.values.selectedBook}
+          grow
+          {...formFieldInputProps}
+        />
+      </FormField>
+    </form>
+  );
+};
+
+const bookList = [
+  {label: 'Dessert Person by Claire Saffitz', value: 'dessert person'},
+  {label: 'Elements of Pizza by Ken Forkish', value: 'the elements of pizza'},
+  {label: 'Flour Water Salt Yeast by Ken Forkish', value: 'flour water salt yeast'},
+  {label: 'Mastering Pasta by Marc Verti', value: 'mastering pasta'},
+  {label: 'Patisserie by Christophe Felder', value: 'patisserie'},
+  {label: 'Tartine by Elisabeth Prueitt & Chad Robertson', value: 'tartine'},
+];

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

@@ -3,6 +3,7 @@ import {Specifications} from '@workday/canvas-kit-docs';
 import {FormField} from '@workday/canvas-kit-preview-react/form-field';
 
 import Custom from './examples/Custom';
+import WithSelect from './examples/Select';
 
 
 # Canvas Kit Form Field
@@ -20,8 +21,19 @@ yarn add @workday/canvas-kit-preview-react
 
 ### 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
+If you need full customization you can use the `FormField` 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} />
+<ExampleCodeBlock code={Custom} />
+
+### Use with Select
+
+For some custom inputs, such as Canvas Kit's `Select`, you won't be able to reliably cast the
+`FormField.Input` with the `as` prop. Instead you'll want to use `FormField`'s hooks for the
+implementation. In the example below, we're using the `useFormFieldModel` hook to hoist the model
+and providing it to the `useFormFieldInput` behavior hook. Then we pass the model to the `FormField`
+component and the input props to `Select`. This connects `Select` to the `FormField` components and
+provides it with all the accessible attributes it needs.
+
+<ExampleCodeBlock code={WithSelect} />

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

@@ -0,0 +1,50 @@
+import * as React from 'react';
+import {
+  FormField,
+  useFormFieldInput,
+  useFormFieldModel,
+} from '@workday/canvas-kit-preview-react/form-field';
+import {Select} from '@workday/canvas-kit-preview-react/select';
+
+export default () => {
+  const [selected, setSelected] = React.useState(wineList[0].value);
+  // Hoist the FormField model so we can pass it to `useFormFieldInput`
+  const model = useFormFieldModel({isRequired: true});
+  // Get all the FormField-related input props to pass to `Select`
+  const formFieldInputProps = useFormFieldInput(model);
+
+  return (
+    <FormField orientation="vertical" model={model}>
+      <FormField.Label>Choose a wine</FormField.Label>
+      <Select
+        options={wineList}
+        value={selected}
+        onChange={event => setSelected(event.currentTarget.value)}
+        {...formFieldInputProps}
+      />
+      <FormField.Hint>When in doubt, go with the Chianti.</FormField.Hint>
+    </FormField>
+  );
+};
+
+export default [
+  {label: 'Beaujolais', value: 'beaujolais'},
+  {label: 'Bordeaux', value: 'bordeaux'},
+  {label: 'Cabernet Sauvignon', value: 'cabernet sauvignon'},
+  {label: 'Champagne', value: 'champagne'},
+  {label: 'Chardonnay', value: 'chardonnay'},
+  {label: 'Chianti', value: 'chianti'},
+  {label: 'Malbec', value: 'malbec'},
+  {label: 'Merlot', value: 'merlot'},
+  {label: 'Pinot Grigio', value: 'pinot grigio'},
+  {label: 'Pinot Gris', value: 'pinot gris'},
+  {label: 'Pinot Noir', value: 'pinot noir'},
+  {label: 'Primitivo', value: 'primitivo'},
+  {label: 'Prosecco', value: 'prosecco'},
+  {label: 'Riesling', value: 'riesling'},
+  {label: 'Rioja', value: 'rioja'},
+  {label: 'Rosé', value: 'rosé'},
+  {label: 'Sauvignon Blanc', value: 'sauvignon blanc'},
+  {label: 'Syrah', value: 'syrah'},
+  {label: 'Zinfandel', value: 'zinfandel'},
+];

package/dist/mdx/preview-react/text-input/TextInput.mdx

@@ -16,7 +16,6 @@ import ThemedAlert from './examples/ThemedAlert';
 import ThemedError from './examples/ThemedError';
 import Error from './examples/Error';
 import Alert from './examples/Alert';
-import LoginForm from './examples/LoginForm';
 
 
 # Canvas Kit Text Input
@@ -128,12 +127,6 @@ used in an outer ring.
 
 <ExampleCodeBlock code={ThemedAlert} />
 
-#### Full example
-
-Login Form using Formik
-
-<ExampleCodeBlock code={LoginForm} />
-
 ## Props
 
 Undocumented props are spread to the underlying `<input>` element.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workday/canvas-kit-docs",
-  "version": "6.3.4",
+  "version": "6.3.8",
   "description": "Documentation components of Canvas Kit components",
   "author": "Workday, Inc. (https://www.workday.com)",
   "license": "Apache-2.0",
@@ -50,7 +50,7 @@
   ],
   "dependencies": {
     "@storybook/csf": "0.0.1",
-    "@workday/canvas-kit-react": "^6.3.4"
+    "@workday/canvas-kit-react": "^6.3.8"
   },
   "devDependencies": {
     "fs-extra": "^10.0.0",
@@ -58,5 +58,5 @@
     "mkdirp": "^1.0.3",
     "typescript": "^3.8.3"
   },
-  "gitHead": "43759dac29aaa53f6f794a739bc9913f1aade55b"
+  "gitHead": "a368b19cd0cb84f86289a42040a4756e4d4c8dd1"
 }