@skyux/docs-tools 6.0.0-beta.6 → 6.0.0-beta.9
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/esm2020/modules/code-examples/code-examples-editor.service.mjs +3 -2
- package/esm2020/modules/type-definitions/interface-definition.component.mjs +3 -3
- package/esm2020/modules/type-definitions/method-definition.mjs +1 -1
- package/esm2020/modules/type-definitions/method-definitions.component.mjs +39 -22
- package/esm2020/modules/type-definitions/type-definitions-format.service.mjs +10 -3
- package/esm2020/modules/type-definitions/typedoc-adapter.service.mjs +7 -3
- package/fesm2015/skyux-docs-tools.mjs +58 -30
- package/fesm2015/skyux-docs-tools.mjs.map +1 -1
- package/fesm2020/skyux-docs-tools.mjs +56 -28
- package/fesm2020/skyux-docs-tools.mjs.map +1 -1
- package/modules/type-definitions/method-definition.d.ts +1 -0
- package/modules/type-definitions/method-definitions.component.d.ts +3 -4
- package/package.json +1 -1
|
@@ -244,6 +244,7 @@ class SkyDocsCodeExamplesEditorService {
|
|
|
244
244
|
'@skyux/popovers': skyuxVersion,
|
|
245
245
|
'@skyux/router': skyuxVersion,
|
|
246
246
|
'@skyux/theme': skyuxVersion,
|
|
247
|
+
'@types/jasmine': '~3.10.0',
|
|
247
248
|
// We must define Dragula deliberately so that StackBlitz runs NGCC against it.
|
|
248
249
|
'ng2-dragula': '2.1.1',
|
|
249
250
|
rxjs: '^7',
|
|
@@ -484,7 +485,7 @@ body {
|
|
|
484
485
|
}
|
|
485
486
|
getComponentSelector(componentClassName, sourceCode) {
|
|
486
487
|
const found = sourceCode.find((file) => {
|
|
487
|
-
return file.rawContents.indexOf(componentClassName) > -1;
|
|
488
|
+
return file.rawContents.indexOf(`class ${componentClassName}`) > -1;
|
|
488
489
|
});
|
|
489
490
|
const trimmed = found.rawContents.replace(/\s/g, '');
|
|
490
491
|
return trimmed.split(`selector:'`)[1].split(`'`)[0];
|
|
@@ -1328,8 +1329,11 @@ class SkyDocsTypeDefinitionsFormatService {
|
|
|
1328
1329
|
*/
|
|
1329
1330
|
getFormattedMethodName(definition) {
|
|
1330
1331
|
let formatted = '';
|
|
1332
|
+
if (definition.isStatic) {
|
|
1333
|
+
formatted += `${definition.parentName}.`;
|
|
1334
|
+
}
|
|
1331
1335
|
if (definition.deprecationWarning !== undefined) {
|
|
1332
|
-
formatted
|
|
1336
|
+
formatted = `<strike>${formatted}${definition.name}</strike>`;
|
|
1333
1337
|
}
|
|
1334
1338
|
else {
|
|
1335
1339
|
formatted += definition.name;
|
|
@@ -1347,7 +1351,11 @@ class SkyDocsTypeDefinitionsFormatService {
|
|
|
1347
1351
|
return formatted;
|
|
1348
1352
|
}
|
|
1349
1353
|
if (type.callSignature) {
|
|
1350
|
-
|
|
1354
|
+
let formattedSignature = this.getFormattedCallSignature(type.callSignature, config);
|
|
1355
|
+
if (type.type === 'array') {
|
|
1356
|
+
formattedSignature = `(${formattedSignature})[]`;
|
|
1357
|
+
}
|
|
1358
|
+
return formattedSignature;
|
|
1351
1359
|
}
|
|
1352
1360
|
if (type.unionTypes) {
|
|
1353
1361
|
return this.getFormattedUnion(type, config);
|
|
@@ -1715,55 +1723,71 @@ class SkyDocsInterfaceDefinitionComponent {
|
|
|
1715
1723
|
}
|
|
1716
1724
|
}
|
|
1717
1725
|
SkyDocsInterfaceDefinitionComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsInterfaceDefinitionComponent, deps: [{ token: SkyDocsTypeDefinitionsFormatService }], target: i0.ɵɵFactoryTarget.Component });
|
|
1718
|
-
SkyDocsInterfaceDefinitionComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsInterfaceDefinitionComponent, selector: "sky-docs-interface-definition", inputs: { config: "config" }, ngImport: i0, template: "<div\n *ngIf=\"config\"\n class=\"sky-docs-interface-definition sky-docs-type-definition-wrapper\"\n>\n <sky-docs-heading-anchor headingLevel=\"3\" [anchorId]=\"config.anchorId\">\n {{ config.name }}\n </sky-docs-heading-anchor>\n\n <sky-docs-safe-html\n *ngIf=\"config.description\"\n class=\"sky-docs-interface-definition-description\"\n [innerHtml]=\"config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-property-definitions\n *ngIf=\"config.properties\"\n [config]=\"{ properties: config.properties }\"\n [showOptionalStatus]=\"false\"\n ></sky-docs-property-definitions>\n</div>\n", components: [{ type: SkyDocsHeadingAnchorComponent, selector: "sky-docs-heading-anchor", inputs: ["anchorId", "headingLevel"] }, { type: SkyDocsSafeHtmlComponent, selector: "sky-docs-safe-html", inputs: ["innerHtml"] }, { type: i3$1.λ2, selector: "sky-code-block", inputs: ["code", "fileName", "languageType", "hideCopyToClipboard", "hideHeader"] }, { type: SkyDocsPropertyDefinitionsComponent, selector: "sky-docs-property-definitions", inputs: ["config", "propertyType", "showOptionalStatus"] }], directives: [{ type: i2.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }], pipes: { "skyDocsMarkdown": SkyDocsMarkdownPipe, "skyDocsTypeAnchorLinks": SkyDocsTypeAnchorLinksPipe }, changeDetection: i0.ChangeDetectionStrategy.OnPush });
|
|
1726
|
+
SkyDocsInterfaceDefinitionComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsInterfaceDefinitionComponent, selector: "sky-docs-interface-definition", inputs: { config: "config" }, ngImport: i0, template: "<div\n *ngIf=\"config\"\n class=\"sky-docs-interface-definition sky-docs-type-definition-wrapper\"\n>\n <sky-docs-heading-anchor headingLevel=\"3\" [anchorId]=\"config.anchorId\">\n {{ config.name }}\n </sky-docs-heading-anchor>\n\n <sky-docs-safe-html\n *ngIf=\"config.description\"\n class=\"sky-docs-interface-definition-description\"\n [innerHtml]=\"config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-property-definitions\n *ngIf=\"config.properties?.length\"\n [config]=\"{ properties: config.properties }\"\n [showOptionalStatus]=\"false\"\n ></sky-docs-property-definitions>\n</div>\n", components: [{ type: SkyDocsHeadingAnchorComponent, selector: "sky-docs-heading-anchor", inputs: ["anchorId", "headingLevel"] }, { type: SkyDocsSafeHtmlComponent, selector: "sky-docs-safe-html", inputs: ["innerHtml"] }, { type: i3$1.λ2, selector: "sky-code-block", inputs: ["code", "fileName", "languageType", "hideCopyToClipboard", "hideHeader"] }, { type: SkyDocsPropertyDefinitionsComponent, selector: "sky-docs-property-definitions", inputs: ["config", "propertyType", "showOptionalStatus"] }], directives: [{ type: i2.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }], pipes: { "skyDocsMarkdown": SkyDocsMarkdownPipe, "skyDocsTypeAnchorLinks": SkyDocsTypeAnchorLinksPipe }, changeDetection: i0.ChangeDetectionStrategy.OnPush });
|
|
1719
1727
|
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsInterfaceDefinitionComponent, decorators: [{
|
|
1720
1728
|
type: Component,
|
|
1721
|
-
args: [{ selector: 'sky-docs-interface-definition', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div\n *ngIf=\"config\"\n class=\"sky-docs-interface-definition sky-docs-type-definition-wrapper\"\n>\n <sky-docs-heading-anchor headingLevel=\"3\" [anchorId]=\"config.anchorId\">\n {{ config.name }}\n </sky-docs-heading-anchor>\n\n <sky-docs-safe-html\n *ngIf=\"config.description\"\n class=\"sky-docs-interface-definition-description\"\n [innerHtml]=\"config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-property-definitions\n *ngIf=\"config.properties\"\n [config]=\"{ properties: config.properties }\"\n [showOptionalStatus]=\"false\"\n ></sky-docs-property-definitions>\n</div>\n" }]
|
|
1729
|
+
args: [{ selector: 'sky-docs-interface-definition', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div\n *ngIf=\"config\"\n class=\"sky-docs-interface-definition sky-docs-type-definition-wrapper\"\n>\n <sky-docs-heading-anchor headingLevel=\"3\" [anchorId]=\"config.anchorId\">\n {{ config.name }}\n </sky-docs-heading-anchor>\n\n <sky-docs-safe-html\n *ngIf=\"config.description\"\n class=\"sky-docs-interface-definition-description\"\n [innerHtml]=\"config.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-property-definitions\n *ngIf=\"config.properties?.length\"\n [config]=\"{ properties: config.properties }\"\n [showOptionalStatus]=\"false\"\n ></sky-docs-property-definitions>\n</div>\n" }]
|
|
1722
1730
|
}], ctorParameters: function () { return [{ type: SkyDocsTypeDefinitionsFormatService }]; }, propDecorators: { config: [{
|
|
1723
1731
|
type: Input
|
|
1724
1732
|
}] } });
|
|
1725
1733
|
|
|
1734
|
+
var _SkyDocsMethodDefinitionsComponent__config, _SkyDocsMethodDefinitionsComponent_changeDetector, _SkyDocsMethodDefinitionsComponent_formatService, _SkyDocsMethodDefinitionsComponent_mediaQueryService;
|
|
1726
1735
|
class SkyDocsMethodDefinitionsComponent {
|
|
1727
1736
|
constructor(changeDetector, formatService, mediaQueryService) {
|
|
1728
|
-
this.changeDetector = changeDetector;
|
|
1729
|
-
this.formatService = formatService;
|
|
1730
|
-
this.mediaQueryService = mediaQueryService;
|
|
1731
1737
|
this.deprecationWarningPrefix = `<span class="sky-text-warning"></span>**Deprecated.** `;
|
|
1732
1738
|
this.isMobile = true;
|
|
1739
|
+
_SkyDocsMethodDefinitionsComponent__config.set(this, void 0);
|
|
1740
|
+
_SkyDocsMethodDefinitionsComponent_changeDetector.set(this, void 0);
|
|
1741
|
+
_SkyDocsMethodDefinitionsComponent_formatService.set(this, void 0);
|
|
1742
|
+
_SkyDocsMethodDefinitionsComponent_mediaQueryService.set(this, void 0);
|
|
1743
|
+
__classPrivateFieldSet(this, _SkyDocsMethodDefinitionsComponent_changeDetector, changeDetector, "f");
|
|
1744
|
+
__classPrivateFieldSet(this, _SkyDocsMethodDefinitionsComponent_formatService, formatService, "f");
|
|
1745
|
+
__classPrivateFieldSet(this, _SkyDocsMethodDefinitionsComponent_mediaQueryService, mediaQueryService, "f");
|
|
1733
1746
|
}
|
|
1734
1747
|
set config(value) {
|
|
1735
|
-
this
|
|
1748
|
+
__classPrivateFieldSet(this, _SkyDocsMethodDefinitionsComponent__config, value, "f");
|
|
1736
1749
|
this.updateView();
|
|
1737
1750
|
}
|
|
1738
1751
|
get config() {
|
|
1739
|
-
return this
|
|
1752
|
+
return __classPrivateFieldGet(this, _SkyDocsMethodDefinitionsComponent__config, "f") || {};
|
|
1740
1753
|
}
|
|
1741
1754
|
ngOnInit() {
|
|
1742
|
-
this.
|
|
1755
|
+
__classPrivateFieldGet(this, _SkyDocsMethodDefinitionsComponent_mediaQueryService, "f").subscribe((breakpoints) => {
|
|
1743
1756
|
this.isMobile = breakpoints <= SkyMediaBreakpoints.sm;
|
|
1744
|
-
this.
|
|
1757
|
+
__classPrivateFieldGet(this, _SkyDocsMethodDefinitionsComponent_changeDetector, "f").markForCheck();
|
|
1745
1758
|
});
|
|
1746
1759
|
}
|
|
1747
1760
|
updateView() {
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
|
|
1753
|
-
|
|
1754
|
-
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
|
|
1759
|
-
|
|
1761
|
+
if (this.config.methods?.length > 0) {
|
|
1762
|
+
this.methods = [];
|
|
1763
|
+
this.staticMethods = [];
|
|
1764
|
+
for (let method of this.config.methods) {
|
|
1765
|
+
const vm = {
|
|
1766
|
+
callSignature: method.type.callSignature,
|
|
1767
|
+
codeExample: method.codeExample,
|
|
1768
|
+
codeExampleLanguage: method.codeExampleLanguage,
|
|
1769
|
+
deprecationWarning: method.deprecationWarning,
|
|
1770
|
+
description: method.description,
|
|
1771
|
+
formattedName: __classPrivateFieldGet(this, _SkyDocsMethodDefinitionsComponent_formatService, "f").getFormattedMethodName(method),
|
|
1772
|
+
sourceCode: __classPrivateFieldGet(this, _SkyDocsMethodDefinitionsComponent_formatService, "f").getMethodSourceCode(method),
|
|
1773
|
+
isStatic: method.isStatic,
|
|
1774
|
+
};
|
|
1775
|
+
if (vm.isStatic) {
|
|
1776
|
+
this.staticMethods.push(vm);
|
|
1777
|
+
}
|
|
1778
|
+
else {
|
|
1779
|
+
this.methods.push(vm);
|
|
1780
|
+
}
|
|
1781
|
+
}
|
|
1782
|
+
}
|
|
1760
1783
|
}
|
|
1761
1784
|
}
|
|
1785
|
+
_SkyDocsMethodDefinitionsComponent__config = new WeakMap(), _SkyDocsMethodDefinitionsComponent_changeDetector = new WeakMap(), _SkyDocsMethodDefinitionsComponent_formatService = new WeakMap(), _SkyDocsMethodDefinitionsComponent_mediaQueryService = new WeakMap();
|
|
1762
1786
|
SkyDocsMethodDefinitionsComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsMethodDefinitionsComponent, deps: [{ token: i0.ChangeDetectorRef }, { token: SkyDocsTypeDefinitionsFormatService }, { token: i2$4.SkyMediaQueryService }], target: i0.ɵɵFactoryTarget.Component });
|
|
1763
|
-
SkyDocsMethodDefinitionsComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsMethodDefinitionsComponent, selector: "sky-docs-method-definitions", inputs: { config: "config" }, ngImport: i0, template: "<div
|
|
1787
|
+
SkyDocsMethodDefinitionsComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsMethodDefinitionsComponent, selector: "sky-docs-method-definitions", inputs: { config: "config" }, ngImport: i0, template: "<div\n *ngIf=\"methods?.length > 0 || staticMethods?.length > 0\"\n class=\"sky-docs-method-definitions\"\n>\n <ng-container *ngIf=\"!isMobile; else mobileTemplate\">\n <table\n class=\"sky-docs-table sky-docs-static-method-definitions\"\n *ngIf=\"staticMethods?.length > 0\"\n >\n <tr class=\"sky-docs-table-row\">\n <th\n class=\"sky-docs-table-column-header sky-docs-table-column-header-name\"\n >\n Static methods\n </th>\n <th\n class=\"\n sky-docs-table-column-header\n sky-docs-table-column-header-description\n \"\n >\n Description\n </th>\n </tr>\n <tr *ngFor=\"let method of staticMethods\" class=\"sky-docs-table-row\">\n <td\n class=\"\n sky-docs-table-cell sky-docs-method-definitions-table-cell-name\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n <td\n class=\"\n sky-docs-table-cell\n sky-docs-method-definitions-table-cell-description\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n </tr>\n </table>\n <table\n class=\"sky-docs-table sky-docs-standard-method-definitions\"\n *ngIf=\"methods?.length > 0\"\n >\n <tr class=\"sky-docs-table-row\">\n <th\n class=\"sky-docs-table-column-header sky-docs-table-column-header-name\"\n >\n Methods\n </th>\n <th\n class=\"\n sky-docs-table-column-header\n sky-docs-table-column-header-description\n \"\n >\n Description\n </th>\n </tr>\n <tr *ngFor=\"let method of methods\" class=\"sky-docs-table-row\">\n <td\n class=\"\n sky-docs-table-cell sky-docs-method-definitions-table-cell-name\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n <td\n class=\"\n sky-docs-table-cell\n sky-docs-method-definitions-table-cell-description\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n </tr>\n </table>\n </ng-container>\n\n <ng-template #mobileTemplate>\n <dl\n class=\"sky-docs-method-definition-list sky-docs-static-method-definitions\"\n *ngIf=\"staticMethods?.length > 0\"\n >\n <div\n *ngFor=\"let method of staticMethods\"\n class=\"sky-docs-method-definition-list-item\"\n >\n <dt class=\"sky-field-label\">Static methods</dt>\n <dd class=\"sky-docs-method-definitions-dd-name\">\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n <dt class=\"sky-field-label\">Description</dt>\n <dd class=\"sky-docs-method-definitions-dd-description\">\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n </div>\n </dl>\n <dl\n class=\"\n sky-docs-method-definition-list sky-docs-standard-method-definitions\n \"\n *ngIf=\"methods?.length > 0\"\n >\n <div\n *ngFor=\"let method of methods\"\n class=\"sky-docs-method-definition-list-item\"\n >\n <dt class=\"sky-field-label\">Methods</dt>\n <dd class=\"sky-docs-method-definitions-dd-name\">\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n <dt class=\"sky-field-label\">Description</dt>\n <dd class=\"sky-docs-method-definitions-dd-description\">\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n </div>\n </dl>\n </ng-template>\n</div>\n\n<ng-template let-method #nameTemplate>\n <sky-code\n ><span\n [innerHtml]=\"\n method.formattedName | skyDocsTypeAnchorLinks: 'no-code-tags'\n \"\n ></span\n ></sky-code>\n</ng-template>\n\n<ng-template let-method #descriptionTemplate>\n <sky-docs-safe-html\n *ngIf=\"method.deprecationWarning !== undefined\"\n class=\"sky-docs-method-definition-deprecation-warning\"\n [innerHtml]=\"\n deprecationWarningPrefix + method.deprecationWarning\n | skyDocsTypeAnchorLinks\n | skyDocsMarkdown\n \"\n ></sky-docs-safe-html>\n\n <sky-docs-safe-html\n *ngIf=\"method.description\"\n class=\"sky-docs-method-definition-description\"\n [innerHtml]=\"method.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"method.sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"method.sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-call-signature-definition\n *ngIf=\"method.callSignature\"\n [config]=\"method.callSignature\"\n ></sky-docs-call-signature-definition>\n\n <ng-container *ngIf=\"method.codeExample\">\n <h4 class=\"sky-docs-method-definition-heading\">Example</h4>\n <sky-code-block\n *ngIf=\"method.codeExample\"\n class=\"sky-docs-code-block\"\n languageType=\"method.codeExampleLanguage\"\n [code]=\"method.codeExample\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n </ng-container>\n</ng-template>\n", styles: [":host{margin:15px 0}.sky-docs-method-definitions{width:100%;max-width:100%;overflow:auto}.sky-docs-table-column-header-name{width:25%}.sky-docs-method-definition-label-optional{color:#686c73}.sky-docs-method-definition-list{margin:0}.sky-docs-method-definition-list-item{border-bottom:1px dotted #cdcfd2;margin:10px 0}.sky-docs-method-definition-list-item .sky-field-label{margin:10px 0}\n"], components: [{ type: i3$1.λ1, selector: "sky-code" }, { type: SkyDocsSafeHtmlComponent, selector: "sky-docs-safe-html", inputs: ["innerHtml"] }, { type: i3$1.λ2, selector: "sky-code-block", inputs: ["code", "fileName", "languageType", "hideCopyToClipboard", "hideHeader"] }, { type: SkyDocsCallSignatureDefinitionComponent, selector: "sky-docs-call-signature-definition", inputs: ["config"] }], directives: [{ type: i2.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { type: i2.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }, { type: i2.NgTemplateOutlet, selector: "[ngTemplateOutlet]", inputs: ["ngTemplateOutletContext", "ngTemplateOutlet"] }], pipes: { "skyDocsTypeAnchorLinks": SkyDocsTypeAnchorLinksPipe, "skyDocsMarkdown": SkyDocsMarkdownPipe }, changeDetection: i0.ChangeDetectionStrategy.OnPush });
|
|
1764
1788
|
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsMethodDefinitionsComponent, decorators: [{
|
|
1765
1789
|
type: Component,
|
|
1766
|
-
args: [{ selector: 'sky-docs-method-definitions', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div
|
|
1790
|
+
args: [{ selector: 'sky-docs-method-definitions', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div\n *ngIf=\"methods?.length > 0 || staticMethods?.length > 0\"\n class=\"sky-docs-method-definitions\"\n>\n <ng-container *ngIf=\"!isMobile; else mobileTemplate\">\n <table\n class=\"sky-docs-table sky-docs-static-method-definitions\"\n *ngIf=\"staticMethods?.length > 0\"\n >\n <tr class=\"sky-docs-table-row\">\n <th\n class=\"sky-docs-table-column-header sky-docs-table-column-header-name\"\n >\n Static methods\n </th>\n <th\n class=\"\n sky-docs-table-column-header\n sky-docs-table-column-header-description\n \"\n >\n Description\n </th>\n </tr>\n <tr *ngFor=\"let method of staticMethods\" class=\"sky-docs-table-row\">\n <td\n class=\"\n sky-docs-table-cell sky-docs-method-definitions-table-cell-name\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n <td\n class=\"\n sky-docs-table-cell\n sky-docs-method-definitions-table-cell-description\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n </tr>\n </table>\n <table\n class=\"sky-docs-table sky-docs-standard-method-definitions\"\n *ngIf=\"methods?.length > 0\"\n >\n <tr class=\"sky-docs-table-row\">\n <th\n class=\"sky-docs-table-column-header sky-docs-table-column-header-name\"\n >\n Methods\n </th>\n <th\n class=\"\n sky-docs-table-column-header\n sky-docs-table-column-header-description\n \"\n >\n Description\n </th>\n </tr>\n <tr *ngFor=\"let method of methods\" class=\"sky-docs-table-row\">\n <td\n class=\"\n sky-docs-table-cell sky-docs-method-definitions-table-cell-name\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n <td\n class=\"\n sky-docs-table-cell\n sky-docs-method-definitions-table-cell-description\n \"\n >\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </td>\n </tr>\n </table>\n </ng-container>\n\n <ng-template #mobileTemplate>\n <dl\n class=\"sky-docs-method-definition-list sky-docs-static-method-definitions\"\n *ngIf=\"staticMethods?.length > 0\"\n >\n <div\n *ngFor=\"let method of staticMethods\"\n class=\"sky-docs-method-definition-list-item\"\n >\n <dt class=\"sky-field-label\">Static methods</dt>\n <dd class=\"sky-docs-method-definitions-dd-name\">\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n <dt class=\"sky-field-label\">Description</dt>\n <dd class=\"sky-docs-method-definitions-dd-description\">\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n </div>\n </dl>\n <dl\n class=\"\n sky-docs-method-definition-list sky-docs-standard-method-definitions\n \"\n *ngIf=\"methods?.length > 0\"\n >\n <div\n *ngFor=\"let method of methods\"\n class=\"sky-docs-method-definition-list-item\"\n >\n <dt class=\"sky-field-label\">Methods</dt>\n <dd class=\"sky-docs-method-definitions-dd-name\">\n <ng-template\n [ngTemplateOutlet]=\"nameTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n <dt class=\"sky-field-label\">Description</dt>\n <dd class=\"sky-docs-method-definitions-dd-description\">\n <ng-template\n [ngTemplateOutlet]=\"descriptionTemplate\"\n [ngTemplateOutletContext]=\"{ $implicit: method }\"\n ></ng-template>\n </dd>\n </div>\n </dl>\n </ng-template>\n</div>\n\n<ng-template let-method #nameTemplate>\n <sky-code\n ><span\n [innerHtml]=\"\n method.formattedName | skyDocsTypeAnchorLinks: 'no-code-tags'\n \"\n ></span\n ></sky-code>\n</ng-template>\n\n<ng-template let-method #descriptionTemplate>\n <sky-docs-safe-html\n *ngIf=\"method.deprecationWarning !== undefined\"\n class=\"sky-docs-method-definition-deprecation-warning\"\n [innerHtml]=\"\n deprecationWarningPrefix + method.deprecationWarning\n | skyDocsTypeAnchorLinks\n | skyDocsMarkdown\n \"\n ></sky-docs-safe-html>\n\n <sky-docs-safe-html\n *ngIf=\"method.description\"\n class=\"sky-docs-method-definition-description\"\n [innerHtml]=\"method.description | skyDocsTypeAnchorLinks | skyDocsMarkdown\"\n ></sky-docs-safe-html>\n\n <sky-code-block\n *ngIf=\"method.sourceCode\"\n class=\"sky-docs-code-block\"\n languageType=\"typescript\"\n [code]=\"method.sourceCode\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n\n <sky-docs-call-signature-definition\n *ngIf=\"method.callSignature\"\n [config]=\"method.callSignature\"\n ></sky-docs-call-signature-definition>\n\n <ng-container *ngIf=\"method.codeExample\">\n <h4 class=\"sky-docs-method-definition-heading\">Example</h4>\n <sky-code-block\n *ngIf=\"method.codeExample\"\n class=\"sky-docs-code-block\"\n languageType=\"method.codeExampleLanguage\"\n [code]=\"method.codeExample\"\n [hideHeader]=\"true\"\n ></sky-code-block>\n </ng-container>\n</ng-template>\n", styles: [":host{margin:15px 0}.sky-docs-method-definitions{width:100%;max-width:100%;overflow:auto}.sky-docs-table-column-header-name{width:25%}.sky-docs-method-definition-label-optional{color:#686c73}.sky-docs-method-definition-list{margin:0}.sky-docs-method-definition-list-item{border-bottom:1px dotted #cdcfd2;margin:10px 0}.sky-docs-method-definition-list-item .sky-field-label{margin:10px 0}\n"] }]
|
|
1767
1791
|
}], ctorParameters: function () { return [{ type: i0.ChangeDetectorRef }, { type: SkyDocsTypeDefinitionsFormatService }, { type: i2$4.SkyMediaQueryService }]; }, propDecorators: { config: [{
|
|
1768
1792
|
type: Input
|
|
1769
1793
|
}] } });
|
|
@@ -2279,6 +2303,7 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2279
2303
|
name: this.getPropertyName(child),
|
|
2280
2304
|
type: this.getTypeDefinition(child),
|
|
2281
2305
|
isStatic: !!child.flags?.isStatic,
|
|
2306
|
+
parentName: entry.name,
|
|
2282
2307
|
};
|
|
2283
2308
|
// Comments for methods are stored in a different location.
|
|
2284
2309
|
const comment = child.signatures[0].comment;
|
|
@@ -2370,8 +2395,11 @@ class SkyDocsTypeDocAdapterService {
|
|
|
2370
2395
|
definition.unionTypes = child.type.types.map((t) => this.getTypeDefinition({ type: t }));
|
|
2371
2396
|
}
|
|
2372
2397
|
// Convert reflection types.
|
|
2373
|
-
if (child.type.type === 'reflection'
|
|
2374
|
-
|
|
2398
|
+
if (child.type.type === 'reflection' ||
|
|
2399
|
+
child.type.elementType?.type === 'reflection') {
|
|
2400
|
+
const declaration = child.type.elementType?.type === 'reflection'
|
|
2401
|
+
? child.type.elementType.declaration
|
|
2402
|
+
: child.type.declaration;
|
|
2375
2403
|
/*istanbul ignore else */
|
|
2376
2404
|
if (declaration) {
|
|
2377
2405
|
if (declaration.signatures) {
|