@workday/canvas-kit-docs 9.0.0-alpha.368-next.6 → 9.0.0-alpha.382-next.2
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.
- package/dist/es6/docgen/createTraversals.js +41 -22
- package/dist/es6/docgen/docParser.js +285 -257
- package/dist/es6/docgen/getExternalSymbol.js +2 -2
- package/dist/es6/docgen/plugins/componentParser.js +28 -33
- package/dist/es6/docgen/plugins/enhancedComponentParser.js +211 -150
- package/dist/es6/docgen/plugins/modelParser.js +139 -79
- package/dist/es6/docgen/traversals.js +396 -397
- package/dist/es6/docgen/traverse.js +8 -9
- package/dist/es6/lib/DescriptionTooltip.js +1 -1
- package/dist/es6/lib/MDXElements.js +13 -39
- package/dist/es6/lib/MoreTooltip.js +21 -41
- package/dist/es6/lib/Specifications.js +30 -34
- package/dist/es6/lib/StylePropsTable.js +8 -9
- package/dist/es6/lib/Table.js +19 -30
- package/dist/es6/lib/Value.js +13 -17
- package/dist/es6/lib/docs.js +701 -397
- package/dist/es6/lib/widgetUtils.js +44 -76
- package/dist/es6/lib/widgets/array.js +1 -2
- package/dist/es6/lib/widgets/callExpression.js +4 -5
- package/dist/es6/lib/widgets/canvasColor.js +2 -2
- package/dist/es6/lib/widgets/component.js +1 -2
- package/dist/es6/lib/widgets/conditional.js +1 -2
- package/dist/es6/lib/widgets/enhancedComponent.js +19 -24
- package/dist/es6/lib/widgets/external.js +1 -4
- package/dist/es6/lib/widgets/function.js +5 -7
- package/dist/es6/lib/widgets/intersection.js +3 -4
- package/dist/es6/lib/widgets/model.js +4 -6
- package/dist/es6/lib/widgets/object.js +2 -3
- package/dist/es6/lib/widgets/parenthesis.js +1 -2
- package/dist/es6/lib/widgets/primitives.js +17 -39
- package/dist/es6/lib/widgets/qualifiedName.js +1 -2
- package/dist/es6/lib/widgets/symbol.js +1 -2
- package/dist/es6/lib/widgets/tuple.js +2 -3
- package/dist/es6/lib/widgets/typeParameter.js +1 -2
- package/dist/es6/lib/widgets/union.js +3 -4
- package/dist/es6/mdx/installBlock.js +6 -7
- package/dist/es6/mdx/style-props/examples/Background.js +5 -16
- package/dist/es6/mdx/style-props/examples/Border.js +5 -16
- package/dist/es6/mdx/style-props/examples/Color.js +5 -16
- package/dist/es6/mdx/style-props/examples/Depth.js +5 -16
- package/dist/es6/mdx/style-props/examples/Flex.js +11 -22
- package/dist/es6/mdx/style-props/examples/FlexItem.js +10 -21
- package/dist/es6/mdx/style-props/examples/Grid.js +6 -17
- package/dist/es6/mdx/style-props/examples/GridItem.js +6 -17
- package/dist/es6/mdx/style-props/examples/Layout.js +5 -16
- package/dist/es6/mdx/style-props/examples/Other.js +5 -16
- package/dist/es6/mdx/style-props/examples/Position.js +5 -16
- package/dist/es6/mdx/style-props/examples/Space.js +6 -17
- package/dist/es6/mdx/style-props/examples/Text.js +2 -2
- package/dist/es6/mdx/welcomePage.js +3 -3
- package/dist/mdx/9.0-UPGRADE-GUIDE.mdx +30 -3
- package/dist/mdx/preview-react/text-area/examples/Alert.tsx +1 -1
- package/dist/mdx/preview-react/text-input/examples/Alert.tsx +1 -1
- package/dist/mdx/preview-react/text-input/examples/ThemedAlert.tsx +5 -2
- package/dist/mdx/react/banner/examples/StickyAnimation.tsx +7 -5
- package/dist/mdx/react/common/examples/ResponsiveViewport.tsx +2 -3
- package/package.json +5 -5
|
@@ -1,30 +1,3 @@
|
|
|
1
|
-
var __assign = (this && this.__assign) || function () {
|
|
2
|
-
__assign = Object.assign || function(t) {
|
|
3
|
-
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
4
|
-
s = arguments[i];
|
|
5
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
6
|
-
t[p] = s[p];
|
|
7
|
-
}
|
|
8
|
-
return t;
|
|
9
|
-
};
|
|
10
|
-
return __assign.apply(this, arguments);
|
|
11
|
-
};
|
|
12
|
-
var __rest = (this && this.__rest) || function (s, e) {
|
|
13
|
-
var t = {};
|
|
14
|
-
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
|
|
15
|
-
t[p] = s[p];
|
|
16
|
-
if (s != null && typeof Object.getOwnPropertySymbols === "function")
|
|
17
|
-
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
|
|
18
|
-
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
|
|
19
|
-
t[p[i]] = s[p[i]];
|
|
20
|
-
}
|
|
21
|
-
return t;
|
|
22
|
-
};
|
|
23
|
-
var __spreadArray = (this && this.__spreadArray) || function (to, from) {
|
|
24
|
-
for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
|
|
25
|
-
to[j] = from[i];
|
|
26
|
-
return to;
|
|
27
|
-
};
|
|
28
1
|
import React from 'react';
|
|
29
2
|
import styled from '@emotion/styled';
|
|
30
3
|
import { createComponent } from '@workday/canvas-kit-react/common';
|
|
@@ -38,29 +11,29 @@ import { Value } from './Value';
|
|
|
38
11
|
/**
|
|
39
12
|
* This context allows us to keep track if we're within a nested stack of dialog
|
|
40
13
|
*/
|
|
41
|
-
|
|
14
|
+
const NestedContext = React.createContext(false);
|
|
42
15
|
/**
|
|
43
16
|
* Context to help keep track of breadcrumbs and update them
|
|
44
17
|
*/
|
|
45
|
-
|
|
18
|
+
const SymbolDocBreadcrumbsContext = React.createContext(undefined);
|
|
46
19
|
/** React context to track the current rendering context to avoid tables inside tables */
|
|
47
|
-
export
|
|
20
|
+
export const RenderContext = React.createContext('table');
|
|
48
21
|
/**
|
|
49
22
|
* React context to track the current heading level. This is useful to relatively change heading
|
|
50
23
|
* levels of a subtree
|
|
51
24
|
*/
|
|
52
|
-
export
|
|
25
|
+
export const HeadingLevelContext = React.createContext(3);
|
|
53
26
|
/**
|
|
54
27
|
* React context to keep track of the current indent level
|
|
55
28
|
*/
|
|
56
|
-
export
|
|
29
|
+
export const IndentLevelContext = React.createContext(0);
|
|
57
30
|
/**
|
|
58
31
|
* Utility function for getting non-breaking space for code formatting. It will print a string of
|
|
59
32
|
* non-breaking spaces according to the level provided. These characters are safe for a React render
|
|
60
33
|
* function.
|
|
61
34
|
*/
|
|
62
35
|
export function indent(level) {
|
|
63
|
-
return
|
|
36
|
+
return [...Array(level * 2)].map(v => '\u00A0').join('');
|
|
64
37
|
}
|
|
65
38
|
export function capitalize(input) {
|
|
66
39
|
return input.charAt(0).toUpperCase() + input.slice(1);
|
|
@@ -69,45 +42,43 @@ export function capitalize(input) {
|
|
|
69
42
|
* Special heading component that uses @mdx-js/react heading components, but is also aware of
|
|
70
43
|
* relative heading levels.
|
|
71
44
|
*/
|
|
72
|
-
export
|
|
45
|
+
export const Heading = createComponent('h4')({
|
|
73
46
|
displayName: 'MDXHeading',
|
|
74
|
-
Component
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
return React.createElement(MDX, __assign({ as: as }, elemProps));
|
|
47
|
+
Component({ headingOffset = 0, ...elemProps }) {
|
|
48
|
+
const headingLevel = React.useContext(HeadingLevelContext);
|
|
49
|
+
const as = `h${headingLevel + headingOffset}`; // Make Typescript happy
|
|
50
|
+
return React.createElement(MDX, Object.assign({ as: as }, elemProps));
|
|
79
51
|
},
|
|
80
52
|
});
|
|
81
53
|
export function renderTypeParameters(typeParameters) {
|
|
82
54
|
return typeParameters && typeParameters.length ? (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
83
55
|
React.createElement("span", null, "<"),
|
|
84
|
-
typeParameters.map(
|
|
56
|
+
typeParameters.map((p, index) => {
|
|
85
57
|
return (React.createElement(React.Fragment, { key: index },
|
|
86
58
|
index !== 0 && React.createElement("span", { className: "token punctuation" }, ", "),
|
|
87
59
|
React.createElement(Value, { value: p })));
|
|
88
60
|
}),
|
|
89
61
|
React.createElement("span", null, ">"))) : ('');
|
|
90
62
|
}
|
|
91
|
-
|
|
92
|
-
export
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
setSymbol(docs.find(function (d) { return value.name === d.name; }) || undefined);
|
|
63
|
+
const ButtonHyperLink = Hyperlink.as('button');
|
|
64
|
+
export const SymbolDialog = ({ value }) => {
|
|
65
|
+
const [symbol, setSymbol] = React.useState(undefined);
|
|
66
|
+
const { breadcrumbsList, updateBreadcrumbs } = React.useContext(SymbolDocBreadcrumbsContext);
|
|
67
|
+
const nestedContext = React.useContext(NestedContext);
|
|
68
|
+
const model = useDialogModel({
|
|
69
|
+
onShow() {
|
|
70
|
+
setSymbol(docs.find(d => value.name === d.name) || undefined);
|
|
100
71
|
},
|
|
101
|
-
onHide
|
|
72
|
+
onHide() {
|
|
102
73
|
// Reset breadcrumbs when the dialog is closed
|
|
103
74
|
updateBreadcrumbs([]);
|
|
104
75
|
},
|
|
105
76
|
});
|
|
106
|
-
|
|
77
|
+
const handleTargetClick = (e) => {
|
|
107
78
|
e.preventDefault();
|
|
108
79
|
updateBreadcrumbs(breadcrumbsList.concat(value.name));
|
|
109
80
|
};
|
|
110
|
-
|
|
81
|
+
const handleBreadcrumbClick = (e, index) => {
|
|
111
82
|
e.preventDefault();
|
|
112
83
|
if (e.currentTarget.textContent &&
|
|
113
84
|
breadcrumbsList.length &&
|
|
@@ -141,9 +112,9 @@ export var SymbolDialog = function (_a) {
|
|
|
141
112
|
value.name,
|
|
142
113
|
" "),
|
|
143
114
|
breadcrumbsList.length > 1 && (React.createElement(Breadcrumbs, { "aria-label": "Breadcrumbs" },
|
|
144
|
-
React.createElement(Breadcrumbs.List, { paddingX: "xxs" }, breadcrumbsList.map(
|
|
115
|
+
React.createElement(Breadcrumbs.List, { paddingX: "xxs" }, breadcrumbsList.map((item, index) => {
|
|
145
116
|
return (React.createElement(React.Fragment, null, item === breadcrumbsList[breadcrumbsList.length - 1] ? (React.createElement(Breadcrumbs.CurrentItem, { key: index }, item)) : (React.createElement(Breadcrumbs.Item, { key: index },
|
|
146
|
-
React.createElement(Breadcrumbs.Link, { onClick:
|
|
117
|
+
React.createElement(Breadcrumbs.Link, { onClick: e => handleBreadcrumbClick(e, index), href: '#' }, item)))));
|
|
147
118
|
})))),
|
|
148
119
|
React.createElement(Dialog.Body, null,
|
|
149
120
|
React.createElement(RenderContext.Provider, { value: "table" },
|
|
@@ -159,7 +130,7 @@ function createColor(color) {
|
|
|
159
130
|
color: colors[color],
|
|
160
131
|
};
|
|
161
132
|
}
|
|
162
|
-
|
|
133
|
+
const StyledSymbolDoc = styled('div')({
|
|
163
134
|
marginBottom: space.m,
|
|
164
135
|
'button[data-symbol]': {
|
|
165
136
|
border: 'none',
|
|
@@ -200,9 +171,8 @@ function getSymbolDocChildren(doc, meta, name) {
|
|
|
200
171
|
}
|
|
201
172
|
return React.createElement("div", null, "Not found");
|
|
202
173
|
}
|
|
203
|
-
function findDoc(
|
|
204
|
-
|
|
205
|
-
var doc = (docs || []).find(function (d) {
|
|
174
|
+
function findDoc({ name, fileName }) {
|
|
175
|
+
const doc = (docs || []).find(d => {
|
|
206
176
|
return d.name === name && (fileName ? d.fileName.includes(fileName) : true);
|
|
207
177
|
});
|
|
208
178
|
if ((doc === null || doc === void 0 ? void 0 : doc.type.kind) === 'alias') {
|
|
@@ -210,36 +180,35 @@ function findDoc(_a) {
|
|
|
210
180
|
}
|
|
211
181
|
return doc;
|
|
212
182
|
}
|
|
213
|
-
export
|
|
183
|
+
export const useDoc = (criteria) => {
|
|
214
184
|
// Listen to criteria.name and criteria.fileName so that we can re-fetch docs in the dialog
|
|
215
|
-
|
|
185
|
+
const doc = React.useMemo(() => findDoc(criteria), [criteria.name, criteria.fileName || '']);
|
|
216
186
|
return doc;
|
|
217
187
|
};
|
|
218
188
|
/**
|
|
219
189
|
* Renders the `<Value>` of a exported symbol without any wrapper. This should be used when nesting
|
|
220
190
|
* inside a `<SymbolDoc>` component.
|
|
221
191
|
*/
|
|
222
|
-
export
|
|
223
|
-
|
|
192
|
+
export const SymbolValue = (props) => {
|
|
193
|
+
const doc = useDoc(props);
|
|
224
194
|
return getSymbolDocChildren(doc);
|
|
225
195
|
};
|
|
226
196
|
/**
|
|
227
197
|
* Renders just the description of an exported symbol.
|
|
228
198
|
*/
|
|
229
|
-
export
|
|
230
|
-
|
|
199
|
+
export const SymbolDescription = (props) => {
|
|
200
|
+
const doc = useDoc(props);
|
|
231
201
|
return doc ? React.createElement(MdxJSToJSX, null, doc.description) : null;
|
|
232
202
|
};
|
|
233
203
|
/**
|
|
234
204
|
* Renders an exported symbol as a doc object. This will render JSDoc tags, description and setup
|
|
235
205
|
* rendering contexts for headers.
|
|
236
206
|
*/
|
|
237
|
-
export
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
var requiresCodeWrapper = [
|
|
207
|
+
export const SymbolDoc = ({ name, fileName, headingStart = 3, hideDescription = false, hideHeading = false, descriptionOverride, meta, ...elemProps }) => {
|
|
208
|
+
const doc = useDoc({ name, fileName });
|
|
209
|
+
const symbolDocBreadcrumb = React.useContext(SymbolDocBreadcrumbsContext);
|
|
210
|
+
const children = getSymbolDocChildren(doc, meta, name);
|
|
211
|
+
const requiresCodeWrapper = [
|
|
243
212
|
'symbol',
|
|
244
213
|
'generic',
|
|
245
214
|
'array',
|
|
@@ -263,16 +232,15 @@ export var SymbolDoc = function (_a) {
|
|
|
263
232
|
'function',
|
|
264
233
|
'callExpression',
|
|
265
234
|
].includes((doc === null || doc === void 0 ? void 0 : doc.type.kind) || 'notFound');
|
|
266
|
-
|
|
267
|
-
|
|
235
|
+
const contents = requiresCodeWrapper ? (React.createElement("code", { style: { display: 'block' } }, children)) : (children);
|
|
236
|
+
const symbolDocContents = (React.createElement(StyledSymbolDoc, Object.assign({}, elemProps),
|
|
268
237
|
React.createElement(HeadingLevelContext.Provider, { value: headingStart },
|
|
269
238
|
!hideHeading && React.createElement(Heading, null, name),
|
|
270
239
|
!hideDescription && doc && (React.createElement(MdxJSToJSX, null, descriptionOverride || doc.description)),
|
|
271
240
|
contents)));
|
|
272
241
|
return symbolDocBreadcrumb === undefined ? (React.createElement(SymbolDocWrapper, null, symbolDocContents)) : (symbolDocContents);
|
|
273
242
|
};
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
return (React.createElement(SymbolDocBreadcrumbsContext.Provider, { value: { breadcrumbsList: breadcrumbsList, updateBreadcrumbs: updateBreadcrumbs } }, children));
|
|
243
|
+
const SymbolDocWrapper = ({ children }) => {
|
|
244
|
+
const [breadcrumbsList, updateBreadcrumbs] = React.useState([]);
|
|
245
|
+
return (React.createElement(SymbolDocBreadcrumbsContext.Provider, { value: { breadcrumbsList, updateBreadcrumbs } }, children));
|
|
278
246
|
};
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
3
|
import { RenderContext } from '../widgetUtils';
|
|
4
|
-
registerWidget('array',
|
|
5
|
-
var value = _a.value;
|
|
4
|
+
registerWidget('array', ({ value }) => {
|
|
6
5
|
return (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
7
6
|
React.createElement(Value, { value: value.value }),
|
|
8
7
|
React.createElement("span", { className: "token punctuation" }, "[]")));
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
3
|
import { IndentLevelContext, indent } from '../widgetUtils';
|
|
4
|
-
registerWidget('callExpression',
|
|
5
|
-
|
|
6
|
-
var level = React.useContext(IndentLevelContext);
|
|
4
|
+
registerWidget('callExpression', ({ value }) => {
|
|
5
|
+
const level = React.useContext(IndentLevelContext);
|
|
7
6
|
return (React.createElement(React.Fragment, null,
|
|
8
7
|
value.name && React.createElement(Value, { value: value.name }),
|
|
9
8
|
React.createElement("span", { className: "token punctuation" }, "("),
|
|
10
|
-
React.createElement(React.Fragment, null, value.parameters.map(
|
|
9
|
+
React.createElement(React.Fragment, null, value.parameters.map((p, index) => (React.createElement(React.Fragment, { key: index },
|
|
11
10
|
index !== 0 && React.createElement("span", { className: "token punctuation" }, ", "),
|
|
12
11
|
value.parameters.length > 1 && (React.createElement(React.Fragment, null,
|
|
13
12
|
React.createElement("br", null),
|
|
@@ -16,6 +15,6 @@ registerWidget('callExpression', function (_a) {
|
|
|
16
15
|
React.createElement(Value, { value: p }))) : (React.createElement(Value, { value: p })),
|
|
17
16
|
index === value.parameters.length - 1 && index > 0 && (React.createElement(React.Fragment, null,
|
|
18
17
|
React.createElement("br", null),
|
|
19
|
-
indent(level)))))
|
|
18
|
+
indent(level))))))),
|
|
20
19
|
React.createElement("span", { className: "token punctuation" }, ")")));
|
|
21
20
|
});
|
|
@@ -2,6 +2,6 @@ import React from 'react';
|
|
|
2
2
|
import { colors } from '@workday/canvas-kit-react/tokens';
|
|
3
3
|
import { ColorPicker } from '@workday/canvas-kit-preview-react/color-picker';
|
|
4
4
|
import { registerWidget } from '../Value';
|
|
5
|
-
registerWidget('canvasColor',
|
|
6
|
-
return (React.createElement(ColorPicker, { style: { width: 170 }, colorSet: Object.values(colors), onColorChange:
|
|
5
|
+
registerWidget('canvasColor', () => {
|
|
6
|
+
return (React.createElement(ColorPicker, { style: { width: 170 }, colorSet: Object.values(colors), onColorChange: () => { } }));
|
|
7
7
|
});
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { PropertiesTable, registerWidget } from '../Value';
|
|
3
3
|
import { Heading } from '../widgetUtils';
|
|
4
|
-
registerWidget('component',
|
|
5
|
-
var value = _a.value, doc = _a.doc, meta = _a.meta;
|
|
4
|
+
registerWidget('component', ({ value, doc, meta }) => {
|
|
6
5
|
return (React.createElement(React.Fragment, null,
|
|
7
6
|
React.createElement(Heading, { headingOffset: 1 }, "Props"),
|
|
8
7
|
React.createElement(PropertiesTable, { properties: value.props })));
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
|
-
registerWidget('conditional',
|
|
4
|
-
var value = _a.value;
|
|
3
|
+
registerWidget('conditional', ({ value }) => {
|
|
5
4
|
return (React.createElement(React.Fragment, null,
|
|
6
5
|
React.createElement(Value, { value: value.check }),
|
|
7
6
|
" ",
|
|
@@ -5,7 +5,7 @@ import { MDX } from '../MDXElements';
|
|
|
5
5
|
import { SymbolDoc } from '../SymbolDoc';
|
|
6
6
|
import { PropertiesTable, registerWidget, Value } from '../Value';
|
|
7
7
|
import { Heading, HeadingLevelContext, SymbolDialog } from '../widgetUtils';
|
|
8
|
-
|
|
8
|
+
const ParentComponentNameContext = React.createContext('');
|
|
9
9
|
/**
|
|
10
10
|
* Used to keep track of JSDoc in subcomponent definitions.
|
|
11
11
|
*
|
|
@@ -17,8 +17,8 @@ var ParentComponentNameContext = React.createContext('');
|
|
|
17
17
|
* }
|
|
18
18
|
* ```
|
|
19
19
|
*/
|
|
20
|
-
|
|
21
|
-
|
|
20
|
+
const ParentComponentJSDocContext = React.createContext(defaultJSDoc);
|
|
21
|
+
const fileNameToCategoryMap = {
|
|
22
22
|
Layout: [
|
|
23
23
|
'utils/layout',
|
|
24
24
|
'utils/gridArea',
|
|
@@ -33,11 +33,10 @@ var fileNameToCategoryMap = {
|
|
|
33
33
|
Text: ['utils/text'],
|
|
34
34
|
Other: ['utils/other'],
|
|
35
35
|
};
|
|
36
|
-
registerWidget('enhancedComponent',
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
var headingLevel = React.useContext(HeadingLevelContext);
|
|
36
|
+
registerWidget('enhancedComponent', ({ value, doc, meta }) => {
|
|
37
|
+
const groups = groupProps(value.props);
|
|
38
|
+
const parentComponentName = React.useContext(ParentComponentNameContext);
|
|
39
|
+
const headingLevel = React.useContext(HeadingLevelContext);
|
|
41
40
|
// We don't want to re-document a subcomponent that is a container component with a different
|
|
42
41
|
// model. If we detect another container, only render the intro and a link to the container
|
|
43
42
|
// component
|
|
@@ -72,7 +71,7 @@ registerWidget('enhancedComponent', function (_a) {
|
|
|
72
71
|
" prop will change the element interface."))),
|
|
73
72
|
value.componentType === 'container' && value.model ? (React.createElement(MDX, { as: "p" },
|
|
74
73
|
"Props extend from ",
|
|
75
|
-
React.createElement(SymbolDialog, { value: { kind: 'symbol', name: value.model
|
|
74
|
+
React.createElement(SymbolDialog, { value: { kind: 'symbol', name: `${value.model}Config` } }),
|
|
76
75
|
". If a ",
|
|
77
76
|
React.createElement("code", null, "model"),
|
|
78
77
|
" is passed, props from ",
|
|
@@ -80,7 +79,7 @@ registerWidget('enhancedComponent', function (_a) {
|
|
|
80
79
|
value.model,
|
|
81
80
|
"Config"),
|
|
82
81
|
" are ignored.")) : null,
|
|
83
|
-
Object.keys(groups).map(
|
|
82
|
+
Object.keys(groups).map(key => {
|
|
84
83
|
return (React.createElement(React.Fragment, { key: key }, key === 'Local' ? (React.createElement(PropertiesTable, { properties: groups[key] })) : (React.createElement(Expandable, null,
|
|
85
84
|
React.createElement(Expandable.Target, { headingLevel: "h5" },
|
|
86
85
|
React.createElement(Expandable.Title, null, key),
|
|
@@ -90,30 +89,30 @@ registerWidget('enhancedComponent', function (_a) {
|
|
|
90
89
|
}),
|
|
91
90
|
value.elemPropsHook ? (React.createElement(SymbolDoc, { name: value.elemPropsHook, headingStart: headingLevel + 1 })) : null,
|
|
92
91
|
value.subComponents
|
|
93
|
-
? value.subComponents.map(
|
|
92
|
+
? value.subComponents.map((c, i) => {
|
|
94
93
|
return (React.createElement(React.Fragment, { key: i },
|
|
95
94
|
React.createElement(Heading, null,
|
|
96
95
|
parentComponentName ? parentComponentName : value.displayName,
|
|
97
96
|
".",
|
|
98
97
|
c.name),
|
|
99
|
-
React.createElement(ParentComponentNameContext.Provider, { value:
|
|
98
|
+
React.createElement(ParentComponentNameContext.Provider, { value: `${parentComponentName ? parentComponentName : value.displayName}.${c.name}` },
|
|
100
99
|
React.createElement(ParentComponentJSDocContext.Provider, { value: c },
|
|
101
100
|
React.createElement(SymbolDoc, { name: c.symbol, hideHeading: true, descriptionOverride: c.description })))));
|
|
102
101
|
})
|
|
103
102
|
: null,
|
|
104
103
|
value.componentType === 'container' && value.model ? (React.createElement(React.Fragment, null,
|
|
105
104
|
React.createElement(Heading, { headingOffset: -1 }, "Model"),
|
|
106
|
-
React.createElement(SymbolDoc, { name:
|
|
105
|
+
React.createElement(SymbolDoc, { name: `use${value.model}` }))) : null));
|
|
107
106
|
});
|
|
108
107
|
function groupProps(props) {
|
|
109
|
-
|
|
110
|
-
for (
|
|
108
|
+
const categories = { Local: [] };
|
|
109
|
+
for (const key in fileNameToCategoryMap) {
|
|
111
110
|
categories[key] = [];
|
|
112
111
|
}
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
for (
|
|
116
|
-
if (fileNameToCategoryMap[key].find(
|
|
112
|
+
for (const prop of props) {
|
|
113
|
+
let found = false;
|
|
114
|
+
for (const key in fileNameToCategoryMap) {
|
|
115
|
+
if (fileNameToCategoryMap[key].find(match => { var _a; return (_a = prop.declarations[0]) === null || _a === void 0 ? void 0 : _a.filePath.includes(match); })) {
|
|
117
116
|
found = true;
|
|
118
117
|
categories[key].push(prop);
|
|
119
118
|
}
|
|
@@ -121,13 +120,9 @@ function groupProps(props) {
|
|
|
121
120
|
if (!found) {
|
|
122
121
|
categories.Local.push(prop);
|
|
123
122
|
}
|
|
124
|
-
};
|
|
125
|
-
for (var _i = 0, props_1 = props; _i < props_1.length; _i++) {
|
|
126
|
-
var prop = props_1[_i];
|
|
127
|
-
_loop_1(prop);
|
|
128
123
|
}
|
|
129
124
|
// clear out categories that don't have anything in them
|
|
130
|
-
return Object.keys(categories).reduce(
|
|
125
|
+
return Object.keys(categories).reduce((result, key) => {
|
|
131
126
|
if (categories[key].length) {
|
|
132
127
|
result[key] = categories[key];
|
|
133
128
|
}
|
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { ExternalHyperlink } from '@workday/canvas-kit-react/button';
|
|
3
3
|
import { registerWidget } from '../Value';
|
|
4
|
-
registerWidget('external',
|
|
5
|
-
var value = _a.value;
|
|
6
|
-
return (React.createElement(ExternalHyperlink, { href: value.url }, value.name));
|
|
7
|
-
});
|
|
4
|
+
registerWidget('external', ({ value }) => (React.createElement(ExternalHyperlink, { href: value.url }, value.name)));
|
|
@@ -3,14 +3,13 @@ import { DescriptionTooltip } from '../DescriptionTooltip';
|
|
|
3
3
|
import { MdxJSToJSX } from '../MDXElements';
|
|
4
4
|
import { registerWidget, Value } from '../Value';
|
|
5
5
|
import { RenderContext, IndentLevelContext, indent, renderTypeParameters } from '../widgetUtils';
|
|
6
|
-
registerWidget('function',
|
|
7
|
-
|
|
8
|
-
var level = React.useContext(IndentLevelContext);
|
|
6
|
+
registerWidget('function', ({ value }) => {
|
|
7
|
+
const level = React.useContext(IndentLevelContext);
|
|
9
8
|
return (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
10
9
|
value.name && React.createElement(Value, { value: value.name }),
|
|
11
10
|
renderTypeParameters(value.typeParameters),
|
|
12
11
|
React.createElement("span", { className: "token punctuation" }, "("),
|
|
13
|
-
React.createElement(React.Fragment, null, value.parameters.map(
|
|
12
|
+
React.createElement(React.Fragment, null, value.parameters.map((p, index) => (React.createElement(React.Fragment, { key: index },
|
|
14
13
|
index !== 0 && React.createElement("span", { className: "token punctuation" }, ", "),
|
|
15
14
|
value.parameters.length > 1 && (React.createElement(React.Fragment, null,
|
|
16
15
|
React.createElement("br", null),
|
|
@@ -19,12 +18,11 @@ registerWidget('function', function (_a) {
|
|
|
19
18
|
React.createElement(Value, { value: p }))) : (React.createElement(Value, { value: p })),
|
|
20
19
|
index === value.parameters.length - 1 && index > 0 && (React.createElement(React.Fragment, null,
|
|
21
20
|
React.createElement("br", null),
|
|
22
|
-
indent(level)))))
|
|
21
|
+
indent(level))))))),
|
|
23
22
|
React.createElement("span", { className: "token operator" }, ")\u00A0=>\u00A0"),
|
|
24
23
|
React.createElement(Value, { value: value.returnType })));
|
|
25
24
|
});
|
|
26
|
-
registerWidget('parameter',
|
|
27
|
-
var value = _a.value;
|
|
25
|
+
registerWidget('parameter', ({ value }) => {
|
|
28
26
|
return (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
29
27
|
value.description ? (React.createElement(DescriptionTooltip, { style: { maxWidth: '50em' }, title: React.createElement(MdxJSToJSX, null, value.description) },
|
|
30
28
|
React.createElement("span", { className: "token property", style: {
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
3
|
import { RenderContext } from '../widgetUtils';
|
|
4
|
-
registerWidget('intersection',
|
|
5
|
-
|
|
6
|
-
return (React.createElement(RenderContext.Provider, { value: "inline" }, value.value.map(function (v, i) { return (React.createElement(React.Fragment, { key: i },
|
|
4
|
+
registerWidget('intersection', ({ value }) => {
|
|
5
|
+
return (React.createElement(RenderContext.Provider, { value: "inline" }, value.value.map((v, i) => (React.createElement(React.Fragment, { key: i },
|
|
7
6
|
i !== 0 && React.createElement("span", { className: "token punctuation" }, " & "),
|
|
8
|
-
React.createElement(Value, { value: v })))
|
|
7
|
+
React.createElement(Value, { value: v }))))));
|
|
9
8
|
});
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { PropertiesTable, registerWidget, Value } from '../Value';
|
|
3
3
|
import { Heading } from '../widgetUtils';
|
|
4
|
-
registerWidget('model',
|
|
5
|
-
var value = _a.value;
|
|
4
|
+
registerWidget('model', ({ value }) => {
|
|
6
5
|
return (React.createElement(React.Fragment, null,
|
|
7
6
|
React.createElement(Heading, null, "State"),
|
|
8
7
|
React.createElement(PropertiesTable, { properties: value.state, showDefault: false }),
|
|
@@ -12,8 +11,7 @@ registerWidget('model', function (_a) {
|
|
|
12
11
|
React.createElement(Heading, null, "Additional Properties"),
|
|
13
12
|
React.createElement(PropertiesTable, { properties: value.modelProperties, showDefault: false })))));
|
|
14
13
|
});
|
|
15
|
-
registerWidget('modelHook',
|
|
16
|
-
var value = _a.value, doc = _a.doc;
|
|
14
|
+
registerWidget('modelHook', ({ value, doc }) => {
|
|
17
15
|
return (React.createElement("code", null,
|
|
18
16
|
React.createElement("span", { className: "token symbol" }, value.name),
|
|
19
17
|
' ',
|
|
@@ -21,7 +19,7 @@ registerWidget('modelHook', function (_a) {
|
|
|
21
19
|
React.createElement("span", { className: "value symbol" }, "config"),
|
|
22
20
|
":",
|
|
23
21
|
' ',
|
|
24
|
-
React.createElement(Value, { value: { kind: 'symbol', name: value.name.replace('use', '')
|
|
22
|
+
React.createElement(Value, { value: { kind: 'symbol', name: `${value.name.replace('use', '')}Config` } }),
|
|
25
23
|
React.createElement("span", { className: "token punctuation" }, "): "),
|
|
26
|
-
React.createElement(Value, { value: { kind: 'symbol', name:
|
|
24
|
+
React.createElement(Value, { value: { kind: 'symbol', name: `${value.name.replace('use', '')}` } })));
|
|
27
25
|
});
|
|
@@ -1,9 +1,8 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { PropertiesInline, PropertiesTable, registerWidget } from '../Value';
|
|
3
3
|
import { RenderContext } from '../widgetUtils';
|
|
4
|
-
registerWidget('object',
|
|
5
|
-
|
|
6
|
-
var renderContext = React.useContext(RenderContext);
|
|
4
|
+
registerWidget('object', ({ value }) => {
|
|
5
|
+
const renderContext = React.useContext(RenderContext);
|
|
7
6
|
return renderContext === 'inline' ? (React.createElement(PropertiesInline, { properties: value.properties })) : (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
8
7
|
React.createElement(PropertiesTable, { properties: value.properties })));
|
|
9
8
|
});
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
|
-
registerWidget('parenthesis',
|
|
4
|
-
var value = _a.value;
|
|
3
|
+
registerWidget('parenthesis', ({ value }) => {
|
|
5
4
|
return (React.createElement("span", null,
|
|
6
5
|
React.createElement("span", { className: "token punctuation" }, "("),
|
|
7
6
|
React.createElement(Value, { value: value.value }),
|
|
@@ -1,31 +1,15 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
3
|
import { renderTypeParameters } from '../widgetUtils';
|
|
4
|
-
registerWidget('primitive',
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
});
|
|
12
|
-
registerWidget('
|
|
13
|
-
var value = _a.value;
|
|
14
|
-
return (React.createElement("span", { className: "token string" },
|
|
15
|
-
"'",
|
|
16
|
-
value.value,
|
|
17
|
-
"'"));
|
|
18
|
-
});
|
|
19
|
-
registerWidget('number', function (_a) {
|
|
20
|
-
var value = _a.value;
|
|
21
|
-
return (React.createElement("span", { className: "token number" }, value.value));
|
|
22
|
-
});
|
|
23
|
-
registerWidget('generic', function (_a) {
|
|
24
|
-
var value = _a.value;
|
|
25
|
-
return (React.createElement("span", { className: "token symbol" }, value.name));
|
|
26
|
-
});
|
|
27
|
-
registerWidget('type', function (_a) {
|
|
28
|
-
var value = _a.value, doc = _a.doc;
|
|
4
|
+
registerWidget('primitive', ({ value }) => (React.createElement("span", { className: "token primitive" }, value.value)));
|
|
5
|
+
registerWidget('boolean', ({ value }) => (React.createElement("span", { className: "token primitive" }, String(value.value))));
|
|
6
|
+
registerWidget('string', ({ value }) => (React.createElement("span", { className: "token string" },
|
|
7
|
+
"'",
|
|
8
|
+
value.value,
|
|
9
|
+
"'")));
|
|
10
|
+
registerWidget('number', ({ value }) => (React.createElement("span", { className: "token number" }, value.value)));
|
|
11
|
+
registerWidget('generic', ({ value }) => (React.createElement("span", { className: "token symbol" }, value.name)));
|
|
12
|
+
registerWidget('type', ({ value, doc }) => {
|
|
29
13
|
return (React.createElement(React.Fragment, null,
|
|
30
14
|
(doc === null || doc === void 0 ? void 0 : doc.name) && (React.createElement(React.Fragment, null,
|
|
31
15
|
React.createElement("span", { className: "token keyword" }, "type"),
|
|
@@ -37,17 +21,11 @@ registerWidget('type', function (_a) {
|
|
|
37
21
|
' ')),
|
|
38
22
|
React.createElement(Value, { value: value.value })));
|
|
39
23
|
});
|
|
40
|
-
registerWidget('infer',
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
var value = _a.value;
|
|
49
|
-
return (React.createElement(React.Fragment, null,
|
|
50
|
-
React.createElement("span", { className: "token keyword" }, "keyof"),
|
|
51
|
-
" ",
|
|
52
|
-
React.createElement(Value, { value: value.name })));
|
|
53
|
-
});
|
|
24
|
+
registerWidget('infer', ({ value }) => (React.createElement(React.Fragment, null,
|
|
25
|
+
React.createElement("span", { className: "token keyword" }, "infer"),
|
|
26
|
+
" ",
|
|
27
|
+
React.createElement(Value, { value: value.value }))));
|
|
28
|
+
registerWidget('keyof', ({ value }) => (React.createElement(React.Fragment, null,
|
|
29
|
+
React.createElement("span", { className: "token keyword" }, "keyof"),
|
|
30
|
+
" ",
|
|
31
|
+
React.createElement(Value, { value: value.name }))));
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
|
-
registerWidget('qualifiedName',
|
|
4
|
-
var value = _a.value;
|
|
3
|
+
registerWidget('qualifiedName', ({ value }) => {
|
|
5
4
|
return (React.createElement(React.Fragment, null,
|
|
6
5
|
React.createElement(Value, { value: value.left }),
|
|
7
6
|
React.createElement("span", { className: "token punctuation" }, "."),
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget } from '../Value';
|
|
3
3
|
import { SymbolDialog } from '../widgetUtils';
|
|
4
|
-
registerWidget('symbol',
|
|
5
|
-
var value = _a.value;
|
|
4
|
+
registerWidget('symbol', ({ value }) => {
|
|
6
5
|
return React.createElement(SymbolDialog, { value: value });
|
|
7
6
|
});
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { registerWidget, Value } from '../Value';
|
|
3
3
|
import { RenderContext } from '../widgetUtils';
|
|
4
|
-
registerWidget('tuple',
|
|
5
|
-
var value = _a.value;
|
|
4
|
+
registerWidget('tuple', ({ value }) => {
|
|
6
5
|
return (React.createElement(RenderContext.Provider, { value: "inline" },
|
|
7
6
|
React.createElement("span", { className: "token punctuation" }, "["),
|
|
8
|
-
value.value.map(
|
|
7
|
+
value.value.map((v, i) => (React.createElement(Value, { key: i, value: v }))),
|
|
9
8
|
React.createElement("span", { className: "token punctuation" }, "]")));
|
|
10
9
|
});
|