@workday/canvas-kit-docs 5.3.0-next.2 → 5.3.0-next.24

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/LICENSE +1 -1
  2. package/dist/commonjs/lib/specs.js +428 -32
  3. package/dist/es6/lib/specs.js +428 -32
  4. package/dist/mdx/6.0-MIGRATION-GUIDE.mdx +560 -0
  5. package/dist/mdx/COMPOUND_COMPONENTS.mdx +31 -30
  6. package/dist/mdx/CONTRIBUTING.mdx +90 -63
  7. package/dist/mdx/labs-react/search-form/SearchForm.mdx +64 -0
  8. package/dist/mdx/labs-react/search-form/examples/Basic.tsx +61 -0
  9. package/dist/mdx/labs-react/search-form/examples/CustomTheme.tsx +72 -0
  10. package/dist/mdx/labs-react/search-form/examples/Grow.tsx +62 -0
  11. package/dist/mdx/labs-react/search-form/examples/PropTables.splitProps.tsx +4 -0
  12. package/dist/mdx/labs-react/search-form/examples/RTL.tsx +70 -0
  13. package/dist/mdx/labs-react/search-form/examples/Theming.tsx +64 -0
  14. package/dist/mdx/preview-react/breadcrumbs/Breadcrumbs.mdx +1 -1
  15. package/dist/mdx/preview-react/form-field/FormField.mdx +27 -0
  16. package/dist/mdx/preview-react/form-field/examples/Custom.tsx +57 -0
  17. package/dist/mdx/preview-react/menu/Menu.mdx +17 -9
  18. package/dist/mdx/preview-react/menu/examples/Basic.tsx +65 -10
  19. package/dist/mdx/preview-react/menu/examples/ContextMenu.tsx +45 -29
  20. package/dist/mdx/preview-react/menu/examples/CustomMenuItem.tsx +2 -2
  21. package/dist/mdx/preview-react/menu/examples/Icons.tsx +1 -1
  22. package/dist/mdx/preview-react/menu/examples/ManyItems.tsx +2 -2
  23. package/dist/mdx/preview-react/text-area/TextArea.mdx +122 -0
  24. package/dist/mdx/preview-react/text-area/examples/Alert.tsx +31 -0
  25. package/dist/mdx/preview-react/text-area/examples/Basic.tsx +17 -0
  26. package/dist/mdx/preview-react/text-area/examples/Disabled.tsx +17 -0
  27. package/dist/mdx/preview-react/text-area/examples/Error.tsx +40 -0
  28. package/dist/mdx/preview-react/text-area/examples/Grow.tsx +17 -0
  29. package/dist/mdx/preview-react/text-area/examples/HiddenLabel.tsx +20 -0
  30. package/dist/mdx/preview-react/text-area/examples/LabelPositionHorizontal.tsx +17 -0
  31. package/dist/mdx/preview-react/text-area/examples/LabelPositionVertical.tsx +17 -0
  32. package/dist/mdx/preview-react/text-area/examples/Placeholder.tsx +21 -0
  33. package/dist/mdx/preview-react/text-area/examples/RefForwarding.tsx +28 -0
  34. package/dist/mdx/preview-react/text-area/examples/Required.tsx +17 -0
  35. package/dist/mdx/preview-react/text-area/examples/ResizeConstraints.tsx +22 -0
  36. package/dist/mdx/preview-react/text-input/TextInput.mdx +145 -0
  37. package/dist/mdx/preview-react/text-input/examples/Alert.tsx +40 -0
  38. package/dist/mdx/preview-react/text-input/examples/Basic.tsx +17 -0
  39. package/dist/mdx/preview-react/text-input/examples/Disabled.tsx +17 -0
  40. package/dist/mdx/preview-react/text-input/examples/Error.tsx +40 -0
  41. package/dist/mdx/preview-react/text-input/examples/Grow.tsx +17 -0
  42. package/dist/mdx/preview-react/text-input/examples/HiddenLabel.tsx +20 -0
  43. package/dist/mdx/preview-react/text-input/examples/LabelPositionHorizontal.tsx +17 -0
  44. package/dist/mdx/preview-react/text-input/examples/LabelPositionVertical.tsx +17 -0
  45. package/dist/mdx/preview-react/text-input/examples/LoginForm.tsx +105 -0
  46. package/dist/mdx/preview-react/text-input/examples/Password.tsx +17 -0
  47. package/dist/mdx/preview-react/text-input/examples/Placeholder.tsx +17 -0
  48. package/dist/mdx/preview-react/text-input/examples/RefForwarding.tsx +28 -0
  49. package/dist/mdx/preview-react/text-input/examples/Required.tsx +17 -0
  50. package/dist/mdx/preview-react/text-input/examples/ThemedAlert.tsx +46 -0
  51. package/dist/mdx/preview-react/text-input/examples/ThemedError.tsx +37 -0
  52. package/dist/mdx/react/_examples/GlobalHeader.mdx +9 -0
  53. package/dist/mdx/react/_examples/PageHeader.mdx +8 -0
  54. package/dist/mdx/react/_examples/examples/GlobalHeader.tsx +66 -0
  55. package/dist/mdx/react/_examples/examples/PageHeader.tsx +63 -0
  56. package/dist/mdx/react/action-bar/ActionBar.mdx +1 -1
  57. package/dist/mdx/react/button/button/Button.mdx +34 -9
  58. package/dist/mdx/react/button/button/examples/Primary.tsx +10 -1
  59. package/dist/mdx/react/button/button/examples/PrimaryInverse.tsx +14 -0
  60. package/dist/mdx/react/button/button/examples/Secondary.tsx +10 -1
  61. package/dist/mdx/react/button/button/examples/SecondaryInverse.tsx +14 -0
  62. package/dist/mdx/react/button/button/examples/Tertiary.tsx +10 -1
  63. package/dist/mdx/react/button/button/examples/TertiaryInverse.tsx +14 -0
  64. package/dist/mdx/react/button/icon-button/IconButton.mdx +1 -1
  65. package/dist/mdx/react/loading-animation/LoadingAnimation.mdx +5 -0
  66. package/dist/mdx/react/loading-animation/examples/RTL.tsx +16 -0
  67. package/dist/mdx/react/pagination/PropTables.splitprops.tsx +47 -0
  68. package/dist/mdx/react/pagination/examples/{StepControls.tsx → Basic.tsx} +1 -1
  69. package/dist/mdx/react/pagination/examples/GoToForm.tsx +1 -1
  70. package/dist/mdx/react/pagination/examples/HoistedModel.tsx +36 -22
  71. package/dist/mdx/react/pagination/examples/RTL.tsx +1 -1
  72. package/dist/mdx/react/pagination/pagination.mdx +225 -474
  73. package/dist/mdx/react/popup/Popup.mdx +34 -36
  74. package/dist/mdx/react/radio/examples/Alert.tsx +3 -3
  75. package/dist/mdx/react/radio/examples/Basic.tsx +3 -3
  76. package/dist/mdx/react/radio/examples/Disabled.tsx +3 -3
  77. package/dist/mdx/react/radio/examples/Error.tsx +3 -3
  78. package/dist/mdx/react/radio/examples/LabelPosition.tsx +3 -3
  79. package/dist/mdx/react/radio/examples/NoValue.tsx +3 -3
  80. package/dist/mdx/react/radio/examples/RefForwarding.tsx +3 -3
  81. package/dist/mdx/react/radio/examples/Required.tsx +3 -3
  82. package/dist/mdx/react/segmented-control/SegmentedControl.mdx +1 -1
  83. package/dist/mdx/react/tabs/Tabs.mdx +67 -36
  84. package/dist/mdx/react/tabs/examples/DisabledTab.tsx +1 -1
  85. package/dist/mdx/react/tabs/examples/DynamicTabs.tsx +41 -13
  86. package/dist/mdx/react/tabs/examples/HoistedModel.tsx +4 -4
  87. package/dist/mdx/react/tabs/examples/Icons.tsx +36 -0
  88. package/dist/mdx/react/tabs/examples/{NamedKeys.tsx → NamedTabs.tsx} +0 -0
  89. package/dist/mdx/react/tabs/examples/OverflowTabs.tsx +58 -0
  90. package/dist/mdx/react/tabs/examples/SinglePanel.tsx +1 -1
  91. package/dist/mdx/react/text-area/TextArea.mdx +1 -1
  92. package/dist/mdx/react/toast/toast.mdx +1 -17
  93. package/dist/mdx/react/tooltip/Tooltip.mdx +9 -1
  94. package/dist/mdx/react/tooltip/examples/DelayedTooltip.tsx +16 -0
  95. package/dist/mdx/react/tooltip/examples/Ellipsis.tsx +6 -0
  96. package/package.json +5 -4
  97. package/dist/mdx/CODE_OF_CONDUCT.md +0 -68
  98. package/dist/mdx/preview-react/menu/examples/ContextMenuTarget.tsx +0 -33
  99. package/dist/mdx/preview-react/menu/examples/ControlButton.tsx +0 -84
  100. package/dist/mdx/react/pagination/examples/ShowAdditionalDetails.tsx +0 -52
@@ -78,8 +78,8 @@ const Tabs = ({children, model, ...config}) => {
78
78
 
79
79
  ## Subcomponents
80
80
 
81
- A subcomponent typically follows ARIA roles. For the `Tabs` example, these are the `tablist`,
82
- `tab`, and `tabpanel` roles. A subcomponent provides direct access to semantic or key elements of a
81
+ A subcomponent typically follows ARIA roles. For the `Tabs` example, these are the `tablist`, `tab`,
82
+ and `tabpanel` roles. A subcomponent provides direct access to semantic or key elements of a
83
83
  compound component. In the `IconButton` example, the icon is not semantic and might be hidden from
84
84
  screen readers while the `IconButton.Text` content is instead used for a tooltip and as the
85
85
  accessible name while being visibly hidden.
@@ -175,35 +175,35 @@ Components that directly wrap an element (most of them) will have the following
175
175
 
176
176
  Compound components are also made up of [models](#models) that accept [guards](#guards) to
177
177
  conditionally prevent state changes and [callbacks](#callbacks) to attach listeners. For example, in
178
- our Tabs component clicking a Tab will activate that tab. The `Tabs` container component will accept
179
- a `shouldActivate` and a `onActivate` for the event called `activate`.
178
+ our Tabs component clicking a Tab will select that tab. The `Tabs` container component will accept a
179
+ `shouldSelect` and a `onSelect` for the event called `select`.
180
180
 
181
181
  ```tsx
182
182
  const MyComponent = () => {
183
- // `data` is all event data from the `activate` event
183
+ // `data` is all event data from the `select` event
184
184
 
185
185
  // `state` is the current state of the `Tabs` component
186
- const shouldActivate = ({data, state}) => {
187
- // for some reason, we only want to allow activation the 'first' tab
188
- // Clicking on the first tab will activate it, but clicking on the
186
+ const shouldSelect = ({data, state}) => {
187
+ // for some reason, we only want to allow selection the 'first' tab
188
+ // Clicking on the first tab will select it, but clicking on the
189
189
  // second tab will do nothing
190
190
  return data.tab === 'first' ? true : false;
191
191
 
192
192
  // returning true allows the event to trigger a state change and will
193
- // also call the `onActivate` callback
193
+ // also call the `onSelect` callback
194
194
  };
195
195
 
196
196
  // `prevState` is the previous state of the model. Callbacks are called _before_ state has resolved.
197
197
  // This means the passed state hasn't updated yet. It also means it is safe to call `setState` without
198
198
  // triggering extra renders. `setState` calls will add to React's batching system before a state changes
199
199
  // are flushed and render functions are called.
200
- const onActivate = ({data, prevState}) => {
201
- // called any time the `activate` event is triggered
202
- console.log('onActivate', data, prevState);
200
+ const onSelect = ({data, prevState}) => {
201
+ // called any time the `select` event is triggered
202
+ console.log('onSelect', data, prevState);
203
203
  };
204
204
 
205
205
  return (
206
- <Tabs shouldActivate={shouldActivate} onActivate={onActivate}>
206
+ <Tabs shouldSelect={shouldSelect} onSelect={onSelect}>
207
207
  <Tabs.List>
208
208
  <Tabs.Item name="first">First</Tabs.Item>
209
209
  <Tabs.Item name="second">Second</Tabs.Item>
@@ -324,20 +324,20 @@ const useEllipsisTooltipModel = (config = {}) => {
324
324
 
325
325
  Models are meant to be composable. For example, a `TabsModel` uses a `CursorModel` (which itself
326
326
  uses `ListModel`) and a `ListModel` for a list of panels. `TabsModel` also keeps track of which tab
327
- is currently active. This might look like the following:
327
+ is currently selected. This might look like the following:
328
328
 
329
329
  ```ts
330
330
  const useTabsModel = (config = {}) => {
331
331
  // id is used for ARIA attributes
332
332
  const id = useUniqueId(config.id);
333
- const [activeTab, setActiveTab] = React.useState('');
333
+ const [selectedTab, setSelectedTab] = React.useState('');
334
334
  const cursor = useCursorModel(config);
335
335
  const panels = useListModel(config);
336
336
 
337
337
  const state = {
338
338
  ...cursor.state, // extend the CursorModel state
339
339
  id,
340
- activeTab,
340
+ selectedTab,
341
341
  panels: panels.state.items, // we only care about
342
342
  };
343
343
 
@@ -346,12 +346,12 @@ const useTabsModel = (config = {}) => {
346
346
  registerPanel: panels.events.registerItem,
347
347
  unregisterPanel: panels.events.unregisterItem,
348
348
 
349
- activate(data) {
350
- if (config.shouldActivate?.({data, prevState: state}) === false) {
349
+ select(data) {
350
+ if (config.shouldSelect?.({data, prevState: state}) === false) {
351
351
  return;
352
352
  }
353
- setActiveTab(data.tab);
354
- config.onActivate?.({data, prevState: state});
353
+ setSelectedTab(data.tab);
354
+ config.onSelect?.({data, prevState: state});
355
355
  },
356
356
  };
357
357
 
@@ -362,10 +362,11 @@ const useTabsModel = (config = {}) => {
362
362
  Model composition allows for components to share functionality with other components. In the Tabs
363
363
  example, `ListModel` is in charge of maintaining a list of tab elements. The `CursorModel` is in
364
364
  charge of maintaining a current cursor position of the tab list. The `Tabs.List` component uses the
365
- cursor to allow keyboard navigation of the tabs. The `TabsModel` also maintains the currently active
366
- tab to ensure the correct `TabPanel` is visible. The `TabsModel` is also using a `ListModel` to
367
- maintain a list of tab panels. The `TabsModel` is in charge of composing all this and providing data
368
- and events to the `Tabs` compound component - coordination state between subcomponents.
365
+ cursor to allow keyboard navigation of the tabs. The `TabsModel` also maintains the currently
366
+ selected tab to ensure the correct `TabPanel` is visible. The `TabsModel` is also using a
367
+ `ListModel` to maintain a list of tab panels. The `TabsModel` is in charge of composing all this and
368
+ providing data and events to the `Tabs` compound component - coordination state between
369
+ subcomponents.
369
370
 
370
371
  Many other components like `Select`, `Breadcrumbs`, or dropdown menus can also use the `ListModel`
371
372
  and/or the `CursorModel`. These models could be thought of as abstract models where they do not
@@ -463,11 +464,11 @@ const TabList = ({children, ...elemProps}) => {
463
464
 
464
465
  A container component can either accept model configuration _or_ a model. Passing model
465
466
  configuration allows for simpler model configuration of guards, callbacks, or any other model
466
- configuration. The following example provides an `onActivate` callback that fetches some data from
467
- the server:
467
+ configuration. The following example provides an `onSelect` callback that fetches some data from the
468
+ server:
468
469
 
469
470
  ```tsx
470
- <Tabs onActivate={({data}) => fetch('/api/activate' + data.id)}>...</Tabs>
471
+ <Tabs onSelect={({data}) => fetch('/api/selectTab' + data.id)}>...</Tabs>
471
472
  ```
472
473
 
473
474
  If you need direct access to a model's state or events, you can hoist the model into your component
@@ -479,15 +480,15 @@ look like this:
479
480
  const MyTabs = () => {
480
481
  const model = useTabsModel({
481
482
  // we can still load data from the server
482
- onActivate: ({data}) => fetch('/api/activate' + data.id),
483
+ onSelect: ({data}) => fetch('/api/selectTab' + data.id),
483
484
  });
484
485
 
485
486
  return (
486
487
  <>
487
488
  <Tabs model={model}>...</Tabs>
488
- // direct access to the model's state Currently selected tab: {model.state.activeTab}
489
+ // direct access to the model's state Currently selected tab: {model.state.selectedTab}
489
490
  // Now we can send events directly to the model
490
- <button onClick={() => model.events.activate({tab: 'third'})}>Activate third tab</button>
491
+ <button onClick={() => model.events.select({tab: 'third'})}>Select third tab</button>
491
492
  </>
492
493
  );
493
494
  };
@@ -5,42 +5,37 @@ part of the community. Before you contribute, please take a moment and look thro
5
5
  sections:
6
6
 
7
7
  - [Code of Conduct](#code-of-conduct)
8
- - [Contributor License Agreement](#contributor-license-agreement)
9
- - [Contributing Guidelines](#contributing-guidelines)
10
- - [How to Contribute](#how-to-contribute)
8
+ - [How to Contribute](#how-to-contribute)
9
+ - [Communicate on Issues](#communicate-on-issues)
11
10
  - [Git Guidelines](#git-guidelines)
12
- - [Getting Started](#getting-started)
11
+ - [Branches](#branches)
12
+ - [Commit Message Format](#commit-message-format)
13
+ - [Commit Descriptions](#commit-descriptions)
14
+ - [Pull Requests](#pull-requests)
15
+ - [Developer Experience](#developer-experience)
16
+ - [Yarn and Workspaces](#yarn-and-workspaces)
17
+ - [Storybook](#storybook)
18
+ - [Testing](#testing)
19
+ - [Automation on Commit](#automation-on-commit)
20
+ - [Releases](#releases)
21
+ - [Getting Started Developing](#getting-started-developing)
13
22
  - [Creating a Module](#creating-a-module)
14
23
  - [Exporting a Module](#exporting-a-module)
15
24
  - [Building Modules](#building-modules)
16
25
  - [Testing Modules](#testing-modules)
17
26
  - [Code Style Guide](#code-style-guide)
18
- - [Canvas Kit Labs & Preview](#canvas-kit-labs-preview)
27
+ - [Canvas Kit Labs & Preview](#canvas-kit-labs--preview)
19
28
  - [Editors](#editors)
29
+ - [Contributor License Agreement](#contributor-license-agreement)
20
30
 
21
31
  ## Code of Conduct
22
32
 
23
33
  At Workday, we are committed to a culture of integrity, innovation, and fun. That culture extends to
24
34
  the community that we are building here through Canvas. By participating in it, you are expected to
25
- uphold this [code of conduct](https://github.com/Workday/canvas-kit/tree/master/CODE_OF_CONDUCT.md)
26
- and agree to our CLA.
35
+ uphold our [Code of Conduct](https://github.com/Workday/canvas-kit/blob/master/CODE_OF_CONDUCT.md)
36
+ and agree to our [Contributor License Agreement](#contributor-license-agreement).
27
37
 
28
- ## Contributor License Agreement
29
-
30
- Each Contributor (“You”) represents that such You are legally entitled to submit any Contributions
31
- in accordance with these terms and by posting a Contribution, you represent that each of Your
32
- Contribution is Your original creation.
33
-
34
- You are not expected to provide support for Your Contributions, except to the extent You desire to
35
- provide support. You may provide support for free, for a fee, or not at all. Unless required by
36
- applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT
37
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any
38
- warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
39
- PURPOSE.
40
-
41
- ## Contributing Guidelines
42
-
43
- ### How to Contribute
38
+ ## How to Contribute
44
39
 
45
40
  **Don't hesitate to contribute!** Canvas Kit thrives on open discussion and contribution by anyone
46
41
  in the Workday community. Contribution doesn't have to be code-based. Anyone can suggest changes to
@@ -50,38 +45,25 @@ If you are contributing code, please take a look at the following sections to fa
50
45
  with how the Canvas Kit repo is organized and run. This will help streamline the pull request
51
46
  process. If you have any questions, please reach out!
52
47
 
53
- If your contribution is visual or UI-based, please ensure you consult with a designer so the
54
- contribution can be evaluated as an end-to-end process.
55
-
56
- #### Automation on Commit
57
-
58
- Upon commit, [lint-staged](https://github.com/okonet/lint-staged) will run your staged code through
59
- [Prettier](https://prettier.io) and [eslint](https://eslint.org).
48
+ If your contribution is visual or UI-based, please ensure you consult with a designer or request a
49
+ maintainer's help so the contribution can be evaluated as an end-to-end process.
60
50
 
61
- #### Storybook
51
+ ### Communicate on Issues
62
52
 
63
- Canvas Kit uses [Storybook](https://storybook.js.org/) for the component development environment.
64
-
65
- #### Yarn and Workspaces
66
-
67
- Canvas Kit uses Yarn for package management and takes advantage of its support for
68
- [Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) to connect all of its different modules
69
- within a single repository.
70
-
71
- #### Testing
72
-
73
- Canvas Kit uses [Jest](https://jestjs.io/) and
74
- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) to unit test
75
- our React components. For more information about our testing strategy and how we write unit tests,
76
- visit our [Testing Readme](/getting-started/for-developers/resources/testing/)
77
-
78
- Canvas Kit uses [Cypress](https://cypress.io) for UI tests. For info on why we chose Cypress, visit
79
- [Why Cypress?](https://github.com/Workday/canvas-kit/tree/master/cypress/WHY_CYPRESS.md) For more
80
- information about how to write Cypress tests, visit
81
- [Writing Cypress Tests](https://github.com/Workday/canvas-kit/tree/master/cypress/README.md)
53
+ - Create or identify [an issue](https://github.com/Workday/canvas-kit/issues) to work on
54
+ - New contributors are recommended to start with a
55
+ [good first issue](https://github.com/Workday/canvas-kit/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
56
+ - Ask our team if the issue is relevant or has attention from other developers
57
+ - Communicate if you'd like to work on the issue
58
+ - Ask questions! You have our support, and you will always need more information than what is in the
59
+ issue.
82
60
 
83
61
  ### Git Guidelines
84
62
 
63
+ All development should happen on a personal fork (including maintainers). Fork the
64
+ [repo](https://github.com/Workday/canvas-kit) to your personal account, and create a feature branch
65
+ for each contribution.
66
+
85
67
  #### Branches
86
68
 
87
69
  - Create branches for each feature you develop
@@ -127,18 +109,50 @@ fix: Add missing static class variable to IconButton and Avatar
127
109
 
128
110
  #### Pull Requests
129
111
 
130
- - All development should happen on a personal fork (including maintainers). This allows us to keep
131
- the project tree clean and easy to follow, while ensuring everyone has the same developer
132
- experience.
133
- - Project maintainers are able to push commits to fork PRs, but other contributors will need to open
134
- PRs to the personal fork to collaborate with others on a feature.
112
+ - We support creating a Draft Pull Request as soon as you have figured out a working implementation,
113
+ for early feedback. It can later be marked Ready for Review.
114
+ - Open a pull request from a feature branch on your fork against the master branch on the main
115
+ repository
135
116
  - When a pull request passes all checks and reviews, a core maintainer merges via Squash and Merge
136
- with a link back to the PR.
117
+ with a link back to the PR
137
118
  - The branch will automatically be deleted on merge, but its commits and the branch reference are
138
- still available via the PR.
119
+ still available via the PR
120
+ - When multiple developers collaborate on a PR, project maintainers are able to push commits to fork
121
+ PRs, but other contributors will need to open their own PRs against the personal fork and the
122
+ appropriate feature branch.
139
123
  - If you have questions about the above policies, please ask :)
140
124
 
141
- #### Releases
125
+ ## Developer Experience
126
+
127
+ ### Storybook
128
+
129
+ Canvas Kit uses [Storybook](https://storybook.js.org/) for the component development environment.
130
+
131
+ ### Yarn and Workspaces
132
+
133
+ Canvas Kit uses Yarn for package management and takes advantage of its support for
134
+ [Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) to connect all of its different modules
135
+ within a single repository. It is recommended but not required over `npm`, unless you are updating
136
+ dependencies, then it's required.
137
+
138
+ ### Testing
139
+
140
+ Canvas Kit uses [Jest](https://jestjs.io/) and
141
+ [React Testing Library](https://testing-library.com/docs/react-testing-library/intro) to unit test
142
+ our React components. For more information about our testing strategy and how we write unit tests,
143
+ visit our [Testing Readme](/getting-started/for-developers/resources/testing/).
144
+
145
+ Canvas Kit uses [Cypress](https://cypress.io) for UI tests. For info on why we chose Cypress, visit
146
+ [Why Cypress?](https://github.com/Workday/canvas-kit/tree/master/cypress/WHY_CYPRESS.md) For more
147
+ information about how to write Cypress tests, visit
148
+ [Writing Cypress Tests](https://github.com/Workday/canvas-kit/tree/master/cypress/README.md).
149
+
150
+ ### Automation on Commit
151
+
152
+ Upon commit, [lint-staged](https://github.com/okonet/lint-staged) will run your staged code through
153
+ [Prettier](https://prettier.io) and [eslint](https://eslint.org).
154
+
155
+ ### Releases
142
156
 
143
157
  - Releases are prepared by updating package versions with `lerna version`, and updating the
144
158
  [changelog](./CHANGELOG.md)
@@ -148,9 +162,9 @@ fix: Add missing static class variable to IconButton and Avatar
148
162
  - The GitHub release automatically tags master with the new version, and deploys the new version to
149
163
  NPM.
150
164
 
151
- ## Getting Started
165
+ ## Getting Started Developing
152
166
 
153
- 1. Clone the repository and run `yarn`
167
+ 1. Clone the repository from your fork and run `yarn`
154
168
  2. Run `yarn start` to start [Storybook](https://storybook.js.org/)
155
169
  3. Visit [http://localhost:9001/](http://localhost:9001/)
156
170
 
@@ -220,8 +234,8 @@ Canvas Kit Preview is for beta components.
220
234
 
221
235
  ### Editors
222
236
 
223
- VSCode is our preferred IDE. Install the Prettier and ESLint plugins for quicker and easier
224
- formatting.
237
+ Visual Studio Code is our preferred IDE. Install the Prettier and ESLint plugins for quicker and
238
+ easier formatting.
225
239
 
226
240
  #### Visual Studio Code
227
241
 
@@ -230,4 +244,17 @@ Install [prettier-vscode](https://github.com/prettier/prettier-vscode) and
230
244
 
231
245
  Consider adding the following options:
232
246
 
233
- - [Format on save](https://github.com/prettier/prettier-vscode#format-on-save)
247
+ - [Format on save](https://github.com/prettier/prettier-vscode#format-on-save)
248
+
249
+ ## Contributor License Agreement
250
+
251
+ Each Contributor (“You”) represents that such You are legally entitled to submit any Contributions
252
+ in accordance with these terms and by posting a Contribution, you represent that each of Your
253
+ Contribution is Your original creation.
254
+
255
+ You are not expected to provide support for Your Contributions, except to the extent You desire to
256
+ provide support. You may provide support for free, for a fee, or not at all. Unless required by
257
+ applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT
258
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any
259
+ warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR
260
+ PURPOSE.
@@ -0,0 +1,64 @@
1
+ import {SearchForm} from '@workday/canvas-kit-labs-react/search-form';
2
+ // examples
3
+ import Basic from './examples/Basic';
4
+ import CustomTheme from './examples/CustomTheme';
5
+ import Grow from './examples/Grow';
6
+ import RTL from './examples/RTL';
7
+ import Theming from './examples/Theming';
8
+ import ThemeAttributes from './examples/PropTables.splitProps';
9
+
10
+
11
+ # Canvas Kit Search Form
12
+
13
+ `SearchForm` is a search form that contains a `Combobox` for rendering search results. It's
14
+ primarily intended to be used within a `Header`.
15
+
16
+ ## Installation
17
+
18
+ ```sh
19
+ yarn add @workday/canvas-kit-labs-react
20
+ ```
21
+
22
+ ## Usage
23
+
24
+ ### Basic Example
25
+
26
+ You will most likely use `SearchForm` within the context of a `Header` component, but it's helpful
27
+ to see its functionality as a standalone component. Below is a basic example that filters results
28
+ based on search input.
29
+
30
+ <ExampleCodeBlock code={Basic} />
31
+
32
+ ### Grow
33
+
34
+ If you'd like `SearchForm` to grow to the width of its container, set the `grow` prop to
35
+ `true`.
36
+
37
+ <ExampleCodeBlock code={Grow} />
38
+
39
+ ### Theming
40
+
41
+ `SearchForm` can be themed to use one of the preset `SearchThemes`: `Light`, `Dark`, or
42
+ `Transparent`. Below is an example of `SearchForm` using the `Dark` theme.
43
+
44
+ <ExampleCodeBlock code={Theming} />
45
+
46
+ You can also provide more specific theming values by providing specific `SearchThemeAttributes`.
47
+
48
+ <ExampleCodeBlock code={CustomTheme} />
49
+
50
+ Below is a table of attributes that can be supplied to `SearchForm`:
51
+
52
+ <ArgsTable of={ThemeAttributes} />
53
+
54
+
55
+ ### RTL (Right-To-Left)
56
+
57
+ `SearchForm` provides bidirectional support out of the box. You shouldn't need to provide any
58
+ additional configuration.
59
+
60
+ <ExampleCodeBlock code={RTL} />
61
+
62
+ ## Props
63
+
64
+ <ArgsTable of={SearchForm} />
@@ -0,0 +1,61 @@
1
+ import * as React from 'react';
2
+ import {MenuItem} from '@workday/canvas-kit-preview-react/menu';
3
+ import {SearchForm} from '@workday/canvas-kit-labs-react/search-form';
4
+ import {Flex} from '@workday/canvas-kit-labs-react/layout';
5
+
6
+ const initialWineList = [
7
+ 'Beaujolais',
8
+ 'Bordeaux',
9
+ 'Cabernet Sauvignon',
10
+ 'Champagne',
11
+ 'Chardonnay',
12
+ 'Chianti',
13
+ 'Malbec',
14
+ 'Merlot',
15
+ 'Pinot Grigio',
16
+ 'Pinot Gris',
17
+ 'Pinot Noir',
18
+ 'Primitivo',
19
+ 'Prosecco',
20
+ 'Riesling',
21
+ 'Rioja',
22
+ 'Rosé',
23
+ 'Sauvignon Blanc',
24
+ 'Syrah',
25
+ 'Zinfandel',
26
+ ];
27
+
28
+ export default () => {
29
+ const [wineList, setWineList] = React.useState(initialWineList);
30
+ // Tracking the input value for onSubmit
31
+ const [searchInput, setSearchInput] = React.useState('');
32
+ const menuItems = wineList.map(wine => <MenuItem key={wine}>{wine}</MenuItem>);
33
+
34
+ const filterMenuItems = e => {
35
+ setSearchInput(e.target.value);
36
+ const formattedValue = e.target.value.toLowerCase();
37
+
38
+ // Reset the list if the input is cleared
39
+ if (!formattedValue.length) {
40
+ setWineList(initialWineList);
41
+ } else {
42
+ const filteredItems = wineList.filter(wine => wine.toLowerCase().startsWith(formattedValue));
43
+ setWineList(filteredItems);
44
+ }
45
+ };
46
+
47
+ const handleSubmit = () => {
48
+ // We don't need to prevent the default event because SearchForm handles that internally
49
+ console.log(`Searching for: ${searchInput}`);
50
+ };
51
+
52
+ return (
53
+ <Flex minHeight={200} alignItems="flex-start" padding="xs">
54
+ <SearchForm
55
+ autocompleteItems={menuItems}
56
+ onInputChange={filterMenuItems}
57
+ onSubmit={handleSubmit}
58
+ />
59
+ </Flex>
60
+ );
61
+ };
@@ -0,0 +1,72 @@
1
+ import * as React from 'react';
2
+ import {MenuItem} from '@workday/canvas-kit-preview-react/menu';
3
+ import {SearchForm, SearchThemeAttributes} from '@workday/canvas-kit-labs-react/search-form';
4
+ import {Flex} from '@workday/canvas-kit-labs-react/layout';
5
+ import {colors} from '@workday/canvas-kit-react/tokens';
6
+
7
+ const initialWineList = [
8
+ 'Beaujolais',
9
+ 'Bordeaux',
10
+ 'Cabernet Sauvignon',
11
+ 'Champagne',
12
+ 'Chardonnay',
13
+ 'Chianti',
14
+ 'Malbec',
15
+ 'Merlot',
16
+ 'Pinot Grigio',
17
+ 'Pinot Gris',
18
+ 'Pinot Noir',
19
+ 'Primitivo',
20
+ 'Prosecco',
21
+ 'Riesling',
22
+ 'Rioja',
23
+ 'Rosé',
24
+ 'Sauvignon Blanc',
25
+ 'Syrah',
26
+ 'Zinfandel',
27
+ ];
28
+
29
+ export default () => {
30
+ const [wineList, setWineList] = React.useState(initialWineList);
31
+ // Tracking the input value for onSubmit
32
+ const [searchInput, setSearchInput] = React.useState('');
33
+ const menuItems = wineList.map(wine => <MenuItem key={wine}>{wine}</MenuItem>);
34
+
35
+ const filterMenuItems = e => {
36
+ setSearchInput(e.target.value);
37
+ const formattedValue = e.target.value.toLowerCase();
38
+
39
+ // Reset the list if the input is cleared
40
+ if (!formattedValue.length) {
41
+ setWineList(initialWineList);
42
+ } else {
43
+ const filteredItems = wineList.filter(wine => wine.toLowerCase().startsWith(formattedValue));
44
+ setWineList(filteredItems);
45
+ }
46
+ };
47
+
48
+ const handleSubmit = () => {
49
+ // We don't need to prevent the default event because SearchForm handles that internally
50
+ console.log(`Searching for: ${searchInput}`);
51
+ };
52
+
53
+ const customTheme = {
54
+ background: colors.cinnamon600,
55
+ backgroundFocus: colors.frenchVanilla100,
56
+ placeholderColor: colors.frenchVanilla100,
57
+ placeholderColorFocus: colors.blackPepper400,
58
+ } as SearchThemeAttributes;
59
+
60
+ return (
61
+ <Flex minHeight={200} alignItems="flex-start">
62
+ <Flex padding="xs" backgroundColor="cinnamon500" flex={1} flexBasis="auto">
63
+ <SearchForm
64
+ searchTheme={customTheme}
65
+ autocompleteItems={menuItems}
66
+ onInputChange={filterMenuItems}
67
+ onSubmit={handleSubmit}
68
+ />
69
+ </Flex>
70
+ </Flex>
71
+ );
72
+ };
@@ -0,0 +1,62 @@
1
+ import * as React from 'react';
2
+ import {MenuItem} from '@workday/canvas-kit-preview-react/menu';
3
+ import {SearchForm} from '@workday/canvas-kit-labs-react/search-form';
4
+ import {Flex} from '@workday/canvas-kit-labs-react/layout';
5
+
6
+ const initialWineList = [
7
+ 'Beaujolais',
8
+ 'Bordeaux',
9
+ 'Cabernet Sauvignon',
10
+ 'Champagne',
11
+ 'Chardonnay',
12
+ 'Chianti',
13
+ 'Malbec',
14
+ 'Merlot',
15
+ 'Pinot Grigio',
16
+ 'Pinot Gris',
17
+ 'Pinot Noir',
18
+ 'Primitivo',
19
+ 'Prosecco',
20
+ 'Riesling',
21
+ 'Rioja',
22
+ 'Rosé',
23
+ 'Sauvignon Blanc',
24
+ 'Syrah',
25
+ 'Zinfandel',
26
+ ];
27
+
28
+ export default () => {
29
+ const [wineList, setWineList] = React.useState(initialWineList);
30
+ // Tracking the input value for onSubmit
31
+ const [searchInput, setSearchInput] = React.useState('');
32
+ const menuItems = wineList.map(wine => <MenuItem key={wine}>{wine}</MenuItem>);
33
+
34
+ const filterMenuItems = e => {
35
+ setSearchInput(e.target.value);
36
+ const formattedValue = e.target.value.toLowerCase();
37
+
38
+ // Reset the list if the input is cleared
39
+ if (!formattedValue.length) {
40
+ setWineList(initialWineList);
41
+ } else {
42
+ const filteredItems = wineList.filter(wine => wine.toLowerCase().startsWith(formattedValue));
43
+ setWineList(filteredItems);
44
+ }
45
+ };
46
+
47
+ const handleSubmit = () => {
48
+ // We don't need to prevent the default event because SearchForm handles that internally
49
+ console.log(`Searching for: ${searchInput}`);
50
+ };
51
+
52
+ return (
53
+ <Flex minHeight={200} alignItems="flex-start" padding="xs">
54
+ <SearchForm
55
+ autocompleteItems={menuItems}
56
+ grow
57
+ onInputChange={filterMenuItems}
58
+ onSubmit={handleSubmit}
59
+ />
60
+ </Flex>
61
+ );
62
+ };
@@ -0,0 +1,4 @@
1
+ import * as React from 'react';
2
+ import {SearchThemeAttributes} from '@workday/canvas-kit-labs-react/search-form';
3
+
4
+ export default (props: SearchThemeAttributes) => <div />;