@skyux/docs-tools 12.0.0-alpha.0 → 12.0.0-alpha.6
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/README.md +4 -132
- package/fesm2022/skyux-docs-tools.mjs +444 -3335
- package/fesm2022/skyux-docs-tools.mjs.map +1 -1
- package/index.d.ts +6 -5
- package/lib/modules/clipboard/clipboard.service.d.ts +11 -0
- package/lib/modules/code-example-viewer/code-example-viewer.component.d.ts +23 -0
- package/lib/modules/code-example-viewer/code-example-viewer.module.d.ts +10 -0
- package/lib/modules/code-example-viewer/stackblitz-launch-config.d.ts +10 -0
- package/lib/modules/code-example-viewer/stackblitz.service.d.ts +11 -0
- package/lib/modules/code-snippet/code-snippet-language.d.ts +12 -0
- package/lib/modules/code-snippet/code-snippet.component.d.ts +16 -0
- package/lib/modules/code-snippet/code-snippet.module.d.ts +10 -0
- package/package.json +26 -20
- package/LICENSE +0 -21
- package/css/docs-tools.css +0 -70
- package/docs-tools.module.d.ts +0 -14
- package/modules/anatomy/anatomy-item.component.d.ts +0 -7
- package/modules/anatomy/anatomy-thumbnail.component.d.ts +0 -11
- package/modules/anatomy/anatomy.component.d.ts +0 -9
- package/modules/anatomy/anatomy.module.d.ts +0 -13
- package/modules/code-examples/code-example-module-dependencies.d.ts +0 -6
- package/modules/code-examples/code-example-theme.d.ts +0 -4
- package/modules/code-examples/code-example.component.d.ts +0 -39
- package/modules/code-examples/code-example.d.ts +0 -13
- package/modules/code-examples/code-examples-editor.service.d.ts +0 -18
- package/modules/code-examples/code-examples.component.d.ts +0 -45
- package/modules/code-examples/code-examples.module.d.ts +0 -14
- package/modules/demo/demo-content-alignment.d.ts +0 -1
- package/modules/demo/demo-control-panel-change.d.ts +0 -9
- package/modules/demo/demo-control-panel-checkbox.component.d.ts +0 -63
- package/modules/demo/demo-control-panel-radio-choice.d.ts +0 -13
- package/modules/demo/demo-control-panel-radio-group.component.d.ts +0 -64
- package/modules/demo/demo-control-panel-section.component.d.ts +0 -16
- package/modules/demo/demo-control-panel.component.d.ts +0 -34
- package/modules/demo/demo-custom-control-panel.component.d.ts +0 -9
- package/modules/demo/demo.component.d.ts +0 -32
- package/modules/demo/demo.module.d.ts +0 -18
- package/modules/demo-page/demo-page-dom-adapter.service.d.ts +0 -24
- package/modules/demo-page/demo-page-module-info.component.d.ts +0 -5
- package/modules/demo-page/demo-page-section.component.d.ts +0 -22
- package/modules/demo-page/demo-page-summary.component.d.ts +0 -15
- package/modules/demo-page/demo-page-title.service.d.ts +0 -12
- package/modules/demo-page/demo-page-type-definitions.component.d.ts +0 -10
- package/modules/demo-page/demo-page.component.d.ts +0 -112
- package/modules/demo-page/demo-page.module.d.ts +0 -23
- package/modules/design-guidelines/design-guideline-thumbnail.component.d.ts +0 -11
- package/modules/design-guidelines/design-guideline.component.d.ts +0 -12
- package/modules/design-guidelines/design-guidelines.component.d.ts +0 -5
- package/modules/design-guidelines/design-guidelines.module.d.ts +0 -12
- package/modules/heading-anchor/heading-anchor.component.d.ts +0 -7
- package/modules/heading-anchor/heading-anchor.module.d.ts +0 -10
- package/modules/markdown/markdown.module.d.ts +0 -7
- package/modules/markdown/markdown.pipe.d.ts +0 -7
- package/modules/module-info/module-info.component.d.ts +0 -21
- package/modules/module-info/module-info.module.d.ts +0 -13
- package/modules/safe-html/safe-html.component.d.ts +0 -10
- package/modules/safe-html/safe-html.module.d.ts +0 -8
- package/modules/shared/docs-tools-component-info.d.ts +0 -13
- package/modules/shared/docs-tools-options.d.ts +0 -4
- package/modules/shared/docs-tools-site-options.d.ts +0 -3
- package/modules/shared/docs-tools-supportal.service.d.ts +0 -11
- package/modules/source-code/source-code-file.d.ts +0 -5
- package/modules/source-code/source-code-provider.d.ts +0 -6
- package/modules/source-code/source-code.service.d.ts +0 -10
- package/modules/thumbnail/thumbnail.component.d.ts +0 -11
- package/modules/thumbnail/thumbnail.module.d.ts +0 -9
- package/modules/type-definitions/anchor-link-service-config.d.ts +0 -6
- package/modules/type-definitions/anchor-link-service-format.d.ts +0 -4
- package/modules/type-definitions/anchor-link.d.ts +0 -3
- package/modules/type-definitions/anchor-link.service.d.ts +0 -24
- package/modules/type-definitions/call-signature-definition.component.d.ts +0 -26
- package/modules/type-definitions/call-signature-definition.d.ts +0 -9
- package/modules/type-definitions/class-definition.component.d.ts +0 -7
- package/modules/type-definitions/class-definition.d.ts +0 -11
- package/modules/type-definitions/comment-tags.d.ts +0 -14
- package/modules/type-definitions/directive-definition.component.d.ts +0 -7
- package/modules/type-definitions/directive-definition.d.ts +0 -11
- package/modules/type-definitions/entry-child-definition.d.ts +0 -13
- package/modules/type-definitions/entry-definition.d.ts +0 -12
- package/modules/type-definitions/enumeration-definition.component.d.ts +0 -7
- package/modules/type-definitions/enumeration-definition.d.ts +0 -9
- package/modules/type-definitions/enumeration-member-definition.d.ts +0 -11
- package/modules/type-definitions/index-signature-definition.d.ts +0 -11
- package/modules/type-definitions/interface-definition.component.d.ts +0 -14
- package/modules/type-definitions/interface-definition.d.ts +0 -11
- package/modules/type-definitions/interface-property-definition.d.ts +0 -8
- package/modules/type-definitions/method-definition.d.ts +0 -11
- package/modules/type-definitions/method-definitions.component.d.ts +0 -36
- package/modules/type-definitions/parameter-definition.d.ts +0 -12
- package/modules/type-definitions/pipe-definition.component.d.ts +0 -7
- package/modules/type-definitions/pipe-definition.d.ts +0 -8
- package/modules/type-definitions/preview-feature-indicator.component.d.ts +0 -5
- package/modules/type-definitions/property-decorator.d.ts +0 -6
- package/modules/type-definitions/property-definition.d.ts +0 -11
- package/modules/type-definitions/property-definitions.component.d.ts +0 -39
- package/modules/type-definitions/type-alias-definition.component.d.ts +0 -14
- package/modules/type-definitions/type-alias-definition.d.ts +0 -11
- package/modules/type-definitions/type-anchor-links.pipe.d.ts +0 -14
- package/modules/type-definitions/type-definition.d.ts +0 -36
- package/modules/type-definitions/type-definitions-format.service.d.ts +0 -55
- package/modules/type-definitions/type-definitions-provider.d.ts +0 -10
- package/modules/type-definitions/type-definitions.d.ts +0 -20
- package/modules/type-definitions/type-definitions.module.d.ts +0 -26
- package/modules/type-definitions/type-definitions.service.d.ts +0 -20
- package/modules/type-definitions/type-parameter-definition.d.ts +0 -8
- package/modules/type-definitions/typedoc-adapter.service.d.ts +0 -49
- package/modules/type-definitions/typedoc-types.d.ts +0 -142
- package/public-api.d.ts +0 -66
- /package/{modules → lib/modules}/shared/sky-docs-tools-resources.module.d.ts +0 -0
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
export declare class SkyDocsThumbnailComponent {
|
|
3
|
-
caption: string;
|
|
4
|
-
captionType: string;
|
|
5
|
-
imageAlt: string;
|
|
6
|
-
imageSource: string;
|
|
7
|
-
showBorder: boolean;
|
|
8
|
-
videoSource: string;
|
|
9
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsThumbnailComponent, never>;
|
|
10
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsThumbnailComponent, "sky-docs-thumbnail", never, { "caption": { "alias": "caption"; "required": false; }; "captionType": { "alias": "captionType"; "required": false; }; "imageAlt": { "alias": "imageAlt"; "required": false; }; "imageSource": { "alias": "imageSource"; "required": false; }; "showBorder": { "alias": "showBorder"; "required": false; }; "videoSource": { "alias": "videoSource"; "required": false; }; }, {}, never, never, false, never>;
|
|
11
|
-
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
import * as i1 from "./thumbnail.component";
|
|
3
|
-
import * as i2 from "@angular/common";
|
|
4
|
-
import * as i3 from "@blackbaud/skyux-lib-media";
|
|
5
|
-
export declare class SkyDocsThumbnailModule {
|
|
6
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsThumbnailModule, never>;
|
|
7
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsThumbnailModule, [typeof i1.SkyDocsThumbnailComponent], [typeof i2.CommonModule, typeof i3.SkyImageModule], [typeof i1.SkyDocsThumbnailComponent]>;
|
|
8
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsThumbnailModule>;
|
|
9
|
-
}
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
import { SkyDocsAnchorLinkConfig } from './anchor-link-service-config';
|
|
2
|
-
import { SkyDocsTypeDefinitionsProvider } from './type-definitions-provider';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class SkyDocsAnchorLinkService {
|
|
5
|
-
private anchorIds;
|
|
6
|
-
constructor(typeDefinitionsProvider: SkyDocsTypeDefinitionsProvider);
|
|
7
|
-
/**
|
|
8
|
-
* Formats known type names with `<code>` tags and wraps them with anchor tags, linking to the appropriate type.
|
|
9
|
-
* If the content is already contained within a `<code>` tag, set `codeFormat = false` to prevent extra `<code>` tags from being added.
|
|
10
|
-
*/
|
|
11
|
-
applyTypeAnchorLinks(content: string, config?: SkyDocsAnchorLinkConfig): string;
|
|
12
|
-
/**
|
|
13
|
-
* For backwards compatibility, we need to remove any double brackets wrapped around types.
|
|
14
|
-
* e.g., `[[SampleType]]`
|
|
15
|
-
*/
|
|
16
|
-
private removeDoubleSquareBrackets;
|
|
17
|
-
/**
|
|
18
|
-
* Removes backtick characters around known types to prevent
|
|
19
|
-
* the markdown pipe from wrapping them with code elements.
|
|
20
|
-
*/
|
|
21
|
-
private removeBackticks;
|
|
22
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsAnchorLinkService, never>;
|
|
23
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsAnchorLinkService>;
|
|
24
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
|
|
2
|
-
import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
interface ParameterViewModel {
|
|
5
|
-
defaultValue: string;
|
|
6
|
-
description: string;
|
|
7
|
-
formattedName: string;
|
|
8
|
-
isOptional: boolean;
|
|
9
|
-
}
|
|
10
|
-
/**
|
|
11
|
-
* "Call signatures" include methods, functions, and inline arrow functions.
|
|
12
|
-
* This component is used to document both the return type and parameters of a given call signature.
|
|
13
|
-
*/
|
|
14
|
-
export declare class SkyDocsCallSignatureDefinitionComponent {
|
|
15
|
-
private formatService;
|
|
16
|
-
set config(value: SkyDocsCallSignatureDefinition);
|
|
17
|
-
get config(): SkyDocsCallSignatureDefinition;
|
|
18
|
-
parameters: ParameterViewModel[];
|
|
19
|
-
returnTypeFormatted: string;
|
|
20
|
-
private _config;
|
|
21
|
-
constructor(formatService: SkyDocsTypeDefinitionsFormatService);
|
|
22
|
-
private updateView;
|
|
23
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsCallSignatureDefinitionComponent, never>;
|
|
24
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsCallSignatureDefinitionComponent, "sky-docs-call-signature-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
25
|
-
}
|
|
26
|
-
export {};
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { SkyDocsParameterDefinition } from './parameter-definition';
|
|
2
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
3
|
-
/**
|
|
4
|
-
* Describes methods, functions, and inline arrow functions.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsCallSignatureDefinition {
|
|
7
|
-
parameters?: SkyDocsParameterDefinition[];
|
|
8
|
-
returnType: SkyDocsTypeDefinition;
|
|
9
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { SkyDocsClassDefinition } from './class-definition';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class SkyDocsClassDefinitionComponent {
|
|
4
|
-
config: SkyDocsClassDefinition;
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsClassDefinitionComponent, never>;
|
|
6
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsClassDefinitionComponent, "sky-docs-class-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
7
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsClassPropertyDefinition } from './property-definition';
|
|
2
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
3
|
-
import { SkyDocsClassMethodDefinition } from './method-definition';
|
|
4
|
-
/**
|
|
5
|
-
* Describes classes and services.
|
|
6
|
-
*/
|
|
7
|
-
export interface SkyDocsClassDefinition extends SkyDocsEntryDefinition {
|
|
8
|
-
hasPreviewFeatures: boolean;
|
|
9
|
-
methods?: SkyDocsClassMethodDefinition[];
|
|
10
|
-
properties?: SkyDocsClassPropertyDefinition[];
|
|
11
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
export interface SkyDocsCommentTags {
|
|
2
|
-
codeExample: string;
|
|
3
|
-
codeExampleLanguage: string;
|
|
4
|
-
defaultValue: string;
|
|
5
|
-
deprecationWarning: string;
|
|
6
|
-
description: string;
|
|
7
|
-
extras?: {
|
|
8
|
-
[key: string]: any;
|
|
9
|
-
};
|
|
10
|
-
parameters?: {
|
|
11
|
-
name: string;
|
|
12
|
-
description: string;
|
|
13
|
-
}[];
|
|
14
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { SkyDocsDirectiveDefinition } from './directive-definition';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class SkyDocsDirectiveDefinitionComponent {
|
|
4
|
-
config: SkyDocsDirectiveDefinition;
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsDirectiveDefinitionComponent, never>;
|
|
6
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsDirectiveDefinitionComponent, "sky-docs-directive-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
7
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsClassPropertyDefinition } from './property-definition';
|
|
2
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
3
|
-
/**
|
|
4
|
-
* Describes components and directives.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsDirectiveDefinition extends SkyDocsEntryDefinition {
|
|
7
|
-
eventProperties?: SkyDocsClassPropertyDefinition[];
|
|
8
|
-
hasPreviewFeatures: boolean;
|
|
9
|
-
inputProperties?: SkyDocsClassPropertyDefinition[];
|
|
10
|
-
selector: string;
|
|
11
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
2
|
-
/**
|
|
3
|
-
* Describes all entry-level children types, such as methods, properties, and accessors.
|
|
4
|
-
* @internal
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsEntryChildDefinition {
|
|
7
|
-
codeExample?: string;
|
|
8
|
-
codeExampleLanguage?: string;
|
|
9
|
-
deprecationWarning?: string;
|
|
10
|
-
description?: string;
|
|
11
|
-
name: string;
|
|
12
|
-
type: SkyDocsTypeDefinition;
|
|
13
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Describes all entry-level types such as classes, directives, enumerations, etc.
|
|
3
|
-
* @internal
|
|
4
|
-
*/
|
|
5
|
-
export interface SkyDocsEntryDefinition {
|
|
6
|
-
anchorId: string;
|
|
7
|
-
codeExample?: string;
|
|
8
|
-
codeExampleLanguage?: string;
|
|
9
|
-
deprecationWarning?: string;
|
|
10
|
-
description?: string;
|
|
11
|
-
name: string;
|
|
12
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEnumerationDefinition } from './enumeration-definition';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class SkyDocsEnumerationDefinitionComponent {
|
|
4
|
-
config: SkyDocsEnumerationDefinition;
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsEnumerationDefinitionComponent, never>;
|
|
6
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsEnumerationDefinitionComponent, "sky-docs-enumeration-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
7
|
-
}
|
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
2
|
-
import { SkyDocsEnumerationMemberDefinition } from './enumeration-member-definition';
|
|
3
|
-
/**
|
|
4
|
-
* Describes enumerations.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsEnumerationDefinition extends SkyDocsEntryDefinition {
|
|
7
|
-
hasPreviewFeatures: boolean;
|
|
8
|
-
members: SkyDocsEnumerationMemberDefinition[];
|
|
9
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
2
|
-
/**
|
|
3
|
-
* Describes index signature types, e.g. `[_: string]: any`.
|
|
4
|
-
*/
|
|
5
|
-
export interface SkyDocsIndexSignatureDefinition {
|
|
6
|
-
key: {
|
|
7
|
-
name: string;
|
|
8
|
-
type: SkyDocsTypeDefinition;
|
|
9
|
-
};
|
|
10
|
-
type: SkyDocsTypeDefinition;
|
|
11
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { SkyDocsInterfaceDefinition } from './interface-definition';
|
|
2
|
-
import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class SkyDocsInterfaceDefinitionComponent {
|
|
5
|
-
private formatService;
|
|
6
|
-
set config(value: SkyDocsInterfaceDefinition);
|
|
7
|
-
get config(): SkyDocsInterfaceDefinition;
|
|
8
|
-
sourceCode: string;
|
|
9
|
-
private _config;
|
|
10
|
-
constructor(formatService: SkyDocsTypeDefinitionsFormatService);
|
|
11
|
-
private updateView;
|
|
12
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsInterfaceDefinitionComponent, never>;
|
|
13
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsInterfaceDefinitionComponent, "sky-docs-interface-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
14
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
2
|
-
import { SkyDocsInterfacePropertyDefinition } from './interface-property-definition';
|
|
3
|
-
import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
|
|
4
|
-
/**
|
|
5
|
-
* Describes interfaces.
|
|
6
|
-
*/
|
|
7
|
-
export interface SkyDocsInterfaceDefinition extends SkyDocsEntryDefinition {
|
|
8
|
-
hasPreviewFeatures: boolean;
|
|
9
|
-
properties: SkyDocsInterfacePropertyDefinition[];
|
|
10
|
-
typeParameters?: SkyDocsTypeParameterDefinition[];
|
|
11
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryChildDefinition } from './entry-child-definition';
|
|
2
|
-
import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
|
|
3
|
-
/**
|
|
4
|
-
* Describes class methods.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsClassMethodDefinition extends SkyDocsEntryChildDefinition {
|
|
7
|
-
isStatic?: boolean;
|
|
8
|
-
isPreview: boolean;
|
|
9
|
-
typeParameters?: SkyDocsTypeParameterDefinition[];
|
|
10
|
-
parentName?: string;
|
|
11
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { ChangeDetectorRef, OnInit } from '@angular/core';
|
|
2
|
-
import { SkyMediaQueryService } from '@skyux/core';
|
|
3
|
-
import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
|
|
4
|
-
import { SkyDocsClassMethodDefinition } from './method-definition';
|
|
5
|
-
import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
|
|
6
|
-
import * as i0 from "@angular/core";
|
|
7
|
-
interface MethodViewModel {
|
|
8
|
-
callSignature: SkyDocsCallSignatureDefinition;
|
|
9
|
-
codeExample: string;
|
|
10
|
-
codeExampleLanguage: string;
|
|
11
|
-
deprecationWarning: string;
|
|
12
|
-
description: string;
|
|
13
|
-
formattedName: string;
|
|
14
|
-
sourceCode: string;
|
|
15
|
-
isStatic: boolean;
|
|
16
|
-
isPreview: boolean;
|
|
17
|
-
}
|
|
18
|
-
export declare class SkyDocsMethodDefinitionsComponent implements OnInit {
|
|
19
|
-
#private;
|
|
20
|
-
set config(value: {
|
|
21
|
-
methods?: SkyDocsClassMethodDefinition[];
|
|
22
|
-
});
|
|
23
|
-
get config(): {
|
|
24
|
-
methods?: SkyDocsClassMethodDefinition[];
|
|
25
|
-
};
|
|
26
|
-
deprecationWarningPrefix: string;
|
|
27
|
-
isMobile: boolean;
|
|
28
|
-
methods: MethodViewModel[];
|
|
29
|
-
staticMethods: MethodViewModel[];
|
|
30
|
-
constructor(changeDetector: ChangeDetectorRef, formatService: SkyDocsTypeDefinitionsFormatService, mediaQueryService: SkyMediaQueryService);
|
|
31
|
-
ngOnInit(): void;
|
|
32
|
-
private updateView;
|
|
33
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsMethodDefinitionsComponent, never>;
|
|
34
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsMethodDefinitionsComponent, "sky-docs-method-definitions", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
35
|
-
}
|
|
36
|
-
export {};
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
2
|
-
/**
|
|
3
|
-
* Describes function and method parameters.
|
|
4
|
-
*/
|
|
5
|
-
export interface SkyDocsParameterDefinition {
|
|
6
|
-
defaultValue?: string;
|
|
7
|
-
description?: string;
|
|
8
|
-
isOptional: boolean;
|
|
9
|
-
name: string;
|
|
10
|
-
type: SkyDocsTypeDefinition;
|
|
11
|
-
typeArguments?: SkyDocsTypeDefinition[];
|
|
12
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import { SkyDocsPipeDefinition } from './pipe-definition';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class SkyDocsPipeDefinitionComponent {
|
|
4
|
-
config: SkyDocsPipeDefinition;
|
|
5
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPipeDefinitionComponent, never>;
|
|
6
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPipeDefinitionComponent, "sky-docs-pipe-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
7
|
-
}
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
2
|
-
import { SkyDocsClassMethodDefinition } from './method-definition';
|
|
3
|
-
/**
|
|
4
|
-
* Describes pipes.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsPipeDefinition extends SkyDocsEntryDefinition {
|
|
7
|
-
transformMethod: SkyDocsClassMethodDefinition;
|
|
8
|
-
}
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
export declare class SkyDocsPreviewIndicatorComponent {
|
|
3
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPreviewIndicatorComponent, never>;
|
|
4
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPreviewIndicatorComponent, "sky-docs-preview-feature-indicator", never, {}, {}, never, never, true, never>;
|
|
5
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryChildDefinition } from './entry-child-definition';
|
|
2
|
-
import { SkyDocsPropertyDecoratorDefinition } from './property-decorator';
|
|
3
|
-
/**
|
|
4
|
-
* Describes class properties.
|
|
5
|
-
*/
|
|
6
|
-
export interface SkyDocsClassPropertyDefinition extends SkyDocsEntryChildDefinition {
|
|
7
|
-
decorator?: SkyDocsPropertyDecoratorDefinition;
|
|
8
|
-
defaultValue?: string;
|
|
9
|
-
isOptional: boolean;
|
|
10
|
-
isPreview: boolean;
|
|
11
|
-
}
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
import { ChangeDetectorRef, OnInit } from '@angular/core';
|
|
2
|
-
import { SkyMediaQueryService } from '@skyux/core';
|
|
3
|
-
import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
|
|
4
|
-
import { SkyDocsClassPropertyDefinition } from './property-definition';
|
|
5
|
-
import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
|
|
6
|
-
import * as i0 from "@angular/core";
|
|
7
|
-
interface PropertyViewModel {
|
|
8
|
-
callSignature: SkyDocsCallSignatureDefinition;
|
|
9
|
-
defaultValue: string;
|
|
10
|
-
deprecationWarning: string;
|
|
11
|
-
description: string;
|
|
12
|
-
formattedName: string;
|
|
13
|
-
isOutput: boolean;
|
|
14
|
-
isOptional: boolean;
|
|
15
|
-
isPreview: boolean;
|
|
16
|
-
}
|
|
17
|
-
export declare class SkyDocsPropertyDefinitionsComponent implements OnInit {
|
|
18
|
-
private changeDetector;
|
|
19
|
-
private formatService;
|
|
20
|
-
private mediaQueryService;
|
|
21
|
-
set config(value: {
|
|
22
|
-
properties?: SkyDocsClassPropertyDefinition[];
|
|
23
|
-
});
|
|
24
|
-
get config(): {
|
|
25
|
-
properties?: SkyDocsClassPropertyDefinition[];
|
|
26
|
-
};
|
|
27
|
-
propertyType: string;
|
|
28
|
-
showOptionalStatus: boolean;
|
|
29
|
-
deprecationWarningPrefix: string;
|
|
30
|
-
isMobile: boolean;
|
|
31
|
-
properties: PropertyViewModel[];
|
|
32
|
-
private _config;
|
|
33
|
-
constructor(changeDetector: ChangeDetectorRef, formatService: SkyDocsTypeDefinitionsFormatService, mediaQueryService: SkyMediaQueryService);
|
|
34
|
-
ngOnInit(): void;
|
|
35
|
-
private updateView;
|
|
36
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPropertyDefinitionsComponent, never>;
|
|
37
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPropertyDefinitionsComponent, "sky-docs-property-definitions", never, { "config": { "alias": "config"; "required": false; }; "propertyType": { "alias": "propertyType"; "required": false; }; "showOptionalStatus": { "alias": "showOptionalStatus"; "required": false; }; }, {}, never, never, false, never>;
|
|
38
|
-
}
|
|
39
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
|
|
2
|
-
import { SkyDocsTypeDefinitionsFormatService } from './type-definitions-format.service';
|
|
3
|
-
import * as i0 from "@angular/core";
|
|
4
|
-
export declare class SkyDocsTypeAliasDefinitionComponent {
|
|
5
|
-
private formatService;
|
|
6
|
-
set config(value: SkyDocsTypeAliasDefinition);
|
|
7
|
-
get config(): SkyDocsTypeAliasDefinition;
|
|
8
|
-
sourceCode: string;
|
|
9
|
-
private _config;
|
|
10
|
-
constructor(formatService: SkyDocsTypeDefinitionsFormatService);
|
|
11
|
-
private updateView;
|
|
12
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeAliasDefinitionComponent, never>;
|
|
13
|
-
static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsTypeAliasDefinitionComponent, "sky-docs-type-alias-definition", never, { "config": { "alias": "config"; "required": false; }; }, {}, never, never, false, never>;
|
|
14
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { SkyDocsEntryDefinition } from './entry-definition';
|
|
2
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
3
|
-
import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
|
|
4
|
-
/**
|
|
5
|
-
* Describes type aliases.
|
|
6
|
-
*/
|
|
7
|
-
export interface SkyDocsTypeAliasDefinition extends SkyDocsEntryDefinition {
|
|
8
|
-
isPreview: boolean;
|
|
9
|
-
type: SkyDocsTypeDefinition;
|
|
10
|
-
typeParameters?: SkyDocsTypeParameterDefinition[];
|
|
11
|
-
}
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { PipeTransform } from '@angular/core';
|
|
2
|
-
import { SkyDocsAnchorLinkService } from './anchor-link.service';
|
|
3
|
-
import { SkyDocsAnchorLinkServiceFormatType } from './anchor-link-service-format';
|
|
4
|
-
import * as i0 from "@angular/core";
|
|
5
|
-
/**
|
|
6
|
-
* Adds same-page anchor tags around known TypeScript types.
|
|
7
|
-
*/
|
|
8
|
-
export declare class SkyDocsTypeAnchorLinksPipe implements PipeTransform {
|
|
9
|
-
private anchorLinkService;
|
|
10
|
-
constructor(anchorLinkService: SkyDocsAnchorLinkService);
|
|
11
|
-
transform(value: string, formatType?: SkyDocsAnchorLinkServiceFormatType): string;
|
|
12
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeAnchorLinksPipe, never>;
|
|
13
|
-
static ɵpipe: i0.ɵɵPipeDeclaration<SkyDocsTypeAnchorLinksPipe, "skyDocsTypeAnchorLinks", false>;
|
|
14
|
-
}
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
import { SkyDocsCallSignatureDefinition } from './call-signature-definition';
|
|
2
|
-
import { SkyDocsIndexSignatureDefinition } from './index-signature-definition';
|
|
3
|
-
import { SkyDocsInterfacePropertyDefinition } from './interface-property-definition';
|
|
4
|
-
/**
|
|
5
|
-
* Describes TypeScript types.
|
|
6
|
-
*/
|
|
7
|
-
export interface SkyDocsTypeDefinition {
|
|
8
|
-
/**
|
|
9
|
-
* Used by method, function, and arrow function types.
|
|
10
|
-
*/
|
|
11
|
-
callSignature?: SkyDocsCallSignatureDefinition;
|
|
12
|
-
/**
|
|
13
|
-
* Used for index signatures, e.g. `[_: string]: any`
|
|
14
|
-
*/
|
|
15
|
-
indexSignature?: SkyDocsIndexSignatureDefinition;
|
|
16
|
-
name?: string | number | boolean;
|
|
17
|
-
type?: 'array' | 'intrinsic' | 'literal' | 'reference' | 'reflection' | 'typeParameter' | 'typeOperator' | 'union' | 'unknown';
|
|
18
|
-
/**
|
|
19
|
-
* Describes any type arguments, e.g. `<T, F>`.
|
|
20
|
-
*/
|
|
21
|
-
typeArguments?: SkyDocsTypeDefinition[];
|
|
22
|
-
/**
|
|
23
|
-
* Used for type literals or inline interfaces, e.g. `route: { commands: any[] }`
|
|
24
|
-
*/
|
|
25
|
-
typeLiteral?: {
|
|
26
|
-
properties?: SkyDocsInterfacePropertyDefinition[];
|
|
27
|
-
};
|
|
28
|
-
/**
|
|
29
|
-
* The types that compose a union type.
|
|
30
|
-
*/
|
|
31
|
-
unionTypes?: SkyDocsTypeDefinition[];
|
|
32
|
-
/**
|
|
33
|
-
* The NPM package where the type is defined.
|
|
34
|
-
*/
|
|
35
|
-
package?: string;
|
|
36
|
-
}
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import { SkyDocsClassPropertyDefinition } from './property-definition';
|
|
2
|
-
import { SkyDocsInterfaceDefinition } from './interface-definition';
|
|
3
|
-
import { SkyDocsClassMethodDefinition } from './method-definition';
|
|
4
|
-
import { SkyDocsParameterDefinition } from './parameter-definition';
|
|
5
|
-
import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
|
|
6
|
-
import { SkyDocsTypeDefinition } from './type-definition';
|
|
7
|
-
import * as i0 from "@angular/core";
|
|
8
|
-
interface GetFormattedTypeConfig {
|
|
9
|
-
escapeSpecialCharacters: boolean;
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Formats type definitions into HTML-compatible strings.
|
|
13
|
-
*/
|
|
14
|
-
export declare class SkyDocsTypeDefinitionsFormatService {
|
|
15
|
-
/**
|
|
16
|
-
* Returns an HTML-formatted representation of the provided interface config.
|
|
17
|
-
*/
|
|
18
|
-
getInterfaceSourceCode(definition: SkyDocsInterfaceDefinition): string;
|
|
19
|
-
/**
|
|
20
|
-
* Returns an HTML-formatted representation of the provided method config.
|
|
21
|
-
*/
|
|
22
|
-
getMethodSourceCode(definition: SkyDocsClassMethodDefinition): string;
|
|
23
|
-
/**
|
|
24
|
-
* Returns an HTML-formatted representation of the provided type alias config.
|
|
25
|
-
*/
|
|
26
|
-
getTypeAliasSourceCode(definition: SkyDocsTypeAliasDefinition): string;
|
|
27
|
-
/**
|
|
28
|
-
* Returns a formatted string representing a parameter's name and value. For example: `'foo: string'`.
|
|
29
|
-
*/
|
|
30
|
-
getFormattedParameterName(parameter: SkyDocsParameterDefinition, config?: GetFormattedTypeConfig): string;
|
|
31
|
-
/**
|
|
32
|
-
* Returns a formatted string representing a property (or method's) name and value. For example: `'public foo: string'`.
|
|
33
|
-
*/
|
|
34
|
-
getFormattedPropertyName(property: SkyDocsClassPropertyDefinition): string;
|
|
35
|
-
/**
|
|
36
|
-
* Returns an HTML-formatted method name to be used on the properties table.
|
|
37
|
-
*/
|
|
38
|
-
getFormattedMethodName(definition: SkyDocsClassMethodDefinition): string;
|
|
39
|
-
/**
|
|
40
|
-
* Returns a formatted string representing the provided type.
|
|
41
|
-
*/
|
|
42
|
-
getFormattedType(type: SkyDocsTypeDefinition, config?: GetFormattedTypeConfig): string;
|
|
43
|
-
escapeSpecialCharacters(value: string): string;
|
|
44
|
-
private getFormattedCallSignature;
|
|
45
|
-
private getFormattedUnion;
|
|
46
|
-
/**
|
|
47
|
-
* Parse any type arguments e.g. `<T, F>`.
|
|
48
|
-
*/
|
|
49
|
-
private getFormattedTypeArguments;
|
|
50
|
-
private getFormattedTypeParameters;
|
|
51
|
-
private getFormattedInterfaceProperties;
|
|
52
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsFormatService, never>;
|
|
53
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsFormatService>;
|
|
54
|
-
}
|
|
55
|
-
export {};
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import { TypeDocEntry } from './typedoc-types';
|
|
2
|
-
import * as i0 from "@angular/core";
|
|
3
|
-
export declare class SkyDocsTypeDefinitionsProvider {
|
|
4
|
-
readonly anchorIds: {
|
|
5
|
-
[_: string]: string;
|
|
6
|
-
};
|
|
7
|
-
readonly typeDefinitions: TypeDocEntry[];
|
|
8
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsProvider, never>;
|
|
9
|
-
static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsProvider>;
|
|
10
|
-
}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { SkyDocsClassDefinition } from './class-definition';
|
|
2
|
-
import { SkyDocsDirectiveDefinition } from './directive-definition';
|
|
3
|
-
import { SkyDocsEnumerationDefinition } from './enumeration-definition';
|
|
4
|
-
import { SkyDocsInterfaceDefinition } from './interface-definition';
|
|
5
|
-
import { SkyDocsPipeDefinition } from './pipe-definition';
|
|
6
|
-
import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
|
|
7
|
-
/**
|
|
8
|
-
* @internal
|
|
9
|
-
*/
|
|
10
|
-
export interface SkyDocsTypeDefinitions {
|
|
11
|
-
classes: SkyDocsClassDefinition[];
|
|
12
|
-
components: SkyDocsDirectiveDefinition[];
|
|
13
|
-
directives: SkyDocsDirectiveDefinition[];
|
|
14
|
-
enumerations: SkyDocsEnumerationDefinition[];
|
|
15
|
-
hasPreviewFeatures: boolean;
|
|
16
|
-
interfaces: SkyDocsInterfaceDefinition[];
|
|
17
|
-
pipes: SkyDocsPipeDefinition[];
|
|
18
|
-
services: SkyDocsClassDefinition[];
|
|
19
|
-
typeAliases: SkyDocsTypeAliasDefinition[];
|
|
20
|
-
}
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
import * as i0 from "@angular/core";
|
|
2
|
-
import * as i1 from "./call-signature-definition.component";
|
|
3
|
-
import * as i2 from "./class-definition.component";
|
|
4
|
-
import * as i3 from "./directive-definition.component";
|
|
5
|
-
import * as i4 from "./enumeration-definition.component";
|
|
6
|
-
import * as i5 from "./interface-definition.component";
|
|
7
|
-
import * as i6 from "./method-definitions.component";
|
|
8
|
-
import * as i7 from "./pipe-definition.component";
|
|
9
|
-
import * as i8 from "./property-definitions.component";
|
|
10
|
-
import * as i9 from "./type-alias-definition.component";
|
|
11
|
-
import * as i10 from "./type-anchor-links.pipe";
|
|
12
|
-
import * as i11 from "@angular/common";
|
|
13
|
-
import * as i12 from "@angular/router";
|
|
14
|
-
import * as i13 from "@blackbaud/skyux-lib-code-block";
|
|
15
|
-
import * as i14 from "@skyux/layout";
|
|
16
|
-
import * as i15 from "../heading-anchor/heading-anchor.module";
|
|
17
|
-
import * as i16 from "../markdown/markdown.module";
|
|
18
|
-
import * as i17 from "./preview-feature-indicator.component";
|
|
19
|
-
import * as i18 from "../safe-html/safe-html.module";
|
|
20
|
-
import * as i19 from "@skyux/icon";
|
|
21
|
-
import * as i20 from "@skyux/indicators";
|
|
22
|
-
export declare class SkyDocsTypeDefinitionsModule {
|
|
23
|
-
static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsModule, never>;
|
|
24
|
-
static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsTypeDefinitionsModule, [typeof i1.SkyDocsCallSignatureDefinitionComponent, typeof i2.SkyDocsClassDefinitionComponent, typeof i3.SkyDocsDirectiveDefinitionComponent, typeof i4.SkyDocsEnumerationDefinitionComponent, typeof i5.SkyDocsInterfaceDefinitionComponent, typeof i6.SkyDocsMethodDefinitionsComponent, typeof i7.SkyDocsPipeDefinitionComponent, typeof i8.SkyDocsPropertyDefinitionsComponent, typeof i9.SkyDocsTypeAliasDefinitionComponent, typeof i10.SkyDocsTypeAnchorLinksPipe], [typeof i11.CommonModule, typeof i12.RouterModule, typeof i13.SkyCodeBlockModule, typeof i13.SkyCodeModule, typeof i14.SkyDefinitionListModule, typeof i15.SkyDocsHeadingAnchorModule, typeof i16.SkyDocsMarkdownModule, typeof i17.SkyDocsPreviewIndicatorComponent, typeof i18.SkyDocsSafeHtmlModule, typeof i19.SkyIconModule, typeof i20.SkyStatusIndicatorModule], [typeof i1.SkyDocsCallSignatureDefinitionComponent, typeof i2.SkyDocsClassDefinitionComponent, typeof i3.SkyDocsDirectiveDefinitionComponent, typeof i4.SkyDocsEnumerationDefinitionComponent, typeof i5.SkyDocsInterfaceDefinitionComponent, typeof i6.SkyDocsMethodDefinitionsComponent, typeof i7.SkyDocsPipeDefinitionComponent, typeof i8.SkyDocsPropertyDefinitionsComponent, typeof i9.SkyDocsTypeAliasDefinitionComponent, typeof i10.SkyDocsTypeAnchorLinksPipe]>;
|
|
25
|
-
static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsTypeDefinitionsModule>;
|
|
26
|
-
}
|