@skyux/docs-tools 12.0.0-alpha.7 → 12.0.0-alpha.8

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 (63) hide show
  1. package/css/styles.css +35 -0
  2. package/fesm2022/skyux-docs-tools.mjs +1399 -79
  3. package/fesm2022/skyux-docs-tools.mjs.map +1 -1
  4. package/index.d.ts +32 -6
  5. package/lib/modules/category-tag/category-color.d.ts +6 -0
  6. package/lib/modules/category-tag/category-tag.component.d.ts +10 -0
  7. package/lib/modules/category-tag/category-tag.module.d.ts +10 -0
  8. package/lib/modules/clipboard/clipboard-button.directive.d.ts +12 -0
  9. package/lib/modules/clipboard/clipboard.module.d.ts +10 -0
  10. package/lib/modules/clipboard/clipboard.service.d.ts +9 -5
  11. package/lib/modules/code-example-viewer/code-example-viewer.component.d.ts +6 -6
  12. package/lib/modules/code-example-viewer/code-example-viewer.module.d.ts +4 -4
  13. package/lib/modules/code-example-viewer/stackblitz-launch-config.d.ts +1 -1
  14. package/lib/modules/code-example-viewer/stackblitz.service.d.ts +5 -5
  15. package/lib/modules/code-highlight/code-highlight-language.d.ts +12 -0
  16. package/lib/modules/code-highlight/code-highlight.pipe.d.ts +12 -0
  17. package/lib/modules/code-highlight/code-highlight.service.d.ts +11 -0
  18. package/lib/modules/code-snippet/code-snippet-toolbar.component.d.ts +9 -0
  19. package/lib/modules/code-snippet/code-snippet-wrapper.component.d.ts +12 -0
  20. package/lib/modules/code-snippet/code-snippet.component.d.ts +9 -9
  21. package/lib/modules/code-snippet/code-snippet.module.d.ts +5 -4
  22. package/lib/modules/heading-anchor/heading-anchor-heading-level.d.ts +4 -0
  23. package/lib/modules/heading-anchor/heading-anchor-heading-text-format.d.ts +4 -0
  24. package/lib/modules/heading-anchor/heading-anchor-link.d.ts +12 -0
  25. package/lib/modules/heading-anchor/heading-anchor.component.d.ts +24 -0
  26. package/lib/modules/heading-anchor/heading-anchor.module.d.ts +10 -0
  27. package/lib/modules/heading-anchor/heading-anchor.service.d.ts +16 -0
  28. package/lib/modules/showcase/code-example-types/code-example-types-token.d.ts +9 -0
  29. package/lib/modules/showcase/code-example-types/code-example-types.pipe.d.ts +11 -0
  30. package/lib/modules/showcase/code-example-types/provide-code-example-types.d.ts +14 -0
  31. package/lib/modules/showcase/showcase-area-development.component.d.ts +11 -0
  32. package/lib/modules/showcase/showcase-area-examples.component.d.ts +11 -0
  33. package/lib/modules/showcase/showcase-area-overview.component.d.ts +9 -0
  34. package/lib/modules/showcase/showcase-area-testing.component.d.ts +11 -0
  35. package/lib/modules/showcase/showcase-host.service.d.ts +15 -0
  36. package/lib/modules/showcase/showcase.component.d.ts +19 -0
  37. package/lib/modules/showcase/showcase.module.d.ts +14 -0
  38. package/lib/modules/table-of-contents/table-of-contents-links.d.ts +7 -0
  39. package/lib/modules/table-of-contents/table-of-contents-page.component.d.ts +15 -0
  40. package/lib/modules/table-of-contents/table-of-contents.component.d.ts +11 -0
  41. package/lib/modules/table-of-contents/table-of-contents.module.d.ts +11 -0
  42. package/lib/modules/type-definition/box.component.d.ts +12 -0
  43. package/lib/modules/type-definition/deprecation-reason.component.d.ts +9 -0
  44. package/lib/modules/type-definition/description.component.d.ts +10 -0
  45. package/lib/modules/type-definition/pipes/default-value.pipe.d.ts +11 -0
  46. package/lib/modules/type-definition/pipes/enum-signature.pipe.d.ts +11 -0
  47. package/lib/modules/type-definition/pipes/escape-html.pipe.d.ts +10 -0
  48. package/lib/modules/type-definition/pipes/function-signature.pipe.d.ts +12 -0
  49. package/lib/modules/type-definition/pipes/interface-signature.pipe.d.ts +11 -0
  50. package/lib/modules/type-definition/pipes/markdown.pipe.d.ts +10 -0
  51. package/lib/modules/type-definition/pipes/method-name.pipe.d.ts +12 -0
  52. package/lib/modules/type-definition/pipes/parameter-name.pipe.d.ts +11 -0
  53. package/lib/modules/type-definition/pipes/property-name.pipe.d.ts +12 -0
  54. package/lib/modules/type-definition/pipes/type-alias-signature.pipe.d.ts +11 -0
  55. package/lib/modules/type-definition/pipes/type-anchor-links.pipe.d.ts +14 -0
  56. package/lib/modules/type-definition/pipes/type-definition-kind-to-category-color.pipe.d.ts +12 -0
  57. package/lib/modules/type-definition/pipes/type-definition-kind-to-label.pipe.d.ts +11 -0
  58. package/lib/modules/type-definition/property-definition.d.ts +5 -0
  59. package/lib/modules/type-definition/type-anchor-ids.service.d.ts +14 -0
  60. package/lib/modules/type-definition/type-definition.component.d.ts +19 -0
  61. package/lib/modules/type-definition/type-definition.module.d.ts +10 -0
  62. package/package.json +24 -17
  63. package/lib/modules/code-snippet/code-snippet-language.d.ts +0 -12
@@ -0,0 +1,11 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import { SkyManifestParameterDefinition } from '@skyux/manifest';
3
+ import * as i0 from "@angular/core";
4
+ /**
5
+ * @internal
6
+ */
7
+ export declare class SkyDocsParameterNamePipe implements PipeTransform {
8
+ transform(parameter: SkyManifestParameterDefinition): string;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsParameterNamePipe, never>;
10
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsParameterNamePipe, "skyDocsParameterName", true>;
11
+ }
@@ -0,0 +1,12 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import { type SkyManifestParentDefinition } from '@skyux/manifest';
3
+ import { PropertyDefinition } from '../property-definition';
4
+ import * as i0 from "@angular/core";
5
+ /**
6
+ * @internal
7
+ */
8
+ export declare class SkyDocsPropertyNamePipe implements PipeTransform {
9
+ transform(property: PropertyDefinition, parent: SkyManifestParentDefinition): string;
10
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPropertyNamePipe, never>;
11
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsPropertyNamePipe, "skyDocsPropertyName", true>;
12
+ }
@@ -0,0 +1,11 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import { type SkyManifestParentDefinition } from '@skyux/manifest';
3
+ import * as i0 from "@angular/core";
4
+ /**
5
+ * @internal
6
+ */
7
+ export declare class SkyDocsTypeAliasSignaturePipe implements PipeTransform {
8
+ transform(definition: SkyManifestParentDefinition): string;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeAliasSignaturePipe, never>;
10
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsTypeAliasSignaturePipe, "skyDocsTypeAliasSignature", true>;
11
+ }
@@ -0,0 +1,14 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import * as i0 from "@angular/core";
3
+ /**
4
+ * For the given string, finds known tokens and wraps them in an anchor linking to the respective element ID.
5
+ * @internal
6
+ */
7
+ export declare class SkyTypeAnchorLinksPipe implements PipeTransform {
8
+ #private;
9
+ transform(value: string, options?: {
10
+ ignore: string[];
11
+ }): string;
12
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyTypeAnchorLinksPipe, never>;
13
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyTypeAnchorLinksPipe, "skyTypeAnchorLinks", true>;
14
+ }
@@ -0,0 +1,12 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import { SkyManifestParentDefinitionKind } from '@skyux/manifest';
3
+ import { SkyDocsCategoryColor } from '../../category-tag/category-color';
4
+ import * as i0 from "@angular/core";
5
+ /**
6
+ * @internal
7
+ */
8
+ export declare class SkyDocsTypeDefinitionKindToCategoryColorPipe implements PipeTransform {
9
+ transform(value: SkyManifestParentDefinitionKind): SkyDocsCategoryColor;
10
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionKindToCategoryColorPipe, never>;
11
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsTypeDefinitionKindToCategoryColorPipe, "skyDocsDefinitionKindToCategoryColor", true>;
12
+ }
@@ -0,0 +1,11 @@
1
+ import { PipeTransform } from '@angular/core';
2
+ import { SkyManifestParentDefinitionKind } from '@skyux/manifest';
3
+ import * as i0 from "@angular/core";
4
+ /**
5
+ * @internal
6
+ */
7
+ export declare class SkyDocsTypeDefinitionKindToLabelPipe implements PipeTransform {
8
+ transform(kind: SkyManifestParentDefinitionKind): string;
9
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionKindToLabelPipe, never>;
10
+ static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsTypeDefinitionKindToLabelPipe, "skyTypeDefinitionKindToLabel", true>;
11
+ }
@@ -0,0 +1,5 @@
1
+ import type { SkyManifestClassPropertyDefinition, SkyManifestDirectiveInputDefinition, SkyManifestDirectiveOutputDefinition, SkyManifestEnumerationMemberDefinition, SkyManifestInterfacePropertyDefinition } from '@skyux/manifest';
2
+ /**
3
+ * @internal
4
+ */
5
+ export type PropertyDefinition = SkyManifestClassPropertyDefinition | SkyManifestInterfacePropertyDefinition | SkyManifestEnumerationMemberDefinition | SkyManifestDirectiveInputDefinition | SkyManifestDirectiveOutputDefinition;
@@ -0,0 +1,14 @@
1
+ import * as i0 from "@angular/core";
2
+ /**
3
+ * Registers known type symbols with their corresponding anchor IDs.
4
+ * @internal
5
+ */
6
+ export declare class SkyDocsTypeDefinitionAnchorIdsService {
7
+ #private;
8
+ updateAnchorIds(anchorIds: {
9
+ [token: string]: string;
10
+ }): void;
11
+ getAnchorId(typeName: string): string | undefined;
12
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionAnchorIdsService, never>;
13
+ static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionAnchorIdsService>;
14
+ }
@@ -0,0 +1,19 @@
1
+ import { SkyManifestClassMethodDefinition, SkyManifestDirectiveInputDefinition, SkyManifestDirectiveOutputDefinition, type SkyManifestDocumentationTypeDefinition, SkyManifestParameterDefinition } from '@skyux/manifest';
2
+ import { PropertyDefinition } from './property-definition';
3
+ import * as i0 from "@angular/core";
4
+ /**
5
+ * @internal
6
+ */
7
+ export declare class SkyDocsTypeDefinitionComponent {
8
+ readonly definition: import("@angular/core").InputSignal<SkyManifestDocumentationTypeDefinition>;
9
+ readonly stacked: import("@angular/core").InputSignalWithTransform<boolean, unknown>;
10
+ protected readonly inputs: import("@angular/core").Signal<SkyManifestDirectiveInputDefinition[] | undefined>;
11
+ protected readonly methods: import("@angular/core").Signal<SkyManifestClassMethodDefinition[] | undefined>;
12
+ protected readonly outputs: import("@angular/core").Signal<SkyManifestDirectiveOutputDefinition[] | undefined>;
13
+ protected readonly parameters: import("@angular/core").Signal<SkyManifestParameterDefinition[] | undefined>;
14
+ protected readonly pipeName: import("@angular/core").Signal<string | undefined>;
15
+ protected readonly properties: import("@angular/core").Signal<PropertyDefinition[] | undefined>;
16
+ protected readonly selector: import("@angular/core").Signal<string | undefined>;
17
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionComponent, never>;
18
+ static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsTypeDefinitionComponent, "sky-docs-type-definition", never, { "definition": { "alias": "definition"; "required": true; "isSignal": true; }; "stacked": { "alias": "stacked"; "required": false; "isSignal": true; }; }, {}, never, never, true, never>;
19
+ }
@@ -0,0 +1,10 @@
1
+ import * as i0 from "@angular/core";
2
+ import * as i1 from "./type-definition.component";
3
+ /**
4
+ * @internal
5
+ */
6
+ export declare class SkyDocsTypeDefinitionModule {
7
+ static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionModule, never>;
8
+ static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsTypeDefinitionModule, never, [typeof i1.SkyDocsTypeDefinitionComponent], [typeof i1.SkyDocsTypeDefinitionComponent]>;
9
+ static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsTypeDefinitionModule>;
10
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@skyux/docs-tools",
3
- "version": "12.0.0-alpha.7",
3
+ "version": "12.0.0-alpha.8",
4
4
  "author": "Blackbaud, Inc.",
5
5
  "keywords": [
6
6
  "blackbaud",
@@ -15,33 +15,40 @@
15
15
  "url": "https://github.com/blackbaud/skyux/issues"
16
16
  },
17
17
  "homepage": "https://github.com/blackbaud/skyux#readme",
18
+ "exports": {
19
+ "./css/styles.css": {
20
+ "default": "./css/styles.css"
21
+ },
22
+ "./package.json": {
23
+ "default": "./package.json"
24
+ },
25
+ ".": {
26
+ "types": "./index.d.ts",
27
+ "default": "./fesm2022/skyux-docs-tools.mjs"
28
+ }
29
+ },
18
30
  "peerDependencies": {
19
31
  "@angular/common": "^19.0.5",
20
32
  "@angular/core": "^19.0.5",
21
33
  "@angular/platform-browser": "^19.0.5",
22
- "@skyux/assets": "12.0.0-alpha.7",
23
- "@skyux/core": "12.0.0-alpha.7",
24
- "@skyux/i18n": "12.0.0-alpha.7",
25
- "@skyux/icon": "12.0.0-alpha.7",
26
- "@skyux/layout": "12.0.0-alpha.7",
27
- "@skyux/tabs": "12.0.0-alpha.7",
28
- "@skyux/toast": "12.0.0-alpha.7"
34
+ "@angular/router": "^19.0.5",
35
+ "@skyux/assets": "12.0.0-alpha.8",
36
+ "@skyux/core": "12.0.0-alpha.8",
37
+ "@skyux/i18n": "12.0.0-alpha.8",
38
+ "@skyux/icon": "12.0.0-alpha.8",
39
+ "@skyux/indicators": "12.0.0-alpha.8",
40
+ "@skyux/layout": "12.0.0-alpha.8",
41
+ "@skyux/manifest": "12.0.0-alpha.8",
42
+ "@skyux/tabs": "12.0.0-alpha.8",
43
+ "@skyux/toast": "12.0.0-alpha.8"
29
44
  },
30
45
  "dependencies": {
31
46
  "@stackblitz/sdk": "1.11.0",
32
47
  "highlight.js": "11.11.1",
48
+ "marked": "15.0.7",
33
49
  "tslib": "^2.8.1"
34
50
  },
35
51
  "module": "fesm2022/skyux-docs-tools.mjs",
36
52
  "typings": "index.d.ts",
37
- "exports": {
38
- "./package.json": {
39
- "default": "./package.json"
40
- },
41
- ".": {
42
- "types": "./index.d.ts",
43
- "default": "./fesm2022/skyux-docs-tools.mjs"
44
- }
45
- },
46
53
  "sideEffects": false
47
54
  }
@@ -1,12 +0,0 @@
1
- /**
2
- * @internal
3
- */
4
- export declare const SKY_CODE_SNIPPET_LANGUAGES: readonly ["html", "js", "scss", "ts"];
5
- /**
6
- * @internal
7
- */
8
- export type SkyCodeSnippetLanguage = (typeof SKY_CODE_SNIPPET_LANGUAGES)[number];
9
- /**
10
- * @internal
11
- */
12
- export declare function assertCodeSnippetLanguage(value: string | undefined): asserts value is SkyCodeSnippetLanguage;