@d-fischer/documen.ts 0.16.0-pre.2 → 0.16.0-pre.3
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/lib/common/components/BetaNotice.js +23 -0
- package/lib/common/components/BetaNotice.js.map +1 -0
- package/lib/common/components/DeprecationNotice.js +3 -2
- package/lib/common/components/DeprecationNotice.js.map +1 -1
- package/lib/common/components/FunctionParamDesc.js +3 -3
- package/lib/common/components/FunctionParamDesc.js.map +1 -1
- package/lib/common/components/FunctionReturnType.js +3 -3
- package/lib/common/components/FunctionReturnType.js.map +1 -1
- package/lib/common/components/cards/EventCard.js +13 -4
- package/lib/common/components/cards/EventCard.js.map +1 -1
- package/lib/common/components/cards/FunctionCardHeader.js +4 -2
- package/lib/common/components/cards/FunctionCardHeader.js.map +1 -1
- package/lib/common/components/cards/PropertyCard.js +2 -0
- package/lib/common/components/cards/PropertyCard.js.map +1 -1
- package/lib/common/components/overviewTable/OverviewTableEntry.js +12 -4
- package/lib/common/components/overviewTable/OverviewTableEntry.js.map +1 -1
- package/lib/common/htmlRenderer/HtmlRenderer.js +4 -0
- package/lib/common/htmlRenderer/HtmlRenderer.js.map +1 -1
- package/lib/common/theme.js +2 -1
- package/lib/common/theme.js.map +1 -1
- package/package.json +1 -1
- package/public/index.html +4 -0
- package/src/common/components/BetaNotice.tsx +28 -0
- package/src/common/components/DeprecationNotice.tsx +14 -10
- package/src/common/components/FunctionParamDesc.tsx +50 -38
- package/src/common/components/FunctionReturnType.tsx +3 -3
- package/src/common/components/cards/EventCard.tsx +49 -27
- package/src/common/components/cards/FunctionCardHeader.tsx +13 -8
- package/src/common/components/cards/PropertyCard.tsx +26 -17
- package/src/common/components/overviewTable/OverviewTableEntry.tsx +47 -22
- package/src/common/htmlRenderer/HtmlRenderer.tsx +4 -0
- package/src/common/theme.ts +3 -3
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const tslib_1 = require("tslib");
|
|
4
|
+
const react_1 = tslib_1.__importDefault(require("react"));
|
|
5
|
+
const styles_1 = require("@material-ui/styles");
|
|
6
|
+
const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
7
|
+
root: {
|
|
8
|
+
display: 'flow-root',
|
|
9
|
+
borderLeft: `${theme.spacing.unit / 2}px solid ${theme.colors.badges.beta}`,
|
|
10
|
+
backgroundColor: theme.colors.background.active,
|
|
11
|
+
padding: theme.spacing.unit * 2,
|
|
12
|
+
paddingBottom: theme.spacing.unit,
|
|
13
|
+
margin: '1em 0'
|
|
14
|
+
}
|
|
15
|
+
}), { name: 'BetaNotice' });
|
|
16
|
+
const BetaNotice = () => {
|
|
17
|
+
const classes = useStyles();
|
|
18
|
+
return (react_1.default.createElement("div", { className: classes.root },
|
|
19
|
+
react_1.default.createElement("h3", null, "Beta"),
|
|
20
|
+
react_1.default.createElement("p", null, "This is an interface that may change without notice until it loses this beta annotation.")));
|
|
21
|
+
};
|
|
22
|
+
exports.default = BetaNotice;
|
|
23
|
+
//# sourceMappingURL=BetaNotice.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"BetaNotice.js","sourceRoot":"","sources":["../../../src/common/components/BetaNotice.tsx"],"names":[],"mappings":";;;AAAA,0DAA0B;AAC1B,gDAAiD;AAEjD,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE;QACL,OAAO,EAAE,WAAW;QACpB,UAAU,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,YAAY,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE;QAC3E,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM;QAC/C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;QAC/B,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI;QACjC,MAAM,EAAE,OAAO;KACf;CACD,CAAC,EACF,EAAE,IAAI,EAAE,YAAY,EAAE,CACtB,CAAC;AAEF,MAAM,UAAU,GAAa,GAAG,EAAE;IACjC,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,OAAO,CACN,uCAAK,SAAS,EAAE,OAAO,CAAC,IAAI;QAC3B,iDAAa;QACb,oIAA+F,CAC1F,CACN,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,UAAU,CAAC"}
|
|
@@ -9,8 +9,9 @@ const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
|
9
9
|
borderLeft: `${theme.spacing.unit / 2}px solid ${theme.colors.badges.deprecated}`,
|
|
10
10
|
backgroundColor: theme.colors.background.active,
|
|
11
11
|
padding: theme.spacing.unit * 2,
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
paddingBottom: theme.spacing.unit,
|
|
13
|
+
margin: `${theme.spacing.unit * 2}px 0`
|
|
14
|
+
}
|
|
14
15
|
}), { name: 'DeprecationNotice' });
|
|
15
16
|
const DeprecationNotice = ({ children }) => {
|
|
16
17
|
const classes = useStyles();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"DeprecationNotice.js","sourceRoot":"","sources":["../../../src/common/components/DeprecationNotice.tsx"],"names":[],"mappings":";;;AAAA,0DAA0B;AAC1B,gDAAiD;AAEjD,MAAM,SAAS,GAAG,IAAA,mBAAU,
|
|
1
|
+
{"version":3,"file":"DeprecationNotice.js","sourceRoot":"","sources":["../../../src/common/components/DeprecationNotice.tsx"],"names":[],"mappings":";;;AAAA,0DAA0B;AAC1B,gDAAiD;AAEjD,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE;QACL,OAAO,EAAE,WAAW;QACpB,UAAU,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,YAAY,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE;QACjF,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM;QAC/C,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC;QAC/B,aAAa,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI;QACjC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,MAAM;KACvC;CACD,CAAC,EACF,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAC7B,CAAC;AAEF,MAAM,iBAAiB,GAAsC,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE;IAC7E,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,OAAO,CACN,uCAAK,SAAS,EAAE,OAAO,CAAC,IAAI;QAC3B,uDAAmB;QAClB,QAAQ,CACJ,CACN,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}
|
|
@@ -8,7 +8,7 @@ const FunctionParamDescEntry_1 = tslib_1.__importDefault(require("./FunctionPara
|
|
|
8
8
|
const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
9
9
|
root: {
|
|
10
10
|
border: `1px solid ${theme.colors.border}`,
|
|
11
|
-
margin: `${theme.spacing.unit}px 0`
|
|
11
|
+
margin: `${theme.spacing.unit * 2}px 0`
|
|
12
12
|
},
|
|
13
13
|
heading: {
|
|
14
14
|
padding: theme.spacing.unit,
|
|
@@ -20,7 +20,7 @@ const FunctionParamDesc = ({ functionDefinition, signature, isCallback }) => {
|
|
|
20
20
|
if (!signature.parameters.length) {
|
|
21
21
|
return null;
|
|
22
22
|
}
|
|
23
|
-
return react_1.default.createElement("table", { className: classes.root },
|
|
23
|
+
return (react_1.default.createElement("table", { className: classes.root },
|
|
24
24
|
react_1.default.createElement("thead", null,
|
|
25
25
|
react_1.default.createElement("tr", null,
|
|
26
26
|
react_1.default.createElement("th", { className: classes.heading }, "Parameter"),
|
|
@@ -29,7 +29,7 @@ const FunctionParamDesc = ({ functionDefinition, signature, isCallback }) => {
|
|
|
29
29
|
react_1.default.createElement("th", { className: classes.heading }, "Required"),
|
|
30
30
|
react_1.default.createElement("th", { className: classes.heading }, "Default"))),
|
|
31
31
|
react_1.default.createElement("th", { className: classes.heading }, "Description"))),
|
|
32
|
-
react_1.default.createElement("tbody", null, signature.parameters.map(param => (react_1.default.createElement(FunctionParamDescEntry_1.default, { key: param.name, param: param, functionSignature: signature, functionDefinition: functionDefinition, isCallback: isCallback, expandParams: (0, CodeTools_1.hasTag)(signature, 'expandParams') })))));
|
|
32
|
+
react_1.default.createElement("tbody", null, signature.parameters.map(param => (react_1.default.createElement(FunctionParamDescEntry_1.default, { key: param.name, param: param, functionSignature: signature, functionDefinition: functionDefinition, isCallback: isCallback, expandParams: (0, CodeTools_1.hasTag)(signature, 'expandParams') }))))));
|
|
33
33
|
};
|
|
34
34
|
exports.default = FunctionParamDesc;
|
|
35
35
|
//# sourceMappingURL=FunctionParamDesc.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FunctionParamDesc.js","sourceRoot":"","sources":["../../../src/common/components/FunctionParamDesc.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;
|
|
1
|
+
{"version":3,"file":"FunctionParamDesc.js","sourceRoot":"","sources":["../../../src/common/components/FunctionParamDesc.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAU1B,kDAA4C;AAE5C,8FAA8D;AAQ9D,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE;QACL,MAAM,EAAE,aAAa,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE;QAC1C,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,MAAM;KACvC;IACD,OAAO,EAAE;QACR,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI;QAC3B,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM;KAC/C;CACD,CAAC,EACF,EAAE,IAAI,EAAE,mBAAmB,EAAE,CAC7B,CAAC;AAEF,MAAM,iBAAiB,GAAqC,CAAC,EAAE,kBAAkB,EAAE,SAAS,EAAE,UAAU,EAAE,EAAE,EAAE;IAC7G,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,MAAM,EAAE;QACjC,OAAO,IAAI,CAAC;KACZ;IACD,OAAO,CACN,yCAAO,SAAS,EAAE,OAAO,CAAC,IAAI;QAC7B;YACC;gBACC,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,gBAAgB;gBAC9C,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,WAAW;gBACxC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CACpB;oBACC,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,eAAe;oBAC7C,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,cAAc,CAC1C,CACH;gBACD,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,kBAAkB,CAC5C,CACE;QACR,6CACE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAClC,8BAAC,gCAAsB,IACtB,GAAG,EAAE,KAAK,CAAC,IAAI,EACf,KAAK,EAAE,KAAK,EACZ,iBAAiB,EAAE,SAAS,EAC5B,kBAAkB,EAAE,kBAAkB,EACtC,UAAU,EAAE,UAAU,EACtB,YAAY,EAAE,IAAA,kBAAM,EAAC,SAAS,EAAE,cAAc,CAAC,GAC9C,CACF,CAAC,CACK,CACD,CACR,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}
|
|
@@ -6,15 +6,15 @@ const styles_1 = require("@material-ui/styles");
|
|
|
6
6
|
const react_1 = tslib_1.__importDefault(require("react"));
|
|
7
7
|
const NodeTools_1 = require("../tools/NodeTools");
|
|
8
8
|
const Type_1 = tslib_1.__importDefault(require("./codeBuilders/Type"));
|
|
9
|
-
const useStyles = (0, styles_1.makeStyles)({
|
|
9
|
+
const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
10
10
|
root: {
|
|
11
11
|
fontWeight: 'bold',
|
|
12
|
-
margin:
|
|
12
|
+
margin: `${theme.spacing.unit * 2}px 0 0`
|
|
13
13
|
},
|
|
14
14
|
type: {
|
|
15
15
|
fontWeight: 'normal'
|
|
16
16
|
}
|
|
17
|
-
}, { name: 'FunctionReturnType' });
|
|
17
|
+
}), { name: 'FunctionReturnType' });
|
|
18
18
|
const FunctionReturnType = ({ signature }) => {
|
|
19
19
|
const classes = useStyles();
|
|
20
20
|
const { returnType } = (0, NodeTools_1.useAsyncType)(signature);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FunctionReturnType.js","sourceRoot":"","sources":["../../../src/common/components/FunctionReturnType.tsx"],"names":[],"mappings":";;;;AAAA,gDAAiD;AACjD,0DAA0B;AAE1B,kDAAkD;AAClD,uEAAuC;AAMvC,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B;
|
|
1
|
+
{"version":3,"file":"FunctionReturnType.js","sourceRoot":"","sources":["../../../src/common/components/FunctionReturnType.tsx"],"names":[],"mappings":";;;;AAAA,gDAAiD;AACjD,0DAA0B;AAE1B,kDAAkD;AAClD,uEAAuC;AAMvC,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE;QACL,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,QAAQ;KACzC;IACD,IAAI,EAAE;QACL,UAAU,EAAE,QAAQ;KACpB;CACD,CAAC,EACF,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAC9B,CAAC;AAEK,MAAM,kBAAkB,GAAqD,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE;IACrG,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAE5B,MAAM,EAAE,UAAU,EAAE,GAAG,IAAA,wBAAY,EAAC,SAAS,CAAC,CAAC;IAE/C,OAAO,CACN,uCAAK,SAAS,EAAE,OAAO,CAAC,IAAI;;QACd,GAAG;QAChB,wCAAM,SAAS,EAAE,OAAO,CAAC,IAAI;YAC5B,8BAAC,cAAI,IAAC,GAAG,EAAE,UAAU,GAAI,CACnB,CACF,CACN,CAAC;AACH,CAAC,CAAC;AAbW,QAAA,kBAAkB,sBAa7B"}
|
|
@@ -8,18 +8,24 @@ const CodeTools_1 = require("../../tools/CodeTools");
|
|
|
8
8
|
const MarkdownParser_1 = tslib_1.__importDefault(require("../../tools/markdown/MarkdownParser"));
|
|
9
9
|
const NodeTools_1 = require("../../tools/NodeTools");
|
|
10
10
|
const ReferenceTools_1 = require("../../tools/ReferenceTools");
|
|
11
|
+
const BetaNotice_1 = tslib_1.__importDefault(require("../BetaNotice"));
|
|
11
12
|
const DeprecationNotice_1 = tslib_1.__importDefault(require("../DeprecationNotice"));
|
|
12
13
|
const FunctionParamDesc_1 = tslib_1.__importDefault(require("../FunctionParamDesc"));
|
|
13
14
|
const CardToolbar_1 = tslib_1.__importDefault(require("./CardToolbar"));
|
|
14
15
|
function getParamDefinition(param) {
|
|
15
|
-
if (param.type.type === 'reflection' &&
|
|
16
|
+
if (param.type.type === 'reflection' &&
|
|
17
|
+
param.type.declaration.signatures &&
|
|
18
|
+
param.type.declaration.signatures.length) {
|
|
16
19
|
return param.type.declaration.signatures[0];
|
|
17
20
|
}
|
|
18
21
|
else if (param.type.type === 'reference' && param.type.id) {
|
|
19
22
|
const ref = (0, ReferenceTools_1.findSymbolByMember)('id', param.type.id);
|
|
20
23
|
if (ref) {
|
|
21
24
|
const { symbol } = ref;
|
|
22
|
-
if (symbol.kind === 'typeAlias' &&
|
|
25
|
+
if (symbol.kind === 'typeAlias' &&
|
|
26
|
+
symbol.type.type === 'reflection' &&
|
|
27
|
+
symbol.type.declaration.signatures &&
|
|
28
|
+
symbol.type.declaration.signatures.length) {
|
|
23
29
|
return symbol.type.declaration.signatures[0];
|
|
24
30
|
}
|
|
25
31
|
}
|
|
@@ -44,7 +50,9 @@ const EventCard = ({ name, definition }) => {
|
|
|
44
50
|
const classes = useStyles();
|
|
45
51
|
let handlerDefinition = undefined;
|
|
46
52
|
let handlerParamDefinition = undefined;
|
|
47
|
-
if (definition.type.type === 'reflection' &&
|
|
53
|
+
if (definition.type.type === 'reflection' &&
|
|
54
|
+
definition.type.declaration.signatures &&
|
|
55
|
+
definition.type.declaration.signatures.length) {
|
|
48
56
|
handlerDefinition = definition.type.declaration.signatures[0];
|
|
49
57
|
if (handlerDefinition.parameters.length) {
|
|
50
58
|
handlerParamDefinition = getParamDefinition(handlerDefinition.parameters[0]);
|
|
@@ -86,9 +94,10 @@ const EventCard = ({ name, definition }) => {
|
|
|
86
94
|
")"),
|
|
87
95
|
(0, CodeTools_1.hasTag)(definition, 'deprecated') && (react_1.default.createElement(DeprecationNotice_1.default, null,
|
|
88
96
|
react_1.default.createElement(MarkdownParser_1.default, { source: (0, CodeTools_1.getTag)(definition, 'deprecated') }))),
|
|
97
|
+
(0, CodeTools_1.hasTag)(definition, 'beta') && react_1.default.createElement(BetaNotice_1.default, null),
|
|
89
98
|
((_b = definition.comment) === null || _b === void 0 ? void 0 : _b.shortText) ? react_1.default.createElement(MarkdownParser_1.default, { source: definition.comment.shortText }) : null,
|
|
90
99
|
((_c = definition.comment) === null || _c === void 0 ? void 0 : _c.text) ? react_1.default.createElement(MarkdownParser_1.default, { source: definition.comment.text }) : null,
|
|
91
|
-
handlerParamDefinition ? react_1.default.createElement(FunctionParamDesc_1.default, { functionDefinition: definition, signature: handlerParamDefinition, isCallback: true }) : null));
|
|
100
|
+
handlerParamDefinition ? (react_1.default.createElement(FunctionParamDesc_1.default, { functionDefinition: definition, signature: handlerParamDefinition, isCallback: true })) : null));
|
|
92
101
|
};
|
|
93
102
|
exports.default = EventCard;
|
|
94
103
|
//# sourceMappingURL=EventCard.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"EventCard.js","sourceRoot":"","sources":["../../../../src/common/components/cards/EventCard.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,yEAAyC;AAEzC,qDAAuD;AACvD,iGAAiE;AACjE,qDAAsD;AACtD,+
|
|
1
|
+
{"version":3,"file":"EventCard.js","sourceRoot":"","sources":["../../../../src/common/components/cards/EventCard.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,yEAAyC;AAEzC,qDAAuD;AACvD,iGAAiE;AACjE,qDAAsD;AACtD,+DAAgE;AAChE,uEAAuC;AACvC,qFAAqD;AAErD,qFAAqD;AACrD,wEAAwC;AAOxC,SAAS,kBAAkB,CAAC,KAA6B;IACxD,IACC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY;QAChC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU;QACjC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EACvC;QACD,OAAO,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;KAC5C;SAAM,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE;QAC5D,MAAM,GAAG,GAAG,IAAA,mCAAkB,EAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACpD,IAAI,GAAG,EAAE;YACR,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC;YACvB,IACC,MAAM,CAAC,IAAI,KAAK,WAAW;gBAC3B,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY;gBACjC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU;gBAClC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EACxC;gBACD,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;aAC7C;SACD;KACD;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,EAAE;IACR,OAAO,EAAE;QACR,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,yBAAyB;QAErC,eAAe,EAAE;YAChB,OAAO,EAAE,CAAC;SACV;KACD;IACD,OAAO,EAAE;QACR,UAAU,EAAE,KAAK,CAAC,KAAK,CAAC,IAAI;KAC5B;CACD,CAAC,EACF,EAAE,IAAI,EAAE,WAAW,EAAE,CACrB,CAAC;AAEF,MAAM,SAAS,GAA6B,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE;;IACpE,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,IAAI,iBAAiB,GAA2C,SAAS,CAAC;IAC1E,IAAI,sBAAsB,GAA2C,SAAS,CAAC;IAC/E,IACC,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,YAAY;QACrC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU;QACtC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,EAC5C;QACD,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;QAC9D,IAAI,iBAAiB,CAAC,UAAU,CAAC,MAAM,EAAE;YACxC,sBAAsB,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;SAC7E;KACD;SAAM,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,KAAK,WAAW,KAAI,MAAA,UAAU,CAAC,IAAI,CAAC,aAAa,0CAAE,MAAM,CAAA,EAAE;QACzF,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;QACpD,IAAI,UAAU,CAAC,IAAI,KAAK,OAAO,EAAE;YAChC,sBAAsB,GAAG;gBACxB,EAAE,EAAE,CAAC,CAAC;gBACN,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,eAAe;gBACrB,UAAU,EAAE,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;oBACnD,EAAE,EAAE,CAAC,CAAC;oBACN,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,GAAG,EAAE;oBACnE,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,oBAAoB,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI;oBAClE,QAAQ,EAAE,UAAU,CAAC,QAAQ;iBAC7B,CAAC,CAAC;gBACH,IAAI,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,MAAM;iBACZ;gBACD,QAAQ,EAAE,UAAU,CAAC,QAAQ;aAC7B,CAAC;SACF;KACD;IACD,OAAO,CACN,8BAAC,cAAI,IAAC,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,IAAA,yBAAa,EAAC,UAAU,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE;QACrF,8BAAC,qBAAW,IAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,GAAI;QAC/E,sCAAI,SAAS,EAAE,OAAO,CAAC,OAAO,IAC5B,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAU,CAAC,IAAI;;YACvB,sBAAsB,CAAC,CAAC,CAAC,CACzB;;gBAEE,sBAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,iBAAiB,EAAE,EAAE,CAAC,CAC3E,8BAAC,eAAK,CAAC,QAAQ,IAAC,GAAG,EAAE,YAAY,CAAC,IAAI;oBACpC,iBAAiB,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI;oBACnC,YAAY,CAAC,IAAI,CACF,CACjB,CAAC;;gBACO,mBAAmB,CAC1B,CACH,CAAC,CAAC,CAAC,IAAI;gBAEJ;QACJ,IAAA,kBAAM,EAAC,UAAU,EAAE,YAAY,CAAC,IAAI,CACpC,8BAAC,2BAAiB;YACjB,8BAAC,wBAAc,IAAC,MAAM,EAAE,IAAA,kBAAM,EAAC,UAAU,EAAE,YAAY,CAAE,GAAI,CAC1C,CACpB;QACA,IAAA,kBAAM,EAAC,UAAU,EAAE,MAAM,CAAC,IAAI,8BAAC,oBAAU,OAAG;QAC5C,CAAA,MAAA,UAAU,CAAC,OAAO,0CAAE,SAAS,EAAC,CAAC,CAAC,8BAAC,wBAAc,IAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,SAAS,GAAI,CAAC,CAAC,CAAC,IAAI;QAC/F,CAAA,MAAA,UAAU,CAAC,OAAO,0CAAE,IAAI,EAAC,CAAC,CAAC,8BAAC,wBAAc,IAAC,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,IAAI,GAAI,CAAC,CAAC,CAAC,IAAI;QACrF,sBAAsB,CAAC,CAAC,CAAC,CACzB,8BAAC,2BAAiB,IAAC,kBAAkB,EAAE,UAAU,EAAE,SAAS,EAAE,sBAAsB,EAAE,UAAU,SAAG,CACnG,CAAC,CAAC,CAAC,IAAI,CACF,CACP,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,SAAS,CAAC"}
|
|
@@ -8,13 +8,14 @@ const CodeTools_1 = require("../../tools/CodeTools");
|
|
|
8
8
|
const MarkdownParser_1 = tslib_1.__importDefault(require("../../tools/markdown/MarkdownParser"));
|
|
9
9
|
const NodeTools_1 = require("../../tools/NodeTools");
|
|
10
10
|
const Badge_1 = tslib_1.__importDefault(require("../Badge"));
|
|
11
|
+
const BetaNotice_1 = tslib_1.__importDefault(require("../BetaNotice"));
|
|
11
12
|
const DeprecationNotice_1 = tslib_1.__importDefault(require("../DeprecationNotice"));
|
|
12
13
|
const FunctionSignature_1 = tslib_1.__importDefault(require("../FunctionSignature"));
|
|
13
14
|
const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
14
15
|
root: {},
|
|
15
16
|
asyncBadge: {
|
|
16
17
|
backgroundColor: theme.colors.badges.async
|
|
17
|
-
}
|
|
18
|
+
}
|
|
18
19
|
}), { name: 'FunctionCardHeader' });
|
|
19
20
|
const FunctionCardHeader = ({ sig, definition, parent }) => {
|
|
20
21
|
var _a;
|
|
@@ -25,7 +26,8 @@ const FunctionCardHeader = ({ sig, definition, parent }) => {
|
|
|
25
26
|
((_a = definition.flags) === null || _a === void 0 ? void 0 : _a.isStatic) && react_1.default.createElement(Badge_1.default, null, "static"),
|
|
26
27
|
isAsync && (react_1.default.createElement(Badge_1.default, { className: classes.asyncBadge, title: "This method actually returns a Promise object, but the use of await is recommended for easier use. Please click on the badge for further information.", href: "https://developer.mozilla.org/docs/Web/JavaScript/Reference/Operators/await" }, "async")),
|
|
27
28
|
(0, CodeTools_1.hasTag)(sig, 'deprecated') && (react_1.default.createElement(DeprecationNotice_1.default, null,
|
|
28
|
-
react_1.default.createElement(MarkdownParser_1.default, { source: (0, CodeTools_1.getTag)(sig, 'deprecated') })))
|
|
29
|
+
react_1.default.createElement(MarkdownParser_1.default, { source: (0, CodeTools_1.getTag)(sig, 'deprecated') }))),
|
|
30
|
+
(0, CodeTools_1.hasTag)(sig, 'beta') && react_1.default.createElement(BetaNotice_1.default, null)));
|
|
29
31
|
};
|
|
30
32
|
exports.FunctionCardHeader = FunctionCardHeader;
|
|
31
33
|
//# sourceMappingURL=FunctionCardHeader.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FunctionCardHeader.js","sourceRoot":"","sources":["../../../../src/common/components/cards/FunctionCardHeader.tsx"],"names":[],"mappings":";;;;AAAA,gDAAiD;AACjD,0DAA0B;AAU1B,qDAAuD;AACvD,iGAAiE;AACjE,qDAAqD;AACrD,6DAA6B;AAC7B,qFAAqD;AACrD,qFAAqD;AAQrD,MAAM,SAAS,GAAG,IAAA,mBAAU,
|
|
1
|
+
{"version":3,"file":"FunctionCardHeader.js","sourceRoot":"","sources":["../../../../src/common/components/cards/FunctionCardHeader.tsx"],"names":[],"mappings":";;;;AAAA,gDAAiD;AACjD,0DAA0B;AAU1B,qDAAuD;AACvD,iGAAiE;AACjE,qDAAqD;AACrD,6DAA6B;AAC7B,uEAAuC;AACvC,qFAAqD;AACrD,qFAAqD;AAQrD,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,EAAE;IACR,UAAU,EAAE;QACX,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK;KAC1C;CACD,CAAC,EACF,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAC9B,CAAC;AAEK,MAAM,kBAAkB,GAAqD,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,EAAE;;IACnH,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAC5B,MAAM,EAAE,OAAO,EAAE,GAAG,IAAA,wBAAY,EAAC,GAAG,CAAC,CAAC;IACtC,OAAO,CACN;QACC,8BAAC,2BAAiB,IAAC,SAAS,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,GAAI;QACpD,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,QAAQ,KAAI,8BAAC,eAAK,iBAAe;QACnD,OAAO,IAAI,CACX,8BAAC,eAAK,IACL,SAAS,EAAE,OAAO,CAAC,UAAU,EAC7B,KAAK,EAAC,uJAAuJ,EAC7J,IAAI,EAAC,6EAA6E,YAG3E,CACR;QACA,IAAA,kBAAM,EAAC,GAAG,EAAE,YAAY,CAAC,IAAI,CAC7B,8BAAC,2BAAiB;YACjB,8BAAC,wBAAc,IAAC,MAAM,EAAE,IAAA,kBAAM,EAAC,GAAG,EAAE,YAAY,CAAE,GAAI,CACnC,CACpB;QACA,IAAA,kBAAM,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,8BAAC,oBAAU,OAAG,CACpC,CACH,CAAC;AACH,CAAC,CAAC;AAxBW,QAAA,kBAAkB,sBAwB7B"}
|
|
@@ -8,6 +8,7 @@ const CodeTools_1 = require("../../tools/CodeTools");
|
|
|
8
8
|
const MarkdownParser_1 = tslib_1.__importDefault(require("../../tools/markdown/MarkdownParser"));
|
|
9
9
|
const NodeTools_1 = require("../../tools/NodeTools");
|
|
10
10
|
const Badge_1 = tslib_1.__importDefault(require("../Badge"));
|
|
11
|
+
const BetaNotice_1 = tslib_1.__importDefault(require("../BetaNotice"));
|
|
11
12
|
const Type_1 = tslib_1.__importDefault(require("../codeBuilders/Type"));
|
|
12
13
|
const DeprecationNotice_1 = tslib_1.__importDefault(require("../DeprecationNotice"));
|
|
13
14
|
const CardToolbar_1 = tslib_1.__importDefault(require("./CardToolbar"));
|
|
@@ -42,6 +43,7 @@ const PropertyCard = ({ name, definition }) => {
|
|
|
42
43
|
react_1.default.createElement(Type_1.default, { def: type, isOptional: (_b = definition.flags) === null || _b === void 0 ? void 0 : _b.isOptional })),
|
|
43
44
|
(0, CodeTools_1.hasTag)(sig, 'deprecated') && (react_1.default.createElement(DeprecationNotice_1.default, null,
|
|
44
45
|
react_1.default.createElement(MarkdownParser_1.default, { source: (0, CodeTools_1.getTag)(sig, 'deprecated') }))),
|
|
46
|
+
(0, CodeTools_1.hasTag)(sig, 'beta') && react_1.default.createElement(BetaNotice_1.default, null),
|
|
45
47
|
((_c = sig.comment) === null || _c === void 0 ? void 0 : _c.shortText) ? react_1.default.createElement(MarkdownParser_1.default, { source: sig.comment.shortText }) : null,
|
|
46
48
|
((_d = sig.comment) === null || _d === void 0 ? void 0 : _d.text) ? react_1.default.createElement(MarkdownParser_1.default, { source: sig.comment.text }) : null));
|
|
47
49
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PropertyCard.js","sourceRoot":"","sources":["../../../../src/common/components/cards/PropertyCard.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,yEAAyC;AAEzC,qDAAkE;AAClE,iGAAiE;AACjE,qDAAsD;AACtD,6DAA6B;AAC7B,wEAAwC;AACxC,qFAAqD;AACrD,wEAAwC;AAOxC,MAAM,SAAS,GAAG,IAAA,mBAAU,
|
|
1
|
+
{"version":3,"file":"PropertyCard.js","sourceRoot":"","sources":["../../../../src/common/components/cards/PropertyCard.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,yEAAyC;AAEzC,qDAAkE;AAClE,iGAAiE;AACjE,qDAAsD;AACtD,6DAA6B;AAC7B,uEAAuC;AACvC,wEAAwC;AACxC,qFAAqD;AACrD,wEAAwC;AAOxC,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B;IACC,IAAI,EAAE,EAAE;IACR,IAAI,EAAE;QACL,OAAO,EAAE,cAAc;KACvB;IACD,OAAO,EAAE;QACR,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,yBAAyB;QAErC,eAAe,EAAE;YAChB,OAAO,EAAE,CAAC;SACV;KACD;CACD,EACD,EAAE,IAAI,EAAE,cAAc,EAAE,CACxB,CAAC;AAEF,MAAM,YAAY,GAAgC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE;;IAC1E,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAE5B,MAAM,GAAG,GAAG,UAAU,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC;IAClF,IAAI,CAAC,GAAG,EAAE;QACT,OAAO,IAAI,CAAC;KACZ;IAED,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC;IACtB,OAAO,CACN,8BAAC,cAAI,IAAC,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,IAAA,yBAAa,EAAC,UAAU,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,UAAU,CAAC,EAAE;QACrF,8BAAC,qBAAW,IAAC,SAAS,EAAE,OAAO,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,UAAU,GAAI;QAC/E,sCAAI,SAAS,EAAE,OAAO,CAAC,IAAI,IAAG,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,UAAU,CAAC,IAAI,CAAM;QAC1D,CAAA,MAAA,UAAU,CAAC,KAAK,0CAAE,QAAQ,KAAI,8BAAC,eAAK,iBAAe;QAEnD;YACE,IAAA,qBAAS,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM;;YAAG,8BAAC,cAAI,IAAC,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,MAAA,UAAU,CAAC,KAAK,0CAAE,UAAU,GAAI,CAC/F;QAEL,IAAA,kBAAM,EAAC,GAAG,EAAE,YAAY,CAAC,IAAI,CAC7B,8BAAC,2BAAiB;YACjB,8BAAC,wBAAc,IAAC,MAAM,EAAE,IAAA,kBAAM,EAAC,GAAG,EAAE,YAAY,CAAE,GAAI,CACnC,CACpB;QACA,IAAA,kBAAM,EAAC,GAAG,EAAE,MAAM,CAAC,IAAI,8BAAC,oBAAU,OAAG;QACrC,CAAA,MAAA,GAAG,CAAC,OAAO,0CAAE,SAAS,EAAC,CAAC,CAAC,8BAAC,wBAAc,IAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,SAAS,GAAI,CAAC,CAAC,CAAC,IAAI;QACjF,CAAA,MAAA,GAAG,CAAC,OAAO,0CAAE,IAAI,EAAC,CAAC,CAAC,8BAAC,wBAAc,IAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,IAAI,GAAI,CAAC,CAAC,CAAC,IAAI,CAClE,CACP,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,YAAY,CAAC"}
|
|
@@ -22,16 +22,24 @@ const useStyles = (0, styles_1.makeStyles)(theme => ({
|
|
|
22
22
|
},
|
|
23
23
|
deprecatedBadge: {
|
|
24
24
|
backgroundColor: theme.colors.badges.deprecated
|
|
25
|
+
},
|
|
26
|
+
betaBadge: {
|
|
27
|
+
backgroundColor: theme.colors.badges.beta
|
|
25
28
|
}
|
|
26
29
|
}), { name: 'OverviewTableEntry' });
|
|
27
30
|
const OverviewTableEntry = ({ node }) => {
|
|
28
|
-
var _a, _b, _c;
|
|
31
|
+
var _a, _b, _c, _d;
|
|
29
32
|
const classes = useStyles();
|
|
30
33
|
return (react_1.default.createElement("li", { className: classes.root },
|
|
31
34
|
react_1.default.createElement(react_router_hash_link_1.HashLink, { className: classes.link, to: `#${(0, NodeTools_1.getAnchorName)(node)}` }, node.name),
|
|
32
|
-
(0, CodeTools_1.hasTag)(node, 'deprecated') ||
|
|
33
|
-
|
|
34
|
-
|
|
35
|
+
(0, CodeTools_1.hasTag)(node, 'deprecated') ||
|
|
36
|
+
(node.kind === 'method' && ((_a = node.signatures) === null || _a === void 0 ? void 0 : _a.some(sig => (0, CodeTools_1.hasTag)(sig, 'deprecated')))) ||
|
|
37
|
+
(node.kind === 'accessor' && node.getSignature && (0, CodeTools_1.hasTag)(node.getSignature, 'deprecated')) ? (react_1.default.createElement(Badge_1.default, { small: true, className: classes.deprecatedBadge, title: "deprecated" }, "d")) : null,
|
|
38
|
+
(0, CodeTools_1.hasTag)(node, 'beta') ||
|
|
39
|
+
(node.kind === 'method' && ((_b = node.signatures) === null || _b === void 0 ? void 0 : _b.some(sig => (0, CodeTools_1.hasTag)(sig, 'beta')))) ||
|
|
40
|
+
(node.kind === 'accessor' && node.getSignature && (0, CodeTools_1.hasTag)(node.getSignature, 'beta')) ? (react_1.default.createElement(Badge_1.default, { small: true, className: classes.betaBadge }, "Beta")) : null,
|
|
41
|
+
((_c = node.flags) === null || _c === void 0 ? void 0 : _c.isStatic) ? (react_1.default.createElement(Badge_1.default, { small: true, title: "static" }, "s")) : null,
|
|
42
|
+
node.kind === 'method' && ((_d = node.signatures) === null || _d === void 0 ? void 0 : _d.some(sig => (0, NodeTools_1.typeIsAsync)(sig.type))) ? (react_1.default.createElement(Badge_1.default, { small: true, className: classes.asyncBadge, title: "async" }, "a")) : null));
|
|
35
43
|
};
|
|
36
44
|
exports.default = OverviewTableEntry;
|
|
37
45
|
//# sourceMappingURL=OverviewTableEntry.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OverviewTableEntry.js","sourceRoot":"","sources":["../../../../src/common/components/overviewTable/OverviewTableEntry.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,mEAAkD;AAElD,qDAA+C;AAC/C,qDAAmE;AACnE,6DAA6B;AAE7B,MAAM,SAAS,GAAG,IAAA,mBAAU,
|
|
1
|
+
{"version":3,"file":"OverviewTableEntry.js","sourceRoot":"","sources":["../../../../src/common/components/overviewTable/OverviewTableEntry.tsx"],"names":[],"mappings":";;;AAAA,gDAAiD;AACjD,0DAA0B;AAC1B,mEAAkD;AAElD,qDAA+C;AAC/C,qDAAmE;AACnE,6DAA6B;AAE7B,MAAM,SAAS,GAAG,IAAA,mBAAU,EAC3B,KAAK,CAAC,EAAE,CAAC,CAAC;IACT,IAAI,EAAE;QACL,aAAa,EAAE,MAAM;QACrB,UAAU,EAAE,OAAO;KACnB;IACD,IAAI,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI;QACxB,cAAc,EAAE,MAAM;QACtB,QAAQ,EAAE,EAAE;KACZ;IACD,UAAU,EAAE;QACX,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK;KAC1C;IACD,eAAe,EAAE;QAChB,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU;KAC/C;IACD,SAAS,EAAE;QACV,eAAe,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI;KACzC;CACD,CAAC,EACF,EAAE,IAAI,EAAE,oBAAoB,EAAE,CAC9B,CAAC;AAMF,MAAM,kBAAkB,GAAsC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;;IAC1E,MAAM,OAAO,GAAG,SAAS,EAAE,CAAC;IAE5B,OAAO,CACN,sCAAI,SAAS,EAAE,OAAO,CAAC,IAAI;QAC1B,8BAAC,iCAAQ,IAAC,SAAS,EAAE,OAAO,CAAC,IAAI,EAAE,EAAE,EAAE,IAAI,IAAA,yBAAa,EAAC,IAAI,CAAC,EAAE,IAC9D,IAAI,CAAC,IAAI,CACA;QACV,IAAA,kBAAM,EAAC,IAAI,EAAE,YAAY,CAAC;YAC3B,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAA,kBAAM,EAAC,GAAG,EAAE,YAAY,CAAC,CAAC,CAAA,CAAC;YACnF,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,YAAY,IAAI,IAAA,kBAAM,EAAC,IAAI,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5F,8BAAC,eAAK,IAAC,KAAK,QAAC,SAAS,EAAE,OAAO,CAAC,eAAe,EAAE,KAAK,EAAC,YAAY,QAE3D,CACR,CAAC,CAAC,CAAC,IAAI;QACP,IAAA,kBAAM,EAAC,IAAI,EAAE,MAAM,CAAC;YACrB,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAA,kBAAM,EAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAA,CAAC;YAC7E,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,IAAI,IAAI,CAAC,YAAY,IAAI,IAAA,kBAAM,EAAC,IAAI,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CACtF,8BAAC,eAAK,IAAC,KAAK,QAAC,SAAS,EAAE,OAAO,CAAC,SAAS,WAEjC,CACR,CAAC,CAAC,CAAC,IAAI;QACP,CAAA,MAAA,IAAI,CAAC,KAAK,0CAAE,QAAQ,EAAC,CAAC,CAAC,CACvB,8BAAC,eAAK,IAAC,KAAK,QAAC,KAAK,EAAC,QAAQ,QAEnB,CACR,CAAC,CAAC,CAAC,IAAI;QACP,IAAI,CAAC,IAAI,KAAK,QAAQ,KAAI,MAAA,IAAI,CAAC,UAAU,0CAAE,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,IAAA,uBAAW,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA,CAAC,CAAC,CAAC,CAChF,8BAAC,eAAK,IAAC,KAAK,QAAC,SAAS,EAAE,OAAO,CAAC,UAAU,EAAE,KAAK,EAAC,OAAO,QAEjD,CACR,CAAC,CAAC,CAAC,IAAI,CACJ,CACL,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"HtmlRenderer.js","sourceRoot":"","sources":["../../../src/common/htmlRenderer/HtmlRenderer.tsx"],"names":[],"mappings":";;;AAAA,wDAAwB;AACxB,0DAA0B;AAC1B,6CAAkD;AAClD,sCAA0C;AAE1C,8FAA8D;AAC9D,oEAAoC;AAEpC,oDAAuD;AAEvD,2DAA+D;AAC/D,gDAAuE;AACvE,6DAA6B;AAC7B,4EAAwD;AAExD,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,OAAe,EAAE,MAAc,EAAE,EAAE;;IACzF,OAAA;;;;;aAKY,MAAA,MAAM,CAAC,KAAK,mCAAI,eAAe
|
|
1
|
+
{"version":3,"file":"HtmlRenderer.js","sourceRoot":"","sources":["../../../src/common/htmlRenderer/HtmlRenderer.tsx"],"names":[],"mappings":";;;AAAA,wDAAwB;AACxB,0DAA0B;AAC1B,6CAAkD;AAClD,sCAA0C;AAE1C,8FAA8D;AAC9D,oEAAoC;AAEpC,oDAAuD;AAEvD,2DAA+D;AAC/D,gDAAuE;AACvE,6DAA6B;AAC7B,4EAAwD;AAExD,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,GAAW,EAAE,OAAe,EAAE,MAAc,EAAE,EAAE;;IACzF,OAAA;;;;;aAKY,MAAA,MAAM,CAAC,KAAK,mCAAI,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA6BxC,0BAAG,CAAC,GAAG,EAAE;;;MAGP,GAAG,CAAC,CAAC,CAAC,kCAAkC,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE;;;qBAG3C,IAAI;EACvB,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,gBAAgB,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE;;QAEpF,CAAA;CAAA,CAAC;AAET,MAAM,MAAM,GAAG,CAAC,GAAW,EAAE,MAAc,EAAE,OAAwB,EAAE,EAAE;IACxE,gEAAgE;IAChE,IAAI,IAAwB,CAAC;IAC7B,MAAM,OAAO,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAChF,uEAAuE;IACvE,MAAM,UAAU,GAAe,MAAM,CAAC,UAAU,IAAI,QAAQ,CAAC;IAC7D,MAAM,MAAM,GAAG,IAAI,0BAAiB,EAAE,CAAC;IACvC,MAAM,SAAS,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IAEhD,QAAQ,UAAU,EAAE;QACnB,KAAK,YAAY,CAAC,CAAC;YAClB,IAAI,GAAG,CACN,8BAAC,sBAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,MAAM;gBACpC,8BAAC,gCAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO;oBAC1C,8BAAC,sBAAa,IAAC,KAAK,EAAE,eAAK;wBAC1B,8BAAC,gCAAsB,IAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAC,OAAO;4BAC7E,8BAAC,aAAG,OAAG,CACiB,CACV,CACa,CACN,CACzB,CAAC;YACF,MAAM;SACN;QACD,KAAK,UAAU,CAAC;QAChB,KAAK,gBAAgB,CAAC;QACtB,KAAK,QAAQ,CAAC,CAAC;YACd,IAAI,GAAG,CACN,8BAAC,sBAAa,CAAC,QAAQ,IAAC,KAAK,EAAE,MAAM;gBACpC,8BAAC,gCAAkB,CAAC,QAAQ,IAAC,KAAK,EAAE,OAAO;oBAC1C,8BAAC,sBAAa,IAAC,KAAK,EAAE,eAAK;wBAC1B,8BAAC,qBAAY,IAAC,QAAQ,EAAE,SAAS;4BAChC,8BAAC,aAAG,OAAG,CACO,CACA,CACa,CACN,CACzB,CAAC;YACF,MAAM;SACN;QACD;YACC,IAAI,GAAG,6DAAK,CAAC;KACd;IACD,OAAO,kBAAkB,CAAC,IAAA,uBAAc,EAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,QAAQ,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;AACrG,CAAC,CAAC;AAEF,kBAAe,MAAM,CAAC"}
|
package/lib/common/theme.js
CHANGED
package/lib/common/theme.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"theme.js","sourceRoot":"","sources":["../../src/common/theme.ts"],"names":[],"mappings":";;AAAA,MAAM,KAAK,GAAG;IACb,MAAM,EAAE;QACP,UAAU,EAAE;YACX,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;SACjB;QACD,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE;YACP,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;SAChB;QACD,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,SAAS;
|
|
1
|
+
{"version":3,"file":"theme.js","sourceRoot":"","sources":["../../src/common/theme.ts"],"names":[],"mappings":";;AAAA,MAAM,KAAK,GAAG;IACb,MAAM,EAAE;QACP,UAAU,EAAE;YACX,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,SAAS;SACjB;QACD,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,SAAS;QAClB,MAAM,EAAE,MAAM;QACd,MAAM,EAAE;YACP,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS;SAChB;QACD,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,UAAU,EAAE,SAAS;YACrB,IAAI,EAAE,SAAS;SACf;KACD;IACD,KAAK,EAAE;QACN,OAAO,EAAE,6DAA6D;QACtE,IAAI,EAAE,4CAA4C;KAClD;IACD,OAAO,EAAE;QACR,IAAI,EAAE,CAAC;KACP;CACD,CAAC;AAEF,kBAAe,KAAK,CAAC"}
|
package/package.json
CHANGED
package/public/index.html
CHANGED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { makeStyles } from '@material-ui/styles';
|
|
3
|
+
|
|
4
|
+
const useStyles = makeStyles(
|
|
5
|
+
theme => ({
|
|
6
|
+
root: {
|
|
7
|
+
display: 'flow-root',
|
|
8
|
+
borderLeft: `${theme.spacing.unit / 2}px solid ${theme.colors.badges.beta}`,
|
|
9
|
+
backgroundColor: theme.colors.background.active,
|
|
10
|
+
padding: theme.spacing.unit * 2,
|
|
11
|
+
paddingBottom: theme.spacing.unit,
|
|
12
|
+
margin: '1em 0'
|
|
13
|
+
}
|
|
14
|
+
}),
|
|
15
|
+
{ name: 'BetaNotice' }
|
|
16
|
+
);
|
|
17
|
+
|
|
18
|
+
const BetaNotice: React.FC = () => {
|
|
19
|
+
const classes = useStyles();
|
|
20
|
+
return (
|
|
21
|
+
<div className={classes.root}>
|
|
22
|
+
<h3>Beta</h3>
|
|
23
|
+
<p>This is an interface that may change without notice until it loses this beta annotation.</p>
|
|
24
|
+
</div>
|
|
25
|
+
);
|
|
26
|
+
};
|
|
27
|
+
|
|
28
|
+
export default BetaNotice;
|
|
@@ -1,17 +1,21 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
import { makeStyles } from '@material-ui/styles';
|
|
3
3
|
|
|
4
|
-
const useStyles = makeStyles(
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
4
|
+
const useStyles = makeStyles(
|
|
5
|
+
theme => ({
|
|
6
|
+
root: {
|
|
7
|
+
display: 'flow-root',
|
|
8
|
+
borderLeft: `${theme.spacing.unit / 2}px solid ${theme.colors.badges.deprecated}`,
|
|
9
|
+
backgroundColor: theme.colors.background.active,
|
|
10
|
+
padding: theme.spacing.unit * 2,
|
|
11
|
+
paddingBottom: theme.spacing.unit,
|
|
12
|
+
margin: `${theme.spacing.unit * 2}px 0`
|
|
13
|
+
}
|
|
14
|
+
}),
|
|
15
|
+
{ name: 'DeprecationNotice' }
|
|
16
|
+
);
|
|
13
17
|
|
|
14
|
-
const DeprecationNotice: React.FC<React.PropsWithChildren
|
|
18
|
+
const DeprecationNotice: React.FC<React.PropsWithChildren> = ({ children }) => {
|
|
15
19
|
const classes = useStyles();
|
|
16
20
|
return (
|
|
17
21
|
<div className={classes.root}>
|
|
@@ -1,6 +1,13 @@
|
|
|
1
1
|
import { makeStyles } from '@material-ui/styles';
|
|
2
2
|
import React from 'react';
|
|
3
|
-
import type {
|
|
3
|
+
import type {
|
|
4
|
+
CallSignatureReferenceNode,
|
|
5
|
+
ConstructorReferenceNode,
|
|
6
|
+
ConstructSignatureReferenceNode,
|
|
7
|
+
FunctionReferenceNode,
|
|
8
|
+
MethodReferenceNode,
|
|
9
|
+
PropertyReferenceNode
|
|
10
|
+
} from '../reference';
|
|
4
11
|
|
|
5
12
|
import { hasTag } from '../tools/CodeTools';
|
|
6
13
|
|
|
@@ -12,49 +19,54 @@ interface FunctionParamDescProps {
|
|
|
12
19
|
isCallback?: boolean;
|
|
13
20
|
}
|
|
14
21
|
|
|
15
|
-
const useStyles = makeStyles(
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
}
|
|
22
|
+
const useStyles = makeStyles(
|
|
23
|
+
theme => ({
|
|
24
|
+
root: {
|
|
25
|
+
border: `1px solid ${theme.colors.border}`,
|
|
26
|
+
margin: `${theme.spacing.unit * 2}px 0`
|
|
27
|
+
},
|
|
28
|
+
heading: {
|
|
29
|
+
padding: theme.spacing.unit,
|
|
30
|
+
backgroundColor: theme.colors.background.active
|
|
31
|
+
}
|
|
32
|
+
}),
|
|
33
|
+
{ name: 'FunctionParamDesc' }
|
|
34
|
+
);
|
|
25
35
|
|
|
26
36
|
const FunctionParamDesc: React.FC<FunctionParamDescProps> = ({ functionDefinition, signature, isCallback }) => {
|
|
27
37
|
const classes = useStyles();
|
|
28
38
|
if (!signature.parameters.length) {
|
|
29
39
|
return null;
|
|
30
40
|
}
|
|
31
|
-
return
|
|
32
|
-
<
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
41
|
+
return (
|
|
42
|
+
<table className={classes.root}>
|
|
43
|
+
<thead>
|
|
44
|
+
<tr>
|
|
45
|
+
<th className={classes.heading}>Parameter</th>
|
|
46
|
+
<th className={classes.heading}>Type</th>
|
|
47
|
+
{isCallback ? null : (
|
|
48
|
+
<>
|
|
49
|
+
<th className={classes.heading}>Required</th>
|
|
50
|
+
<th className={classes.heading}>Default</th>
|
|
51
|
+
</>
|
|
52
|
+
)}
|
|
53
|
+
<th className={classes.heading}>Description</th>
|
|
54
|
+
</tr>
|
|
55
|
+
</thead>
|
|
56
|
+
<tbody>
|
|
57
|
+
{signature.parameters.map(param => (
|
|
58
|
+
<FunctionParamDescEntry
|
|
59
|
+
key={param.name}
|
|
60
|
+
param={param}
|
|
61
|
+
functionSignature={signature}
|
|
62
|
+
functionDefinition={functionDefinition}
|
|
63
|
+
isCallback={isCallback}
|
|
64
|
+
expandParams={hasTag(signature, 'expandParams')}
|
|
65
|
+
/>
|
|
66
|
+
))}
|
|
67
|
+
</tbody>
|
|
68
|
+
</table>
|
|
69
|
+
);
|
|
58
70
|
};
|
|
59
71
|
|
|
60
72
|
export default FunctionParamDesc;
|
|
@@ -9,15 +9,15 @@ interface FunctionReturnTypeProps {
|
|
|
9
9
|
}
|
|
10
10
|
|
|
11
11
|
const useStyles = makeStyles(
|
|
12
|
-
{
|
|
12
|
+
theme => ({
|
|
13
13
|
root: {
|
|
14
14
|
fontWeight: 'bold',
|
|
15
|
-
margin:
|
|
15
|
+
margin: `${theme.spacing.unit * 2}px 0 0`
|
|
16
16
|
},
|
|
17
17
|
type: {
|
|
18
18
|
fontWeight: 'normal'
|
|
19
19
|
}
|
|
20
|
-
},
|
|
20
|
+
}),
|
|
21
21
|
{ name: 'FunctionReturnType' }
|
|
22
22
|
);
|
|
23
23
|
|
|
@@ -5,7 +5,8 @@ import type { ParameterReferenceNode, PropertyReferenceNode, CallSignatureRefere
|
|
|
5
5
|
import { getTag, hasTag } from '../../tools/CodeTools';
|
|
6
6
|
import MarkdownParser from '../../tools/markdown/MarkdownParser';
|
|
7
7
|
import { getAnchorName } from '../../tools/NodeTools';
|
|
8
|
-
import { findSymbolByMember} from '../../tools/ReferenceTools';
|
|
8
|
+
import { findSymbolByMember } from '../../tools/ReferenceTools';
|
|
9
|
+
import BetaNotice from '../BetaNotice';
|
|
9
10
|
import DeprecationNotice from '../DeprecationNotice';
|
|
10
11
|
|
|
11
12
|
import FunctionParamDesc from '../FunctionParamDesc';
|
|
@@ -17,13 +18,22 @@ interface EventCardProps {
|
|
|
17
18
|
}
|
|
18
19
|
|
|
19
20
|
function getParamDefinition(param: ParameterReferenceNode) {
|
|
20
|
-
if (
|
|
21
|
+
if (
|
|
22
|
+
param.type.type === 'reflection' &&
|
|
23
|
+
param.type.declaration.signatures &&
|
|
24
|
+
param.type.declaration.signatures.length
|
|
25
|
+
) {
|
|
21
26
|
return param.type.declaration.signatures[0];
|
|
22
27
|
} else if (param.type.type === 'reference' && param.type.id) {
|
|
23
28
|
const ref = findSymbolByMember('id', param.type.id);
|
|
24
29
|
if (ref) {
|
|
25
30
|
const { symbol } = ref;
|
|
26
|
-
if (
|
|
31
|
+
if (
|
|
32
|
+
symbol.kind === 'typeAlias' &&
|
|
33
|
+
symbol.type.type === 'reflection' &&
|
|
34
|
+
symbol.type.declaration.signatures &&
|
|
35
|
+
symbol.type.declaration.signatures.length
|
|
36
|
+
) {
|
|
27
37
|
return symbol.type.declaration.signatures[0];
|
|
28
38
|
}
|
|
29
39
|
}
|
|
@@ -32,26 +42,33 @@ function getParamDefinition(param: ParameterReferenceNode) {
|
|
|
32
42
|
return undefined;
|
|
33
43
|
}
|
|
34
44
|
|
|
35
|
-
const useStyles = makeStyles(
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
45
|
+
const useStyles = makeStyles(
|
|
46
|
+
theme => ({
|
|
47
|
+
root: {},
|
|
48
|
+
toolbar: {
|
|
49
|
+
opacity: 0,
|
|
50
|
+
transition: 'opacity .5s ease-in-out',
|
|
40
51
|
|
|
41
|
-
|
|
42
|
-
|
|
52
|
+
'$root:hover &': {
|
|
53
|
+
opacity: 1
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
example: {
|
|
57
|
+
fontFamily: theme.fonts.code
|
|
43
58
|
}
|
|
44
|
-
},
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
}
|
|
48
|
-
}), { name: 'EventCard' });
|
|
59
|
+
}),
|
|
60
|
+
{ name: 'EventCard' }
|
|
61
|
+
);
|
|
49
62
|
|
|
50
63
|
const EventCard: React.FC<EventCardProps> = ({ name, definition }) => {
|
|
51
64
|
const classes = useStyles();
|
|
52
65
|
let handlerDefinition: CallSignatureReferenceNode | undefined = undefined;
|
|
53
66
|
let handlerParamDefinition: CallSignatureReferenceNode | undefined = undefined;
|
|
54
|
-
if (
|
|
67
|
+
if (
|
|
68
|
+
definition.type.type === 'reflection' &&
|
|
69
|
+
definition.type.declaration.signatures &&
|
|
70
|
+
definition.type.declaration.signatures.length
|
|
71
|
+
) {
|
|
55
72
|
handlerDefinition = definition.type.declaration.signatures[0];
|
|
56
73
|
if (handlerDefinition.parameters.length) {
|
|
57
74
|
handlerParamDefinition = getParamDefinition(handlerDefinition.parameters[0]);
|
|
@@ -80,29 +97,34 @@ const EventCard: React.FC<EventCardProps> = ({ name, definition }) => {
|
|
|
80
97
|
}
|
|
81
98
|
return (
|
|
82
99
|
<Card className={classes.root} id={getAnchorName(definition, name)} key={definition.id}>
|
|
83
|
-
<CardToolbar className={classes.toolbar} name={name} definition={definition}/>
|
|
100
|
+
<CardToolbar className={classes.toolbar} name={name} definition={definition} />
|
|
84
101
|
<h3 className={classes.example}>
|
|
85
102
|
{name ?? definition.name}(
|
|
86
103
|
{handlerParamDefinition ? (
|
|
87
104
|
<>
|
|
88
|
-
(
|
|
89
|
-
|
|
90
|
-
{
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
105
|
+
(
|
|
106
|
+
{handlerParamDefinition.parameters.map((handlerParam, handlerParamIndex) => (
|
|
107
|
+
<React.Fragment key={handlerParam.name}>
|
|
108
|
+
{handlerParamIndex === 0 ? '' : ', '}
|
|
109
|
+
{handlerParam.name}
|
|
110
|
+
</React.Fragment>
|
|
111
|
+
))}
|
|
112
|
+
) => {'{\n\t/* ... */\n}'}
|
|
94
113
|
</>
|
|
95
114
|
) : null}
|
|
96
115
|
)
|
|
97
116
|
</h3>
|
|
98
117
|
{hasTag(definition, 'deprecated') && (
|
|
99
118
|
<DeprecationNotice>
|
|
100
|
-
<MarkdownParser source={getTag(definition, 'deprecated')!}/>
|
|
119
|
+
<MarkdownParser source={getTag(definition, 'deprecated')!} />
|
|
101
120
|
</DeprecationNotice>
|
|
102
121
|
)}
|
|
103
|
-
{definition
|
|
104
|
-
{definition.comment?.
|
|
105
|
-
{
|
|
122
|
+
{hasTag(definition, 'beta') && <BetaNotice />}
|
|
123
|
+
{definition.comment?.shortText ? <MarkdownParser source={definition.comment.shortText} /> : null}
|
|
124
|
+
{definition.comment?.text ? <MarkdownParser source={definition.comment.text} /> : null}
|
|
125
|
+
{handlerParamDefinition ? (
|
|
126
|
+
<FunctionParamDesc functionDefinition={definition} signature={handlerParamDefinition} isCallback />
|
|
127
|
+
) : null}
|
|
106
128
|
</Card>
|
|
107
129
|
);
|
|
108
130
|
};
|
|
@@ -13,6 +13,7 @@ import { getTag, hasTag } from '../../tools/CodeTools';
|
|
|
13
13
|
import MarkdownParser from '../../tools/markdown/MarkdownParser';
|
|
14
14
|
import { useAsyncType } from '../../tools/NodeTools';
|
|
15
15
|
import Badge from '../Badge';
|
|
16
|
+
import BetaNotice from '../BetaNotice';
|
|
16
17
|
import DeprecationNotice from '../DeprecationNotice';
|
|
17
18
|
import FunctionSignature from '../FunctionSignature';
|
|
18
19
|
|
|
@@ -22,19 +23,22 @@ interface FunctionCardHeaderProps {
|
|
|
22
23
|
sig: CallSignatureReferenceNode | ConstructSignatureReferenceNode;
|
|
23
24
|
}
|
|
24
25
|
|
|
25
|
-
const useStyles = makeStyles(
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
}
|
|
26
|
+
const useStyles = makeStyles(
|
|
27
|
+
theme => ({
|
|
28
|
+
root: {},
|
|
29
|
+
asyncBadge: {
|
|
30
|
+
backgroundColor: theme.colors.badges.async
|
|
31
|
+
}
|
|
32
|
+
}),
|
|
33
|
+
{ name: 'FunctionCardHeader' }
|
|
34
|
+
);
|
|
31
35
|
|
|
32
36
|
export const FunctionCardHeader: React.FunctionComponent<FunctionCardHeaderProps> = ({ sig, definition, parent }) => {
|
|
33
37
|
const classes = useStyles();
|
|
34
38
|
const { isAsync } = useAsyncType(sig);
|
|
35
39
|
return (
|
|
36
40
|
<>
|
|
37
|
-
<FunctionSignature signature={sig} parent={parent}/>
|
|
41
|
+
<FunctionSignature signature={sig} parent={parent} />
|
|
38
42
|
{definition.flags?.isStatic && <Badge>static</Badge>}
|
|
39
43
|
{isAsync && (
|
|
40
44
|
<Badge
|
|
@@ -47,9 +51,10 @@ export const FunctionCardHeader: React.FunctionComponent<FunctionCardHeaderProps
|
|
|
47
51
|
)}
|
|
48
52
|
{hasTag(sig, 'deprecated') && (
|
|
49
53
|
<DeprecationNotice>
|
|
50
|
-
<MarkdownParser source={getTag(sig, 'deprecated')!}/>
|
|
54
|
+
<MarkdownParser source={getTag(sig, 'deprecated')!} />
|
|
51
55
|
</DeprecationNotice>
|
|
52
56
|
)}
|
|
57
|
+
{hasTag(sig, 'beta') && <BetaNotice />}
|
|
53
58
|
</>
|
|
54
59
|
);
|
|
55
60
|
};
|
|
@@ -6,6 +6,7 @@ import { getTag, hasTag, isLiteral } from '../../tools/CodeTools';
|
|
|
6
6
|
import MarkdownParser from '../../tools/markdown/MarkdownParser';
|
|
7
7
|
import { getAnchorName } from '../../tools/NodeTools';
|
|
8
8
|
import Badge from '../Badge';
|
|
9
|
+
import BetaNotice from '../BetaNotice';
|
|
9
10
|
import Type from '../codeBuilders/Type';
|
|
10
11
|
import DeprecationNotice from '../DeprecationNotice';
|
|
11
12
|
import CardToolbar from './CardToolbar';
|
|
@@ -15,20 +16,23 @@ interface PropertyCardProps {
|
|
|
15
16
|
definition: PropertyReferenceNode | AccessorReferenceNode;
|
|
16
17
|
}
|
|
17
18
|
|
|
18
|
-
const useStyles = makeStyles(
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
19
|
+
const useStyles = makeStyles(
|
|
20
|
+
{
|
|
21
|
+
root: {},
|
|
22
|
+
name: {
|
|
23
|
+
display: 'inline-block'
|
|
24
|
+
},
|
|
25
|
+
toolbar: {
|
|
26
|
+
opacity: 0,
|
|
27
|
+
transition: 'opacity .5s ease-in-out',
|
|
26
28
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
+
'$root:hover &': {
|
|
30
|
+
opacity: 1
|
|
31
|
+
}
|
|
29
32
|
}
|
|
30
|
-
}
|
|
31
|
-
|
|
33
|
+
},
|
|
34
|
+
{ name: 'PropertyCard' }
|
|
35
|
+
);
|
|
32
36
|
|
|
33
37
|
const PropertyCard: React.FC<PropertyCardProps> = ({ name, definition }) => {
|
|
34
38
|
const classes = useStyles();
|
|
@@ -41,17 +45,22 @@ const PropertyCard: React.FC<PropertyCardProps> = ({ name, definition }) => {
|
|
|
41
45
|
const type = sig.type;
|
|
42
46
|
return (
|
|
43
47
|
<Card className={classes.root} id={getAnchorName(definition, name)} key={definition.id}>
|
|
44
|
-
<CardToolbar className={classes.toolbar} name={name} definition={definition}/>
|
|
48
|
+
<CardToolbar className={classes.toolbar} name={name} definition={definition} />
|
|
45
49
|
<h3 className={classes.name}>{name ?? definition.name}</h3>
|
|
46
50
|
{definition.flags?.isStatic && <Badge>static</Badge>}
|
|
47
|
-
{
|
|
51
|
+
{
|
|
52
|
+
<h4>
|
|
53
|
+
{isLiteral(type) ? 'Value' : 'Type'}: <Type def={type} isOptional={definition.flags?.isOptional} />
|
|
54
|
+
</h4>
|
|
55
|
+
}
|
|
48
56
|
{hasTag(sig, 'deprecated') && (
|
|
49
57
|
<DeprecationNotice>
|
|
50
|
-
<MarkdownParser source={getTag(sig, 'deprecated')!}/>
|
|
58
|
+
<MarkdownParser source={getTag(sig, 'deprecated')!} />
|
|
51
59
|
</DeprecationNotice>
|
|
52
60
|
)}
|
|
53
|
-
{sig
|
|
54
|
-
{sig.comment?.
|
|
61
|
+
{hasTag(sig, 'beta') && <BetaNotice />}
|
|
62
|
+
{sig.comment?.shortText ? <MarkdownParser source={sig.comment.shortText} /> : null}
|
|
63
|
+
{sig.comment?.text ? <MarkdownParser source={sig.comment.text} /> : null}
|
|
55
64
|
</Card>
|
|
56
65
|
);
|
|
57
66
|
};
|
|
@@ -6,23 +6,29 @@ import { hasTag } from '../../tools/CodeTools';
|
|
|
6
6
|
import { getAnchorName, typeIsAsync } from '../../tools/NodeTools';
|
|
7
7
|
import Badge from '../Badge';
|
|
8
8
|
|
|
9
|
-
const useStyles = makeStyles(
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
}
|
|
9
|
+
const useStyles = makeStyles(
|
|
10
|
+
theme => ({
|
|
11
|
+
root: {
|
|
12
|
+
listStyleType: 'none',
|
|
13
|
+
lineHeight: '1.3em'
|
|
14
|
+
},
|
|
15
|
+
link: {
|
|
16
|
+
color: theme.colors.link,
|
|
17
|
+
textDecoration: 'none',
|
|
18
|
+
fontSize: 12
|
|
19
|
+
},
|
|
20
|
+
asyncBadge: {
|
|
21
|
+
backgroundColor: theme.colors.badges.async
|
|
22
|
+
},
|
|
23
|
+
deprecatedBadge: {
|
|
24
|
+
backgroundColor: theme.colors.badges.deprecated
|
|
25
|
+
},
|
|
26
|
+
betaBadge: {
|
|
27
|
+
backgroundColor: theme.colors.badges.beta
|
|
28
|
+
}
|
|
29
|
+
}),
|
|
30
|
+
{ name: 'OverviewTableEntry' }
|
|
31
|
+
);
|
|
26
32
|
|
|
27
33
|
interface OverviewTableEntryProps {
|
|
28
34
|
node: ReferenceNode;
|
|
@@ -33,13 +39,32 @@ const OverviewTableEntry: React.FC<OverviewTableEntryProps> = ({ node }) => {
|
|
|
33
39
|
|
|
34
40
|
return (
|
|
35
41
|
<li className={classes.root}>
|
|
36
|
-
<HashLink className={classes.link} to={`#${getAnchorName(node)}`}>
|
|
37
|
-
|
|
38
|
-
|
|
42
|
+
<HashLink className={classes.link} to={`#${getAnchorName(node)}`}>
|
|
43
|
+
{node.name}
|
|
44
|
+
</HashLink>
|
|
45
|
+
{hasTag(node, 'deprecated') ||
|
|
46
|
+
(node.kind === 'method' && node.signatures?.some(sig => hasTag(sig, 'deprecated'))) ||
|
|
47
|
+
(node.kind === 'accessor' && node.getSignature && hasTag(node.getSignature, 'deprecated')) ? (
|
|
48
|
+
<Badge small className={classes.deprecatedBadge} title="deprecated">
|
|
49
|
+
d
|
|
50
|
+
</Badge>
|
|
51
|
+
) : null}
|
|
52
|
+
{hasTag(node, 'beta') ||
|
|
53
|
+
(node.kind === 'method' && node.signatures?.some(sig => hasTag(sig, 'beta'))) ||
|
|
54
|
+
(node.kind === 'accessor' && node.getSignature && hasTag(node.getSignature, 'beta')) ? (
|
|
55
|
+
<Badge small className={classes.betaBadge}>
|
|
56
|
+
Beta
|
|
57
|
+
</Badge>
|
|
58
|
+
) : null}
|
|
59
|
+
{node.flags?.isStatic ? (
|
|
60
|
+
<Badge small title="static">
|
|
61
|
+
s
|
|
62
|
+
</Badge>
|
|
39
63
|
) : null}
|
|
40
|
-
{node.flags?.isStatic ? <Badge small title='static'>s</Badge> : null}
|
|
41
64
|
{node.kind === 'method' && node.signatures?.some(sig => typeIsAsync(sig.type)) ? (
|
|
42
|
-
<Badge small className={classes.asyncBadge} title="async">
|
|
65
|
+
<Badge small className={classes.asyncBadge} title="async">
|
|
66
|
+
a
|
|
67
|
+
</Badge>
|
|
43
68
|
) : null}
|
|
44
69
|
</li>
|
|
45
70
|
);
|
package/src/common/theme.ts
CHANGED
|
@@ -15,7 +15,8 @@ const theme = {
|
|
|
15
15
|
},
|
|
16
16
|
badges: {
|
|
17
17
|
async: '#cccc70',
|
|
18
|
-
deprecated: '#cc7070'
|
|
18
|
+
deprecated: '#cc7070',
|
|
19
|
+
beta: '#ab9120'
|
|
19
20
|
}
|
|
20
21
|
},
|
|
21
22
|
fonts: {
|
|
@@ -32,6 +33,5 @@ export type Theme = typeof theme;
|
|
|
32
33
|
|
|
33
34
|
declare module '@material-ui/styles' {
|
|
34
35
|
// eslint-disable-next-line @typescript-eslint/no-empty-interface
|
|
35
|
-
interface DefaultTheme extends Theme {
|
|
36
|
-
}
|
|
36
|
+
interface DefaultTheme extends Theme {}
|
|
37
37
|
}
|