@workday/canvas-kit-docs 12.1.9 → 12.1.11

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.
@@ -34,7 +34,7 @@ export const WelcomePage = () => {
34
34
  React.createElement(Card.Heading, null, "Getting Started"),
35
35
  React.createElement(Card.Body, null,
36
36
  React.createElement(Text, null, "For all things getting started including helpful guides and docs.")),
37
- React.createElement(Grid.Item, { as: Hyperlink, alignSelf: "end", marginTop: "xs", href: "https://workday.github.io/canvas-kit/?path=/docs/guides-getting-started--page" },
37
+ React.createElement(Grid.Item, { as: Hyperlink, alignSelf: "end", marginTop: "xs", href: "https://workday.github.io/canvas-kit/?path=/docs/guides-getting-started--docs" },
38
38
  ' ',
39
39
  "Getting Started Guide")),
40
40
  React.createElement(Grid, { as: Card, gridTemplateRows: "1fr 1fr 2fr 1fr", depth: "none", display: "grid", maxHeight: 320 },
@@ -48,7 +48,7 @@ If you're using Canvas Kit and not directly using this package, there is nothing
48
48
  end. The Canvas Kit packages are using the static compilation as part of the build process. If you
49
49
  want to use this package for your own styles, you don't need to do anything special to use in
50
50
  development; just reference our
51
- [documentation](https://workday.github.io/canvas-kit/?path=/story/features-styling-welcome--page) on
51
+ [documentation](https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started--docs) on
52
52
  how to get started.
53
53
 
54
54
  For more information on why this package was introduced, please reference our
@@ -1,8 +1,8 @@
1
- import {Table} from '@workday/canvas-kit-react/table';
2
- import {base, brand, system} from '@workday/canvas-tokens-web';
3
- import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
4
- import {cssVar} from '@workday/canvas-kit-styling';
5
- import {Box} from '@workday/canvas-kit-react/layout';
1
+ import { Table } from '@workday/canvas-kit-react/table';
2
+ import { base, brand, system } from '@workday/canvas-tokens-web';
3
+ import { StatusIndicator } from '@workday/canvas-kit-preview-react/status-indicator';
4
+ import { cssVar } from '@workday/canvas-kit-styling';
5
+ import { Box } from '@workday/canvas-kit-react/layout';
6
6
 
7
7
 
8
8
  # Canvas Kit 11.0 Upgrade Guide
@@ -850,7 +850,7 @@ previously in [Main](#main) (for reference, see
850
850
  in [Main](#main) from v9).
851
851
 
852
852
  `Table` is a
853
- [compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--page)
853
+ [compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--docs)
854
854
  which provides a flexible API and access to its internals via its subcomponents.
855
855
 
856
856
  > **Note**: `rowState` prop is no longer a part of the `Table` component.
@@ -1,8 +1,8 @@
1
- import {Table} from '@workday/canvas-kit-react/table';
2
- import {base, brand, system} from '@workday/canvas-tokens-web';
3
- import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicator';
4
- import {cssVar} from '@workday/canvas-kit-styling';
5
- import {Box} from '@workday/canvas-kit-react/layout';
1
+ import { Table } from '@workday/canvas-kit-react/table';
2
+ import { base, brand, system } from '@workday/canvas-tokens-web';
3
+ import { StatusIndicator } from '@workday/canvas-kit-preview-react/status-indicator';
4
+ import { cssVar } from '@workday/canvas-kit-styling';
5
+ import { Box } from '@workday/canvas-kit-react/layout';
6
6
 
7
7
 
8
8
  # Canvas Kit 12.0 Upgrade Guide
@@ -361,7 +361,7 @@ made to provide more flexibility and better explicit components when using input
361
361
  ##### Breaking API Change
362
362
 
363
363
  The newly promoted `FormField` is a
364
- [compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--page).
364
+ [compound component](https://workday.github.io/canvas-kit/?path=/docs/guides-compound-components--docs).
365
365
  Due to the different APIs of the component, this change is **not codemodable**. The following shows
366
366
  an example of how to **update** your code to match the new compound component API.
367
367
 
@@ -155,7 +155,7 @@ Upon commit, [lint-staged](https://github.com/okonet/lint-staged) will run your
155
155
  ### Releases
156
156
 
157
157
  - Releases are prepared by updating package versions with `lerna version`, and updating the
158
- [changelog](/docs/changelog--page)
158
+ [changelog](/docs/changelog--docs)
159
159
  - A PR is created for the above updates
160
160
  - After the release PR is approved and merged, we create a release in GitHub with the contents of
161
161
  the changelog updates.
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
 
3
3
  import Basic from './examples/Basic';
4
4
  import Alert from './examples/Alert';
@@ -139,7 +139,7 @@ how to use `RadioGroup` with React Hook Form.
139
139
 
140
140
  Radio and its subcomponents support custom styling via the `cs` prop. For more information, check
141
141
  our
142
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
142
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
143
143
 
144
144
  ## Component API
145
145
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
 
3
3
  import Basic from './examples/Basic';
4
4
  import Emphasis from './examples/Emphasis';
@@ -75,7 +75,7 @@ The background color dictated by the `variant` will be dark or light based on th
75
75
 
76
76
  Status Indicator and its subcomponents support custom styling via the `cs` prop. For more
77
77
  information, check our
78
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
78
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
79
79
 
80
80
  ## Component API
81
81
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock } from '@workday/canvas-kit-docs';
2
2
 
3
3
  import Template from './examples/compoundComponent/CustomCard';
4
4
 
@@ -11,6 +11,6 @@ Component component utilites are a great way to wrap and extend exisitng Canvas
11
11
  can dramatically simplify state handling and gives you easy access to things like ref forwarding.
12
12
 
13
13
  For more complex examples,
14
- [see the creating-compound-components guide](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--page).
14
+ [see the creating-compound-components guide](https://workday.github.io/canvas-kit/?path=/docs/guides-creating-compound-components--docs).
15
15
 
16
16
  <ExampleCodeBlock code={Template} />
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
 
3
3
  import Basic from './examples/Basic';
4
4
  import CustomLimit from './examples/CustomLimit';
@@ -60,7 +60,7 @@ of another screen update, then this use of `AriaLiveRegion` is unnecessary and n
60
60
  ### Custom Styles
61
61
 
62
62
  Count Badge supports custom styling via the `cs` prop. For more information, check our
63
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
63
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
64
64
 
65
65
  ## Component API
66
66
 
@@ -1,8 +1,8 @@
1
1
  import {
2
- ExampleCodeBlock,
3
- Specifications,
4
- SymbolDoc,
5
- SymbolDescription,
2
+ ExampleCodeBlock,
3
+ Specifications,
4
+ SymbolDoc,
5
+ SymbolDescription,
6
6
  } from '@workday/canvas-kit-docs';
7
7
 
8
8
  import Primary from './examples/Primary';
@@ -86,7 +86,7 @@ the width of the button to the width of its container.
86
86
  ### Custom Styles
87
87
 
88
88
  All of our buttons support custom styling via the `cs` prop. For more information, check our
89
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page)
89
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs)
90
90
  or view the example below.
91
91
 
92
92
  <ExampleCodeBlock code={CustomStyles} />
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Basic';
3
3
  import WithCustomStyles from './examples/CustomStyles';
4
4
  import WithStencils from './examples/Stencils';
@@ -30,7 +30,7 @@ yarn add @workday/canvas-kit-react
30
30
  ### Custom Styles
31
31
 
32
32
  Card and its subcomponents support custom styling via the `cs` prop. For more information, check our
33
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
33
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
34
34
 
35
35
  <ExampleCodeBlock code={WithCustomStyles} />
36
36
 
@@ -1,8 +1,8 @@
1
1
  import {
2
- ExampleCodeBlock,
3
- SymbolDoc,
4
- Specifications,
5
- InformationHighlight,
2
+ ExampleCodeBlock,
3
+ SymbolDoc,
4
+ Specifications,
5
+ InformationHighlight,
6
6
  } from '@workday/canvas-kit-docs';
7
7
  import Alert from './examples/Alert';
8
8
  import Basic from './examples/Basic';
@@ -104,7 +104,7 @@ or `Checkbox.ErrorType.Error` if Form Field is not being used.
104
104
  ### Custom Styles
105
105
 
106
106
  Checkbox supports custom styling via the `cs` prop. For more information, check our
107
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
107
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
108
108
 
109
109
  ## Component API
110
110
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc, Specifications} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc, Specifications } from '@workday/canvas-kit-docs';
2
2
  import Autocomplete from './examples/Autocomplete';
3
3
 
4
4
  # Combobox
@@ -72,7 +72,7 @@ An Autocomplete is an example of an arbitrary combobox.
72
72
 
73
73
  Combobox and its subcomponents support custom styling via the `cs` prop. For more information, check
74
74
  our
75
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
75
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
76
76
 
77
77
  ## Component API
78
78
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, Specifications, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, Specifications, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Basic';
3
3
  import Alert from './examples/Alert';
4
4
  import Error from './examples/Error';
@@ -202,7 +202,7 @@ You can theme your error rings by wrapping an input in a `CanvasProvider` and de
202
202
 
203
203
  Form Field and its subcomponents support custom styling via the `cs` prop. For more information,
204
204
  check our
205
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
205
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
206
206
 
207
207
  ## Component API
208
208
 
@@ -1,8 +1,8 @@
1
1
  import {
2
- ExampleCodeBlock,
3
- InformationHighlight,
4
- SymbolDoc,
5
- Specifications,
2
+ ExampleCodeBlock,
3
+ InformationHighlight,
4
+ SymbolDoc,
5
+ Specifications,
6
6
  } from '@workday/canvas-kit-docs';
7
7
  import Alert from './examples/Alert';
8
8
  import Basic from './examples/Basic';
@@ -20,7 +20,7 @@ import HoistedModel from './examples/HoistedModel';
20
20
  import RefForwarding from './examples/RefForwarding';
21
21
  import FetchingDynamicItems from './examples/FetchingDynamicItems';
22
22
  import Placeholder from './examples/Placeholder';
23
- import InitialSelectedItem from './examples/InitialSelectedItem';import {Table} from '@workday/canvas-kit-react/table';
23
+ import InitialSelectedItem from './examples/InitialSelectedItem';import { Table } from '@workday/canvas-kit-react/table';
24
24
 
25
25
 
26
26
  # Canvas Kit Select
@@ -305,7 +305,7 @@ prop as well as the `value` DOM property and will update the model accordingly.
305
305
 
306
306
  Select and its subcomponents support custom styling via the `cs` prop. For more information, check
307
307
  our
308
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
308
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
309
309
 
310
310
  ## Component API
311
311
 
@@ -1,8 +1,8 @@
1
1
  import {
2
- ExampleCodeBlock,
3
- SymbolDoc,
4
- Specifications,
5
- InformationHighlight,
2
+ ExampleCodeBlock,
3
+ SymbolDoc,
4
+ Specifications,
5
+ InformationHighlight,
6
6
  } from '@workday/canvas-kit-docs';
7
7
  import Alert from './examples/Alert';
8
8
  import Basic from './examples/Basic';
@@ -73,7 +73,7 @@ The `error` prop may be applied directly to the Switch with a value of `Switch.E
73
73
  ### Custom Styles
74
74
 
75
75
  Switch supports custom styling via the `cs` prop. For more information, check our
76
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
76
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
77
77
 
78
78
  ## Component API
79
79
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Basic';
3
3
  import BasicWithHeading from './examples/BasicWithHeading';
4
4
  import FixedColumn from './examples/FixedColumn';
@@ -62,7 +62,7 @@ You can also find several advanced Table examples in our Storybook Examples sect
62
62
 
63
63
  Table and its subcomponents support custom styling via the `cs` prop. For more information, check
64
64
  our
65
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
65
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
66
66
 
67
67
  ## Component API
68
68
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/BodyText/Basic';
3
3
 
4
4
  # Canvas Kit Body Text
@@ -29,7 +29,7 @@ You may override the rendered element using the `as` prop.
29
29
  ### Custom Styles
30
30
 
31
31
  Body Text supports custom styling via the `cs` prop. For more information, check our
32
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
32
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
33
33
 
34
34
  ## Component API
35
35
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';import Basic from './examples/Heading/Basic';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';import Basic from './examples/Heading/Basic';
2
2
 
3
3
 
4
4
  # Canvas Kit Heading
@@ -29,7 +29,7 @@ according to the [Canvas type hierarchy](/tokens/type/#type-styles).
29
29
  ### Custom Styles
30
30
 
31
31
  Heading supports custom styling via the `cs` prop. For more information, check our
32
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
32
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
33
33
 
34
34
  ## Component API
35
35
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Subtext/Basic';
3
3
 
4
4
  # Canvas Kit Subtext
@@ -29,7 +29,7 @@ You may override the rendered element using the `as` prop.
29
29
  ### Custom Styles
30
30
 
31
31
  Subtext supports custom styling via the `cs` prop. For more information, check our
32
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
32
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
33
33
 
34
34
  ## Component API
35
35
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Text/Basic';
3
3
  import TypeLevel from './examples/Text/TypeLevel';
4
4
  import Variant from './examples/Text/Variant';
@@ -44,7 +44,7 @@ understanding of the text being rendered.
44
44
  ### Custom Styles
45
45
 
46
46
  Text supports custom styling via the `cs` prop. For more information, check our
47
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
47
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
48
48
 
49
49
  ## Component API
50
50
 
@@ -1,4 +1,4 @@
1
- import {ExampleCodeBlock, SymbolDoc} from '@workday/canvas-kit-docs';
1
+ import { ExampleCodeBlock, SymbolDoc } from '@workday/canvas-kit-docs';
2
2
  import Basic from './examples/Title/Basic';
3
3
 
4
4
  # Canvas Kit Title
@@ -29,7 +29,7 @@ You may override the rendered element using the `as` prop.
29
29
  ### Custom Styles
30
30
 
31
31
  Title supports custom styling via the `cs` prop. For more information, check our
32
- ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--page).
32
+ ["How To Customize Styles"](https://workday.github.io/canvas-kit/?path=/docs/styling-how-to-customize-styles--docs).
33
33
 
34
34
  ## Component API
35
35
 
@@ -1,4 +1,4 @@
1
- import Readme from '../../../README.md';
1
+ 33import Readme from '../../../README.md';
2
2
  import Markdown from '../../../utils/storybook/Markdown.tsx';
3
3
  import {WelcomePage} from './welcomePage';
4
4
  import {InstallBlock} from './installBlock';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@workday/canvas-kit-docs",
3
- "version": "12.1.9",
3
+ "version": "12.1.11",
4
4
  "description": "Documentation components of Canvas Kit components",
5
5
  "author": "Workday, Inc. (https://www.workday.com)",
6
6
  "license": "Apache-2.0",
@@ -44,10 +44,10 @@
44
44
  "dependencies": {
45
45
  "@emotion/styled": "^11.6.0",
46
46
  "@storybook/csf": "0.0.1",
47
- "@workday/canvas-kit-labs-react": "^12.1.9",
48
- "@workday/canvas-kit-preview-react": "^12.1.9",
49
- "@workday/canvas-kit-react": "^12.1.9",
50
- "@workday/canvas-kit-styling": "^12.1.9",
47
+ "@workday/canvas-kit-labs-react": "^12.1.11",
48
+ "@workday/canvas-kit-preview-react": "^12.1.11",
49
+ "@workday/canvas-kit-react": "^12.1.11",
50
+ "@workday/canvas-kit-styling": "^12.1.11",
51
51
  "@workday/canvas-system-icons-web": "^3.0.0",
52
52
  "@workday/canvas-tokens-web": "^2.0.1",
53
53
  "markdown-to-jsx": "^7.2.0",
@@ -60,5 +60,5 @@
60
60
  "mkdirp": "^1.0.3",
61
61
  "typescript": "5.0"
62
62
  },
63
- "gitHead": "af0aae95c02e68874b831541306e1716a3070327"
63
+ "gitHead": "5e1dba26c09e0d1572bd83e02f7fd5e48fb06f4e"
64
64
  }