@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
@@ -0,0 +1,16 @@
1
+ import React from 'react';
2
+ import {LoadingAnimation} from '@workday/canvas-kit-react/loading-animation';
3
+ import {CanvasProvider, ContentDirection} from '@workday/canvas-kit-react/common';
4
+
5
+ export default () => {
6
+ const theme = {
7
+ canvas: {
8
+ direction: ContentDirection.RTL,
9
+ },
10
+ };
11
+ return (
12
+ <CanvasProvider theme={theme}>
13
+ <LoadingAnimation />
14
+ </CanvasProvider>
15
+ );
16
+ };
@@ -0,0 +1,47 @@
1
+ import {
2
+ PaginationModel,
3
+ PaginationState,
4
+ PaginationEvents,
5
+ UsePaginationModelConfig,
6
+ } from '@workday/canvas-kit-react/pagination';
7
+
8
+ // <ArgsTable of={Pagination} /> generates a very large props table given that
9
+ // PaginationProps includes FlexProps. Use this dummy component instead to
10
+ // limit the props shown.
11
+ export const PaginationHoistedComponent = (_: {model: PaginationModel}) => <div />;
12
+
13
+ // <ArgsTable of={Pagination.PageButton} /> generates a props table with
14
+ // IconButton props. Use this dummy component instead to limit the props shown.
15
+ export const PageButtonComponent = (_: {pageNumber: number}) => <div />;
16
+
17
+ // <ArgsTable of={Pagination.PageListComponent} /> generates a very large props
18
+ // table given that PageListProps includes FlexProps. Use this dummy component
19
+ // instead to limit the props shown.
20
+ export const PageListComponent = (_: {
21
+ /**
22
+ * Accepts child elements or a render prop.
23
+ */
24
+ children: (model: PaginationModel) => React.ReactNode | React.ReactNode;
25
+ }) => <div />;
26
+
27
+ // <ArgsTable of={Pagination.AdditionalDetails} /> generates a very large props
28
+ // table given that AdditionalDetailsProps includes FlexProps. Use this dummy
29
+ // component instead to limit the props shown.
30
+ export const AdditionalDetailsComponent = (_: {
31
+ /**
32
+ * Accepts child elements or a render prop.
33
+ */
34
+ children: (model: PaginationModel) => React.ReactNode | React.ReactNode;
35
+ /**
36
+ * @default true
37
+ */
38
+ shouldAnnounceToScreenReader?: boolean;
39
+ /**
40
+ * @default false
41
+ */
42
+ shouldHideDetails?: boolean;
43
+ }) => <div />;
44
+
45
+ export const PaginationModelConfigComponent = (_: UsePaginationModelConfig) => <div />;
46
+ export const PaginationStateComponent = (_: PaginationState) => <div />;
47
+ export const PaginationEventsComponent = (_: PaginationEvents) => <div />;
@@ -30,7 +30,7 @@ export default () => {
30
30
  </Pagination.PageList>
31
31
  <Pagination.StepToNextButton aria-label="Next" />
32
32
  </Pagination.Controls>
33
- <Pagination.AdditionalDetails shouldHideDetails>
33
+ <Pagination.AdditionalDetails>
34
34
  {({state}) =>
35
35
  `${getVisibleResultsMin(state.currentPage, resultCount)}-${getVisibleResultsMax(
36
36
  state.currentPage,
@@ -33,7 +33,7 @@ export default () => {
33
33
  <Pagination.JumpToLastButton aria-label="Last" />
34
34
  <Pagination.GoToForm>
35
35
  <Pagination.GoToTextInput aria-label="Go to page number" />
36
- <Pagination.GoToLabel>{({state}) => `of ${totalCount} results`}</Pagination.GoToLabel>
36
+ <Pagination.GoToLabel>{({state}) => `of ${state.lastPage} pages`}</Pagination.GoToLabel>
37
37
  </Pagination.GoToForm>
38
38
  </Pagination.Controls>
39
39
  <Pagination.AdditionalDetails shouldHideDetails>
@@ -1,4 +1,5 @@
1
1
  import * as React from 'react';
2
+ import {SecondaryButton} from '@workday/canvas-kit-react/button';
2
3
  import {
3
4
  Pagination,
4
5
  getLastPage,
@@ -16,30 +17,43 @@ export default () => {
16
17
  lastPage,
17
18
  onPageChange: number => console.log(number),
18
19
  });
20
+
19
21
  return (
20
- <Pagination aria-label="Pagination" model={model}>
21
- <Pagination.Controls>
22
- <Pagination.StepToPreviousButton aria-label="Previous" />
23
- <Pagination.PageList>
22
+ <>
23
+ <Pagination aria-label="Pagination" model={model}>
24
+ <Pagination.Controls>
25
+ <Pagination.StepToPreviousButton aria-label="Previous" />
26
+ <Pagination.PageList>
27
+ {({state}) =>
28
+ state.range.map(pageNumber => (
29
+ <Pagination.PageListItem key={pageNumber}>
30
+ <Pagination.PageButton
31
+ aria-label={`Page ${pageNumber}`}
32
+ pageNumber={pageNumber}
33
+ />
34
+ </Pagination.PageListItem>
35
+ ))
36
+ }
37
+ </Pagination.PageList>
38
+ <Pagination.StepToNextButton aria-label="Next" />
39
+ </Pagination.Controls>
40
+ <Pagination.AdditionalDetails shouldHideDetails>
24
41
  {({state}) =>
25
- state.range.map(pageNumber => (
26
- <Pagination.PageListItem key={pageNumber}>
27
- <Pagination.PageButton aria-label={`Page ${pageNumber}`} pageNumber={pageNumber} />
28
- </Pagination.PageListItem>
29
- ))
42
+ `${getVisibleResultsMin(state.currentPage, resultCount)}-${getVisibleResultsMax(
43
+ state.currentPage,
44
+ resultCount,
45
+ totalCount
46
+ )} of ${totalCount} results`
30
47
  }
31
- </Pagination.PageList>
32
- <Pagination.StepToNextButton aria-label="Next" />
33
- </Pagination.Controls>
34
- <Pagination.AdditionalDetails shouldHideDetails>
35
- {({state}) =>
36
- `${getVisibleResultsMin(state.currentPage, resultCount)}-${getVisibleResultsMax(
37
- state.currentPage,
38
- resultCount,
39
- totalCount
40
- )} of ${totalCount} results`
41
- }
42
- </Pagination.AdditionalDetails>
43
- </Pagination>
48
+ </Pagination.AdditionalDetails>
49
+ </Pagination>
50
+ <SecondaryButton
51
+ onClick={() => {
52
+ model.events.goTo(7);
53
+ }}
54
+ >
55
+ Go to Page 7
56
+ </SecondaryButton>
57
+ </>
44
58
  );
45
59
  };
@@ -36,7 +36,7 @@ export default () => {
36
36
  <Pagination.JumpToLastButton aria-label="Last" />
37
37
  <Pagination.GoToForm>
38
38
  <Pagination.GoToTextInput aria-label="Go to page number" />
39
- <Pagination.GoToLabel>{() => `من 100 صفحات`}</Pagination.GoToLabel>
39
+ <Pagination.GoToLabel>{({state}) => `از ${state.lastPage} صفحه`}</Pagination.GoToLabel>
40
40
  </Pagination.GoToForm>
41
41
  </Pagination.Controls>
42
42
  <Pagination.AdditionalDetails shouldHideDetails>