@skyux/docs-tools 6.0.0-beta.3 → 6.0.0-beta.4
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/module-info/module-info.component.mjs +40 -43
- package/esm2020/modules/module-info/module-info.module.mjs +5 -5
- package/fesm2015/skyux-docs-tools.mjs +45 -46
- package/fesm2015/skyux-docs-tools.mjs.map +1 -1
- package/fesm2020/skyux-docs-tools.mjs +43 -46
- package/fesm2020/skyux-docs-tools.mjs.map +1 -1
- package/modules/module-info/module-info.component.d.ts +14 -16
- package/modules/module-info/module-info.module.d.ts +1 -1
- package/package.json +11 -11
|
@@ -5,7 +5,7 @@ import { Component, ChangeDetectionStrategy, Input, ContentChildren, NgModule, O
|
|
|
5
5
|
import * as i2$2 from '@blackbaud/skyux-lib-media';
|
|
6
6
|
import { SkyImageModule } from '@blackbaud/skyux-lib-media';
|
|
7
7
|
import * as i2$1 from '@skyux/layout';
|
|
8
|
-
import { SkyFluidGridModule, SkyDefinitionListModule } from '@skyux/layout';
|
|
8
|
+
import { SkyFluidGridModule, SkyDescriptionListModule, SkyDefinitionListModule } from '@skyux/layout';
|
|
9
9
|
import * as i3$1 from '@blackbaud/skyux-lib-code-block';
|
|
10
10
|
import { SkyCodeBlockModule, SkyCodeModule } from '@blackbaud/skyux-lib-code-block';
|
|
11
11
|
import * as i1$1 from '@skyux/indicators';
|
|
@@ -34,6 +34,7 @@ import * as i6 from '@blackbaud/skyux-lib-clipboard';
|
|
|
34
34
|
import { SkyClipboardModule } from '@blackbaud/skyux-lib-clipboard';
|
|
35
35
|
import * as i5 from '@skyux/popovers';
|
|
36
36
|
import { SkyPopoverModule } from '@skyux/popovers';
|
|
37
|
+
import { __classPrivateFieldSet, __classPrivateFieldGet } from 'tslib';
|
|
37
38
|
import * as i1$4 from '@angular/platform-browser';
|
|
38
39
|
import * as i2$4 from '@skyux/core';
|
|
39
40
|
import { SkyMediaBreakpoints } from '@skyux/core';
|
|
@@ -1076,62 +1077,58 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.11", ngImpo
|
|
|
1076
1077
|
class SkyDocsToolsOptions {
|
|
1077
1078
|
}
|
|
1078
1079
|
|
|
1080
|
+
var _SkyDocsModuleInfoComponent_instances, _SkyDocsModuleInfoComponent_options, _SkyDocsModuleInfoComponent_packageUrl, _SkyDocsModuleInfoComponent_updateExternalLinks, _SkyDocsModuleInfoComponent_updateInstallationCommand;
|
|
1079
1081
|
class SkyDocsModuleInfoComponent {
|
|
1080
1082
|
constructor(options) {
|
|
1081
|
-
this
|
|
1083
|
+
_SkyDocsModuleInfoComponent_instances.add(this);
|
|
1084
|
+
_SkyDocsModuleInfoComponent_options.set(this, void 0);
|
|
1085
|
+
_SkyDocsModuleInfoComponent_packageUrl.set(this, void 0);
|
|
1086
|
+
if (options) {
|
|
1087
|
+
__classPrivateFieldSet(this, _SkyDocsModuleInfoComponent_options, options, "f");
|
|
1088
|
+
this.gitRepoUrl = options.gitRepoUrl;
|
|
1089
|
+
this.packageName = options.packageName;
|
|
1090
|
+
}
|
|
1082
1091
|
}
|
|
1083
1092
|
set gitRepoUrl(value) {
|
|
1084
|
-
this.
|
|
1085
|
-
|
|
1086
|
-
get gitRepoUrl() {
|
|
1087
|
-
return this._gitRepoUrl || (this.options && this.options.gitRepoUrl);
|
|
1093
|
+
this.gitRepoUrlOrDefault = value || __classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_options, "f")?.gitRepoUrl;
|
|
1094
|
+
__classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_instances, "m", _SkyDocsModuleInfoComponent_updateExternalLinks).call(this);
|
|
1088
1095
|
}
|
|
1089
1096
|
set packageName(value) {
|
|
1090
|
-
this.
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
return this._packageName || (this.options && this.options.packageName);
|
|
1097
|
+
this.packageNameOrDefault = value || __classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_options, "f")?.packageName;
|
|
1098
|
+
__classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_instances, "m", _SkyDocsModuleInfoComponent_updateInstallationCommand).call(this);
|
|
1099
|
+
__classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_instances, "m", _SkyDocsModuleInfoComponent_updateExternalLinks).call(this);
|
|
1094
1100
|
}
|
|
1095
1101
|
set packageUrl(value) {
|
|
1096
|
-
this
|
|
1097
|
-
|
|
1098
|
-
get packageUrl() {
|
|
1099
|
-
if (this._packageUrl) {
|
|
1100
|
-
return this._packageUrl;
|
|
1101
|
-
}
|
|
1102
|
-
if (this.packageName) {
|
|
1103
|
-
return `https://npmjs.org/package/${this.packageName}`;
|
|
1104
|
-
}
|
|
1105
|
-
return '';
|
|
1102
|
+
__classPrivateFieldSet(this, _SkyDocsModuleInfoComponent_packageUrl, value, "f");
|
|
1103
|
+
__classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_instances, "m", _SkyDocsModuleInfoComponent_updateExternalLinks).call(this);
|
|
1106
1104
|
}
|
|
1107
|
-
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
1113
|
-
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
externalLinks.push({
|
|
1117
|
-
url: this.gitRepoUrl,
|
|
1118
|
-
label: 'View in GitHub',
|
|
1119
|
-
});
|
|
1120
|
-
}
|
|
1121
|
-
return externalLinks;
|
|
1105
|
+
}
|
|
1106
|
+
_SkyDocsModuleInfoComponent_options = new WeakMap(), _SkyDocsModuleInfoComponent_packageUrl = new WeakMap(), _SkyDocsModuleInfoComponent_instances = new WeakSet(), _SkyDocsModuleInfoComponent_updateExternalLinks = function _SkyDocsModuleInfoComponent_updateExternalLinks() {
|
|
1107
|
+
const externalLinks = [];
|
|
1108
|
+
if (this.packageNameOrDefault) {
|
|
1109
|
+
externalLinks.push({
|
|
1110
|
+
url: __classPrivateFieldGet(this, _SkyDocsModuleInfoComponent_packageUrl, "f") ||
|
|
1111
|
+
`https://npmjs.org/package/${this.packageNameOrDefault}`,
|
|
1112
|
+
label: 'View in NPM',
|
|
1113
|
+
});
|
|
1122
1114
|
}
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1127
|
-
|
|
1115
|
+
if (this.gitRepoUrlOrDefault) {
|
|
1116
|
+
externalLinks.push({
|
|
1117
|
+
url: this.gitRepoUrlOrDefault,
|
|
1118
|
+
label: 'View in GitHub',
|
|
1119
|
+
});
|
|
1128
1120
|
}
|
|
1129
|
-
|
|
1121
|
+
this.externalLinks = externalLinks;
|
|
1122
|
+
}, _SkyDocsModuleInfoComponent_updateInstallationCommand = function _SkyDocsModuleInfoComponent_updateInstallationCommand() {
|
|
1123
|
+
this.installationCommand = this.packageNameOrDefault
|
|
1124
|
+
? `npm install --save-exact ${this.packageNameOrDefault}`
|
|
1125
|
+
: '';
|
|
1126
|
+
};
|
|
1130
1127
|
SkyDocsModuleInfoComponent.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsModuleInfoComponent, deps: [{ token: SkyDocsToolsOptions, optional: true }], target: i0.ɵɵFactoryTarget.Component });
|
|
1131
|
-
SkyDocsModuleInfoComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsModuleInfoComponent, selector: "sky-docs-module-info", inputs: { gitRepoUrl: "gitRepoUrl", moduleName: "moduleName", packageName: "packageName", packageUrl: "packageUrl" }, ngImport: i0, template: "<div class=\"sky-docs-module-info\">\n <sky-
|
|
1128
|
+
SkyDocsModuleInfoComponent.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "12.0.0", version: "13.3.11", type: SkyDocsModuleInfoComponent, selector: "sky-docs-module-info", inputs: { gitRepoUrl: "gitRepoUrl", moduleName: "moduleName", packageName: "packageName", packageUrl: "packageUrl" }, ngImport: i0, template: "<div class=\"sky-docs-module-info\">\n <sky-description-list mode=\"vertical\">\n <sky-description-list-content>\n <sky-description-list-term> Defined in </sky-description-list-term>\n <sky-description-list-description>\n <sky-code class=\"sky-docs-module-info-module-name\">{{\n moduleName\n }}</sky-code>\n </sky-description-list-description>\n </sky-description-list-content>\n\n <sky-description-list-content *ngIf=\"packageNameOrDefault\">\n <sky-description-list-term>NPM package</sky-description-list-term>\n <sky-description-list-description>\n <span class=\"sky-docs-module-info-package-name\"\n ><sky-code>{{ packageNameOrDefault }}</sky-code></span\n >\n <ng-container *ngFor=\"let externalLink of externalLinks; let i = index\">\n <a\n class=\"sky-docs-module-info-external-link\"\n [href]=\"externalLink.url\"\n >{{ externalLink.label }}</a\n >\n <ng-container *ngIf=\"i < externalLinks.length - 1\"\n > |\n </ng-container>\n </ng-container>\n </sky-description-list-description>\n </sky-description-list-content>\n\n <sky-description-list-content *ngIf=\"installationCommand\">\n <sky-description-list-term>\n Installation\n <sky-help-inline\n class=\"sky-control-help\"\n [skyPopover]=\"installationCommandPopover\"\n skyPopoverPlacement=\"right\"\n >\n </sky-help-inline>\n </sky-description-list-term>\n <sky-description-list-description>\n <sky-popover #installationCommandPopover>\n To use this module, you must install peer dependencies along with its\n package. Also, after you install the package, you must add the module\n as an export in your SPA's main module to make exports available to\n your SPA.\n </sky-popover>\n <div class=\"sky-docs-module-info-installation-command\">\n <span\n class=\"sky-docs-module-info-installation-command-code\"\n #copyTarget\n >\n <sky-code>{{ installationCommand }}</sky-code>\n </span>\n <sky-copy-to-clipboard\n buttonText=\"Copy\"\n [copyTarget]=\"copyTarget\"\n ></sky-copy-to-clipboard>\n </div>\n </sky-description-list-description>\n </sky-description-list-content>\n </sky-description-list>\n\n <div class=\"sky-docs-module-info-additional-content\">\n <ng-content></ng-content>\n </div>\n</div>\n", styles: [".sky-docs-module-info-installation-command{display:flex}.sky-docs-module-info-installation-command-code,.sky-docs-module-info-package-name{margin-right:10px}\n"], components: [{ type: i2$1.λ18, selector: "sky-description-list", inputs: ["defaultDescription", "listItemWidth", "mode"] }, { type: i2$1.λ21, selector: "sky-description-list-content" }, { type: i2$1.λ19, selector: "sky-description-list-term" }, { type: i2$1.λ20, selector: "sky-description-list-description" }, { type: i3$1.λ1, selector: "sky-code" }, { type: i1$1.λ3, selector: "sky-help-inline", outputs: ["actionClick"] }, { type: i5.λ6, selector: "sky-popover", inputs: ["alignment", "dismissOnBlur", "placement", "popoverTitle", "popoverType"], outputs: ["popoverClosed", "popoverOpened"] }, { type: i6.λ1, selector: "sky-copy-to-clipboard", inputs: ["ariaLabel", "ariaLabelledBy", "copyTarget", "buttonText", "buttonClickedText", "title"] }], directives: [{ type: i2.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { type: i2.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }, { type: i5.λ7, selector: "[skyPopover]", inputs: ["skyPopover", "skyPopoverAlignment", "skyPopoverMessageStream", "skyPopoverPlacement", "skyPopoverTrigger"] }], changeDetection: i0.ChangeDetectionStrategy.OnPush });
|
|
1132
1129
|
i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsModuleInfoComponent, decorators: [{
|
|
1133
1130
|
type: Component,
|
|
1134
|
-
args: [{ selector: 'sky-docs-module-info', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div class=\"sky-docs-module-info\">\n <sky-
|
|
1131
|
+
args: [{ selector: 'sky-docs-module-info', changeDetection: ChangeDetectionStrategy.OnPush, template: "<div class=\"sky-docs-module-info\">\n <sky-description-list mode=\"vertical\">\n <sky-description-list-content>\n <sky-description-list-term> Defined in </sky-description-list-term>\n <sky-description-list-description>\n <sky-code class=\"sky-docs-module-info-module-name\">{{\n moduleName\n }}</sky-code>\n </sky-description-list-description>\n </sky-description-list-content>\n\n <sky-description-list-content *ngIf=\"packageNameOrDefault\">\n <sky-description-list-term>NPM package</sky-description-list-term>\n <sky-description-list-description>\n <span class=\"sky-docs-module-info-package-name\"\n ><sky-code>{{ packageNameOrDefault }}</sky-code></span\n >\n <ng-container *ngFor=\"let externalLink of externalLinks; let i = index\">\n <a\n class=\"sky-docs-module-info-external-link\"\n [href]=\"externalLink.url\"\n >{{ externalLink.label }}</a\n >\n <ng-container *ngIf=\"i < externalLinks.length - 1\"\n > |\n </ng-container>\n </ng-container>\n </sky-description-list-description>\n </sky-description-list-content>\n\n <sky-description-list-content *ngIf=\"installationCommand\">\n <sky-description-list-term>\n Installation\n <sky-help-inline\n class=\"sky-control-help\"\n [skyPopover]=\"installationCommandPopover\"\n skyPopoverPlacement=\"right\"\n >\n </sky-help-inline>\n </sky-description-list-term>\n <sky-description-list-description>\n <sky-popover #installationCommandPopover>\n To use this module, you must install peer dependencies along with its\n package. Also, after you install the package, you must add the module\n as an export in your SPA's main module to make exports available to\n your SPA.\n </sky-popover>\n <div class=\"sky-docs-module-info-installation-command\">\n <span\n class=\"sky-docs-module-info-installation-command-code\"\n #copyTarget\n >\n <sky-code>{{ installationCommand }}</sky-code>\n </span>\n <sky-copy-to-clipboard\n buttonText=\"Copy\"\n [copyTarget]=\"copyTarget\"\n ></sky-copy-to-clipboard>\n </div>\n </sky-description-list-description>\n </sky-description-list-content>\n </sky-description-list>\n\n <div class=\"sky-docs-module-info-additional-content\">\n <ng-content></ng-content>\n </div>\n</div>\n", styles: [".sky-docs-module-info-installation-command{display:flex}.sky-docs-module-info-installation-command-code,.sky-docs-module-info-package-name{margin-right:10px}\n"] }]
|
|
1135
1132
|
}], ctorParameters: function () { return [{ type: SkyDocsToolsOptions, decorators: [{
|
|
1136
1133
|
type: Optional
|
|
1137
1134
|
}] }]; }, propDecorators: { gitRepoUrl: [{
|
|
@@ -1150,14 +1147,14 @@ SkyDocsModuleInfoModule.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0",
|
|
|
1150
1147
|
SkyDocsModuleInfoModule.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsModuleInfoModule, declarations: [SkyDocsModuleInfoComponent], imports: [CommonModule,
|
|
1151
1148
|
SkyCodeModule,
|
|
1152
1149
|
SkyClipboardModule,
|
|
1153
|
-
|
|
1150
|
+
SkyDescriptionListModule,
|
|
1154
1151
|
SkyHelpInlineModule,
|
|
1155
1152
|
SkyPopoverModule], exports: [SkyDocsModuleInfoComponent] });
|
|
1156
1153
|
SkyDocsModuleInfoModule.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "13.3.11", ngImport: i0, type: SkyDocsModuleInfoModule, imports: [[
|
|
1157
1154
|
CommonModule,
|
|
1158
1155
|
SkyCodeModule,
|
|
1159
1156
|
SkyClipboardModule,
|
|
1160
|
-
|
|
1157
|
+
SkyDescriptionListModule,
|
|
1161
1158
|
SkyHelpInlineModule,
|
|
1162
1159
|
SkyPopoverModule,
|
|
1163
1160
|
]] });
|
|
@@ -1168,7 +1165,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "13.3.11", ngImpo
|
|
|
1168
1165
|
CommonModule,
|
|
1169
1166
|
SkyCodeModule,
|
|
1170
1167
|
SkyClipboardModule,
|
|
1171
|
-
|
|
1168
|
+
SkyDescriptionListModule,
|
|
1172
1169
|
SkyHelpInlineModule,
|
|
1173
1170
|
SkyPopoverModule,
|
|
1174
1171
|
],
|