@skyux/docs-tools 6.0.0-beta.1 → 6.0.0-beta.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (72) hide show
  1. package/esm2020/docs-tools.module.mjs +5 -5
  2. package/esm2020/modules/anatomy/anatomy-item.component.mjs +4 -4
  3. package/esm2020/modules/anatomy/anatomy.component.mjs +4 -4
  4. package/esm2020/modules/anatomy/anatomy.module.mjs +5 -5
  5. package/esm2020/modules/code-examples/code-example.component.mjs +4 -4
  6. package/esm2020/modules/code-examples/code-examples-editor.service.mjs +7 -5
  7. package/esm2020/modules/code-examples/code-examples.component.mjs +5 -5
  8. package/esm2020/modules/code-examples/code-examples.module.mjs +5 -5
  9. package/esm2020/modules/demo/demo-control-panel-checkbox.component.mjs +6 -6
  10. package/esm2020/modules/demo/demo-control-panel-radio-group.component.mjs +17 -9
  11. package/esm2020/modules/demo/demo-control-panel-section.component.mjs +4 -4
  12. package/esm2020/modules/demo/demo-control-panel.component.mjs +4 -4
  13. package/esm2020/modules/demo/demo.component.mjs +4 -4
  14. package/esm2020/modules/demo/demo.module.mjs +5 -5
  15. package/esm2020/modules/demo-page/demo-page-dom-adapter.service.mjs +4 -4
  16. package/esm2020/modules/demo-page/demo-page-module-info.component.mjs +4 -4
  17. package/esm2020/modules/demo-page/demo-page-section.component.mjs +4 -4
  18. package/esm2020/modules/demo-page/demo-page-summary.component.mjs +4 -4
  19. package/esm2020/modules/demo-page/demo-page-title.service.mjs +4 -4
  20. package/esm2020/modules/demo-page/demo-page-type-definitions.component.mjs +14 -25
  21. package/esm2020/modules/demo-page/demo-page.component.mjs +66 -13
  22. package/esm2020/modules/demo-page/demo-page.module.mjs +5 -5
  23. package/esm2020/modules/design-guidelines/design-guideline-thumbnail.component.mjs +4 -4
  24. package/esm2020/modules/design-guidelines/design-guideline.component.mjs +4 -4
  25. package/esm2020/modules/design-guidelines/design-guidelines.component.mjs +4 -4
  26. package/esm2020/modules/design-guidelines/design-guidelines.module.mjs +5 -5
  27. package/esm2020/modules/heading-anchor/heading-anchor.component.mjs +4 -4
  28. package/esm2020/modules/heading-anchor/heading-anchor.module.mjs +5 -5
  29. package/esm2020/modules/markdown/markdown.module.mjs +5 -5
  30. package/esm2020/modules/markdown/markdown.pipe.mjs +5 -5
  31. package/esm2020/modules/module-info/module-info.component.mjs +42 -45
  32. package/esm2020/modules/module-info/module-info.module.mjs +9 -9
  33. package/esm2020/modules/safe-html/safe-html.component.mjs +4 -4
  34. package/esm2020/modules/safe-html/safe-html.module.mjs +5 -5
  35. package/esm2020/modules/shared/docs-tools-supportal.service.mjs +4 -4
  36. package/esm2020/modules/shared/sky-docs-tools-resources.module.mjs +5 -5
  37. package/esm2020/modules/source-code/source-code-provider.mjs +4 -4
  38. package/esm2020/modules/source-code/source-code.service.mjs +4 -4
  39. package/esm2020/modules/thumbnail/thumbnail.component.mjs +4 -4
  40. package/esm2020/modules/thumbnail/thumbnail.module.mjs +5 -5
  41. package/esm2020/modules/type-definitions/anchor-link.service.mjs +4 -4
  42. package/esm2020/modules/type-definitions/call-signature-definition.component.mjs +4 -4
  43. package/esm2020/modules/type-definitions/class-definition.component.mjs +4 -4
  44. package/esm2020/modules/type-definitions/directive-definition.component.mjs +4 -4
  45. package/esm2020/modules/type-definitions/enumeration-definition.component.mjs +4 -4
  46. package/esm2020/modules/type-definitions/interface-definition.component.mjs +5 -5
  47. package/esm2020/modules/type-definitions/method-definition.mjs +1 -1
  48. package/esm2020/modules/type-definitions/method-definitions.component.mjs +41 -24
  49. package/esm2020/modules/type-definitions/pipe-definition.component.mjs +5 -5
  50. package/esm2020/modules/type-definitions/property-definitions.component.mjs +4 -4
  51. package/esm2020/modules/type-definitions/type-alias-definition.component.mjs +4 -4
  52. package/esm2020/modules/type-definitions/type-anchor-links.pipe.mjs +4 -4
  53. package/esm2020/modules/type-definitions/type-definitions-format.service.mjs +14 -7
  54. package/esm2020/modules/type-definitions/type-definitions-provider.mjs +4 -4
  55. package/esm2020/modules/type-definitions/type-definitions.module.mjs +5 -5
  56. package/esm2020/modules/type-definitions/type-definitions.service.mjs +4 -4
  57. package/esm2020/modules/type-definitions/typedoc-adapter.service.mjs +11 -6
  58. package/esm2020/modules/type-definitions/typedoc-types.mjs +1 -1
  59. package/fesm2015/skyux-docs-tools.mjs +358 -280
  60. package/fesm2015/skyux-docs-tools.mjs.map +1 -1
  61. package/fesm2020/skyux-docs-tools.mjs +353 -278
  62. package/fesm2020/skyux-docs-tools.mjs.map +1 -1
  63. package/modules/demo/demo-control-panel-checkbox.component.d.ts +2 -2
  64. package/modules/demo/demo-control-panel-radio-group.component.d.ts +3 -2
  65. package/modules/demo-page/demo-page-type-definitions.component.d.ts +2 -9
  66. package/modules/demo-page/demo-page.component.d.ts +31 -4
  67. package/modules/module-info/module-info.component.d.ts +14 -16
  68. package/modules/module-info/module-info.module.d.ts +1 -1
  69. package/modules/type-definitions/method-definition.d.ts +2 -0
  70. package/modules/type-definitions/method-definitions.component.d.ts +3 -4
  71. package/modules/type-definitions/typedoc-types.d.ts +1 -0
  72. package/package.json +21 -21
@@ -1,5 +1,5 @@
1
1
  import { ChangeDetectorRef, OnDestroy, OnInit } from '@angular/core';
2
- import { Subject } from 'rxjs';
2
+ import { ReplaySubject } from 'rxjs';
3
3
  import { SkyDocsDemoControlPanelChange } from './demo-control-panel-change';
4
4
  import * as i0 from "@angular/core";
5
5
  /**
@@ -36,7 +36,7 @@ export declare class SkyDocsDemoControlPanelCheckboxComponent implements OnInit,
36
36
  * @required
37
37
  */
38
38
  propertyName: string;
39
- selectionChange: Subject<SkyDocsDemoControlPanelChange>;
39
+ selectionChange: ReplaySubject<SkyDocsDemoControlPanelChange>;
40
40
  private initialState;
41
41
  private _checked;
42
42
  constructor(changeDetector: ChangeDetectorRef);
@@ -1,5 +1,5 @@
1
1
  import { ChangeDetectorRef, OnInit, OnDestroy } from '@angular/core';
2
- import { Subject } from 'rxjs';
2
+ import { ReplaySubject } from 'rxjs';
3
3
  import { SkyDocsDemoControlPanelChange } from './demo-control-panel-change';
4
4
  import { SkyDocsDemoControlPanelRadioChoice } from './demo-control-panel-radio-choice';
5
5
  import * as i0 from "@angular/core";
@@ -21,6 +21,7 @@ import * as i0 from "@angular/core";
21
21
  * ```
22
22
  */
23
23
  export declare class SkyDocsDemoControlPanelRadioGroupComponent implements OnInit, OnDestroy {
24
+ #private;
24
25
  private changeDetector;
25
26
  /**
26
27
  * The possible choices to be represented by radio controls.
@@ -47,7 +48,7 @@ export declare class SkyDocsDemoControlPanelRadioGroupComponent implements OnIni
47
48
  /**
48
49
  * @internal
49
50
  */
50
- selectionChange: Subject<SkyDocsDemoControlPanelChange>;
51
+ selectionChange: ReplaySubject<SkyDocsDemoControlPanelChange>;
51
52
  /**
52
53
  * @internal
53
54
  */
@@ -1,17 +1,10 @@
1
- import { OnInit } from '@angular/core';
2
- import { SkyDocsTypeDefinitionsService } from '../type-definitions/type-definitions.service';
3
1
  import { SkyDocsTypeDefinitions } from '../type-definitions/type-definitions';
4
2
  import * as i0 from "@angular/core";
5
3
  /**
6
4
  * @internal
7
5
  */
8
- export declare class SkyDocsDemoPageTypeDefinitionsComponent implements OnInit {
9
- private typeDefinitionService;
10
- additionalSourceCodePaths: string[];
11
- moduleSourceCodePath: string;
6
+ export declare class SkyDocsDemoPageTypeDefinitionsComponent {
12
7
  types: SkyDocsTypeDefinitions;
13
- constructor(typeDefinitionService: SkyDocsTypeDefinitionsService);
14
- ngOnInit(): void;
15
8
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsDemoPageTypeDefinitionsComponent, never>;
16
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsDemoPageTypeDefinitionsComponent, "sky-docs-demo-page-type-definitions", never, { "additionalSourceCodePaths": "additionalSourceCodePaths"; "moduleSourceCodePath": "moduleSourceCodePath"; }, {}, never, never>;
9
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsDemoPageTypeDefinitionsComponent, "sky-docs-demo-page-type-definitions", never, { "types": "types"; }, {}, never, never>;
17
10
  }
@@ -5,6 +5,8 @@ import { StacheNavLink } from '@blackbaud/skyux-lib-stache';
5
5
  import { SkyDocsSupportalService } from '../shared/docs-tools-supportal.service';
6
6
  import { SkyDocsDemoPageDomAdapterService } from './demo-page-dom-adapter.service';
7
7
  import { SkyDocsDemoPageTitleService } from './demo-page-title.service';
8
+ import { SkyDocsTypeDefinitionsService } from '../type-definitions/type-definitions.service';
9
+ import { SkyDocsTypeDefinitions } from '../type-definitions/type-definitions';
8
10
  import * as i0 from "@angular/core";
9
11
  /**
10
12
  * The demo page component wraps all documentation components and handles the configuration and layout of the page.
@@ -18,6 +20,7 @@ import * as i0 from "@angular/core";
18
20
  * ```
19
21
  */
20
22
  export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentInit, AfterViewInit {
23
+ #private;
21
24
  private activatedRoute;
22
25
  private changeDetector;
23
26
  private router;
@@ -25,10 +28,17 @@ export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentIni
25
28
  private domAdapter;
26
29
  private supportalService;
27
30
  private titleService;
31
+ private typeDefinitionService;
28
32
  /**
29
33
  * Specifies the local path to any other relevant source code. The values are relative to the root directory.
30
34
  */
31
- additionalSourceCodePaths: string[];
35
+ set additionalSourceCodePaths(paths: string[] | undefined);
36
+ get additionalSourceCodePaths(): string[] | undefined;
37
+ /**
38
+ * Specifies the local path to any other relevant testing source code. The values are relative to the root directory.
39
+ */
40
+ set additionalTestingSourceCodePaths(paths: string[] | undefined);
41
+ get additionalTestingSourceCodePaths(): string[] | undefined;
32
42
  /**
33
43
  * Specifies the URL to the repo that stores the module's source code.
34
44
  * @required
@@ -42,7 +52,20 @@ export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentIni
42
52
  /**
43
53
  * Specifies the local path to the module's source code. The value is relative to the root directory.
44
54
  */
45
- moduleSourceCodePath: string;
55
+ set moduleSourceCodePath(path: string | undefined);
56
+ get moduleSourceCodePath(): string | undefined;
57
+ /**
58
+ * Specifies the type definitions for the development tab.
59
+ */
60
+ moduleTypeDefinitions: SkyDocsTypeDefinitions | undefined;
61
+ /**
62
+ * Specifies the local path to the testing source code. The value is relative to the root directory.
63
+ */
64
+ testingSourceCodePath: string;
65
+ /**
66
+ * Specifies the type definitions for the testing tab.
67
+ */
68
+ testingTypeDefinitions: SkyDocsTypeDefinitions | undefined;
46
69
  /**
47
70
  * Specifies the qualified name of the NPM package. For example, `@blackbaud/sample`.
48
71
  * @required
@@ -61,6 +84,10 @@ export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentIni
61
84
  * @internal
62
85
  */
63
86
  enableCodeExamples: boolean;
87
+ /**
88
+ * @internal
89
+ */
90
+ enableTestingTab: boolean;
64
91
  /**
65
92
  * @internal
66
93
  */
@@ -71,12 +98,12 @@ export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentIni
71
98
  sidebarRoutes: StacheNavLink[];
72
99
  private designGuidelinesComponent;
73
100
  private codeExampleComponents;
74
- constructor(activatedRoute: ActivatedRoute, changeDetector: ChangeDetectorRef, router: Router, skyAppConfig: SkyAppConfig, domAdapter: SkyDocsDemoPageDomAdapterService, supportalService: SkyDocsSupportalService, titleService: SkyDocsDemoPageTitleService);
101
+ constructor(activatedRoute: ActivatedRoute, changeDetector: ChangeDetectorRef, router: Router, skyAppConfig: SkyAppConfig, domAdapter: SkyDocsDemoPageDomAdapterService, supportalService: SkyDocsSupportalService, titleService: SkyDocsDemoPageTitleService, typeDefinitionService: SkyDocsTypeDefinitionsService);
75
102
  ngOnInit(): void;
76
103
  ngAfterContentInit(): void;
77
104
  ngAfterViewInit(): void;
78
105
  private updateTitle;
79
106
  private getPath;
80
107
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsDemoPageComponent, never>;
81
- static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsDemoPageComponent, "sky-docs-demo-page", never, { "additionalSourceCodePaths": "additionalSourceCodePaths"; "gitRepoUrl": "gitRepoUrl"; "moduleName": "moduleName"; "moduleSourceCodePath": "moduleSourceCodePath"; "packageName": "packageName"; "packageUrl": "packageUrl"; "pageTitle": "pageTitle"; }, {}, ["designGuidelinesComponent", "codeExampleComponents"], ["sky-docs-demo-page-summary", "sky-docs-demo", "sky-docs-design-guidelines", "sky-docs-demo-page-module-info", "*", "sky-docs-code-examples"]>;
108
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsDemoPageComponent, "sky-docs-demo-page", never, { "additionalSourceCodePaths": "additionalSourceCodePaths"; "additionalTestingSourceCodePaths": "additionalTestingSourceCodePaths"; "gitRepoUrl": "gitRepoUrl"; "moduleName": "moduleName"; "moduleSourceCodePath": "moduleSourceCodePath"; "packageName": "packageName"; "packageUrl": "packageUrl"; "pageTitle": "pageTitle"; }, {}, ["designGuidelinesComponent", "codeExampleComponents"], ["sky-docs-demo-page-summary", "sky-docs-demo", "sky-docs-design-guidelines", "sky-docs-code-examples", "sky-docs-demo-page-module-info", "*"]>;
82
109
  }
@@ -1,23 +1,21 @@
1
1
  import { SkyDocsToolsOptions } from '../shared/docs-tools-options';
2
2
  import * as i0 from "@angular/core";
3
+ declare type ExternalLink = {
4
+ label: string;
5
+ url: string;
6
+ };
3
7
  export declare class SkyDocsModuleInfoComponent {
4
- private options?;
5
- set gitRepoUrl(value: string);
6
- get gitRepoUrl(): string;
7
- moduleName: string;
8
- set packageName(value: string);
9
- get packageName(): string;
10
- set packageUrl(value: string);
11
- get packageUrl(): string;
12
- get externalLinks(): {
13
- label: string;
14
- url: string;
15
- }[];
16
- get installationCommand(): string;
17
- private _gitRepoUrl;
18
- private _packageName;
19
- private _packageUrl;
8
+ #private;
9
+ set gitRepoUrl(value: string | undefined);
10
+ moduleName: string | undefined;
11
+ set packageName(value: string | undefined);
12
+ set packageUrl(value: string | undefined);
13
+ gitRepoUrlOrDefault: string | undefined;
14
+ packageNameOrDefault: string | undefined;
15
+ externalLinks: ExternalLink[] | undefined;
16
+ installationCommand: string | undefined;
20
17
  constructor(options?: SkyDocsToolsOptions);
21
18
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsModuleInfoComponent, [{ optional: true; }]>;
22
19
  static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsModuleInfoComponent, "sky-docs-module-info", never, { "gitRepoUrl": "gitRepoUrl"; "moduleName": "moduleName"; "packageName": "packageName"; "packageUrl": "packageUrl"; }, {}, never, ["*"]>;
23
20
  }
21
+ export {};
@@ -8,6 +8,6 @@ import * as i6 from "@skyux/indicators";
8
8
  import * as i7 from "@skyux/popovers";
9
9
  export declare class SkyDocsModuleInfoModule {
10
10
  static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsModuleInfoModule, never>;
11
- static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsModuleInfoModule, [typeof i1.SkyDocsModuleInfoComponent], [typeof i2.CommonModule, typeof i3.SkyCodeModule, typeof i4.SkyClipboardModule, typeof i5.SkyDefinitionListModule, typeof i6.SkyHelpInlineModule, typeof i7.SkyPopoverModule], [typeof i1.SkyDocsModuleInfoComponent]>;
11
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsModuleInfoModule, [typeof i1.SkyDocsModuleInfoComponent], [typeof i2.CommonModule, typeof i3.SkyCodeModule, typeof i4.SkyClipboardModule, typeof i5.SkyDescriptionListModule, typeof i6.SkyHelpInlineModule, typeof i7.SkyPopoverModule], [typeof i1.SkyDocsModuleInfoComponent]>;
12
12
  static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsModuleInfoModule>;
13
13
  }
@@ -4,5 +4,7 @@ import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
4
4
  * Describes class methods.
5
5
  */
6
6
  export interface SkyDocsClassMethodDefinition extends SkyDocsEntryChildDefinition {
7
+ isStatic?: boolean;
7
8
  typeParameters?: SkyDocsTypeParameterDefinition[];
9
+ parentName?: string;
8
10
  }
@@ -12,11 +12,10 @@ interface MethodViewModel {
12
12
  description: string;
13
13
  formattedName: string;
14
14
  sourceCode: string;
15
+ isStatic: boolean;
15
16
  }
16
17
  export declare class SkyDocsMethodDefinitionsComponent implements OnInit {
17
- private changeDetector;
18
- private formatService;
19
- private mediaQueryService;
18
+ #private;
20
19
  set config(value: {
21
20
  methods?: SkyDocsClassMethodDefinition[];
22
21
  });
@@ -26,7 +25,7 @@ export declare class SkyDocsMethodDefinitionsComponent implements OnInit {
26
25
  deprecationWarningPrefix: string;
27
26
  isMobile: boolean;
28
27
  methods: MethodViewModel[];
29
- private _config;
28
+ staticMethods: MethodViewModel[];
30
29
  constructor(changeDetector: ChangeDetectorRef, formatService: SkyDocsTypeDefinitionsFormatService, mediaQueryService: SkyMediaQueryService);
31
30
  ngOnInit(): void;
32
31
  private updateView;
@@ -67,6 +67,7 @@ export interface TypeDocEntryChild {
67
67
  defaultValue?: string;
68
68
  flags?: {
69
69
  isOptional?: boolean;
70
+ isStatic?: boolean;
70
71
  };
71
72
  kindString?: 'Accessor' | 'Call signature' | 'Constructor' | 'Constructor signature' | 'Index signature' | 'Enumeration member' | 'Parameter' | 'Property' | 'Method';
72
73
  getSignature?: {
package/package.json CHANGED
@@ -1,31 +1,31 @@
1
1
  {
2
2
  "name": "@skyux/docs-tools",
3
- "version": "6.0.0-beta.1",
3
+ "version": "6.0.0-beta.11",
4
4
  "peerDependencies": {
5
- "@angular/common": "^13.3.2",
6
- "@angular/core": "^13.3.2",
7
- "@angular/forms": "^13.3.2",
8
- "@angular/platform-browser": "^13.3.2",
9
- "@blackbaud/skyux-lib-code-block": "^5.0.0-beta.0",
10
- "@blackbaud/skyux-lib-clipboard": "^5.0.0-beta.1",
11
- "@blackbaud/skyux-lib-media": "^5.0.0-beta.0",
12
- "@blackbaud/skyux-lib-stache": "^5.0.0-beta.2",
13
- "@skyux/core": "^6.0.0-beta.3",
14
- "@skyux/forms": "^6.0.0-beta.3",
15
- "@skyux/http": "^6.0.0-beta.3",
16
- "@skyux/i18n": "^6.0.0-beta.3",
17
- "@skyux/indicators": "^6.0.0-beta.3",
18
- "@skyux/layout": "^6.0.0-beta.3",
19
- "@skyux/lists": "^6.0.0-beta.3",
20
- "@skyux/popovers": "^6.0.0-beta.3",
21
- "@skyux/tabs": "^6.0.0-beta.3",
22
- "@skyux/theme": "^6.0.0-beta.3"
5
+ "@angular/common": "^13.3.11",
6
+ "@angular/core": "^13.3.11",
7
+ "@angular/forms": "^13.3.11",
8
+ "@angular/platform-browser": "^13.3.11",
9
+ "@blackbaud/skyux-lib-code-block": "^6.0.0-beta.1",
10
+ "@blackbaud/skyux-lib-clipboard": "^6.0.0-beta.0",
11
+ "@blackbaud/skyux-lib-media": "^6.0.0-beta.0",
12
+ "@blackbaud/skyux-lib-stache": "^6.0.0-beta.1",
13
+ "@skyux/core": "^6.9.0",
14
+ "@skyux/forms": "^6.9.0",
15
+ "@skyux/http": "^6.9.0",
16
+ "@skyux/i18n": "^6.9.0",
17
+ "@skyux/indicators": "^6.9.0",
18
+ "@skyux/layout": "^6.9.0",
19
+ "@skyux/lists": "^6.9.0",
20
+ "@skyux/popovers": "^6.9.0",
21
+ "@skyux/tabs": "^6.9.0",
22
+ "@skyux/theme": "^6.9.0"
23
23
  },
24
24
  "dependencies": {
25
25
  "@stackblitz/sdk": "1.5.6",
26
26
  "lodash.orderby": "4.6.0",
27
- "marked": "2.1.3",
28
- "tslib": "^2.3.1"
27
+ "marked": "4.0.17",
28
+ "tslib": "^2.4.0"
29
29
  },
30
30
  "module": "fesm2015/skyux-docs-tools.mjs",
31
31
  "es2020": "fesm2020/skyux-docs-tools.mjs",