@skyux/docs-tools 9.1.5 → 9.2.0

package/modules/demo-page/demo-page.component.d.ts

@@ -7,6 +7,7 @@ import { SkyDocsDemoPageDomAdapterService } from './demo-page-dom-adapter.servic
 import { SkyDocsDemoPageTitleService } from './demo-page-title.service';
 import { SkyDocsTypeDefinitionsService } from '../type-definitions/type-definitions.service';
 import { SkyDocsTypeDefinitions } from '../type-definitions/type-definitions';
+import { SkyDocsToolsSiteOptions } from '../shared/docs-tools-site-options';
 import * as i0 from "@angular/core";
 /**
  * The demo page component wraps all documentation components and handles the configuration and layout of the page.
@@ -95,8 +96,10 @@ export declare class SkyDocsDemoPageComponent implements OnInit, AfterContentIni
      * @internal
      */
     sidebarRoutes: StacheNavLink[];
+    protected hasPreviewFeatures: boolean;
     private designGuidelinesComponent;
     private codeExampleComponents;
+    protected readonly siteOptions: SkyDocsToolsSiteOptions | undefined;
     constructor(activatedRoute: ActivatedRoute, changeDetector: ChangeDetectorRef, router: Router, skyAppConfig: SkyAppConfig, domAdapter: SkyDocsDemoPageDomAdapterService, supportalService: SkyDocsSupportalService, titleService: SkyDocsDemoPageTitleService, typeDefinitionService: SkyDocsTypeDefinitionsService);
     ngOnInit(): void;
     ngAfterContentInit(): void;

package/modules/demo-page/demo-page.module.d.ts

@@ -6,16 +6,18 @@ import * as i4 from "./demo-page-summary.component";
 import * as i5 from "./demo-page-type-definitions.component";
 import * as i6 from "@angular/common";
 import * as i7 from "@angular/router";
-import * as i8 from "@blackbaud/skyux-lib-code-block";
-import * as i9 from "../demo/demo.module";
-import * as i10 from "../heading-anchor/heading-anchor.module";
-import * as i11 from "../markdown/markdown.module";
-import * as i12 from "../module-info/module-info.module";
-import * as i13 from "../type-definitions/type-definitions.module";
-import * as i14 from "@skyux/tabs";
-import * as i15 from "@blackbaud/skyux-lib-stache";
+import * as i8 from "@skyux/indicators";
+import * as i9 from "@skyux/router";
+import * as i10 from "@blackbaud/skyux-lib-code-block";
+import * as i11 from "../demo/demo.module";
+import * as i12 from "../heading-anchor/heading-anchor.module";
+import * as i13 from "../markdown/markdown.module";
+import * as i14 from "../module-info/module-info.module";
+import * as i15 from "../type-definitions/type-definitions.module";
+import * as i16 from "@skyux/tabs";
+import * as i17 from "@blackbaud/skyux-lib-stache";
 export declare class SkyDocsDemoPageModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsDemoPageModule, never>;
-    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsDemoPageModule, [typeof i1.SkyDocsDemoPageComponent, typeof i2.SkyDocsDemoPageModuleInfoComponent, typeof i3.SkyDocsDemoPageSectionComponent, typeof i4.SkyDocsDemoPageSummaryComponent, typeof i5.SkyDocsDemoPageTypeDefinitionsComponent], [typeof i6.CommonModule, typeof i7.RouterModule, typeof i8.SkyCodeBlockModule, typeof i8.SkyCodeModule, typeof i9.SkyDocsDemoModule, typeof i10.SkyDocsHeadingAnchorModule, typeof i11.SkyDocsMarkdownModule, typeof i12.SkyDocsModuleInfoModule, typeof i13.SkyDocsTypeDefinitionsModule, typeof i14.SkyTabsModule, typeof i15.StachePageSummaryModule, typeof i15.StacheWrapperModule], [typeof i1.SkyDocsDemoPageComponent, typeof i2.SkyDocsDemoPageModuleInfoComponent, typeof i3.SkyDocsDemoPageSectionComponent, typeof i4.SkyDocsDemoPageSummaryComponent, typeof i5.SkyDocsDemoPageTypeDefinitionsComponent]>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDocsDemoPageModule, [typeof i1.SkyDocsDemoPageComponent, typeof i2.SkyDocsDemoPageModuleInfoComponent, typeof i3.SkyDocsDemoPageSectionComponent, typeof i4.SkyDocsDemoPageSummaryComponent, typeof i5.SkyDocsDemoPageTypeDefinitionsComponent], [typeof i6.CommonModule, typeof i7.RouterModule, typeof i8.SkyAlertModule, typeof i9.SkyAppLinkModule, typeof i10.SkyCodeBlockModule, typeof i10.SkyCodeModule, typeof i11.SkyDocsDemoModule, typeof i12.SkyDocsHeadingAnchorModule, typeof i13.SkyDocsMarkdownModule, typeof i14.SkyDocsModuleInfoModule, typeof i15.SkyDocsTypeDefinitionsModule, typeof i16.SkyTabsModule, typeof i17.StachePageSummaryModule, typeof i17.StacheWrapperModule], [typeof i1.SkyDocsDemoPageComponent, typeof i2.SkyDocsDemoPageModuleInfoComponent, typeof i3.SkyDocsDemoPageSectionComponent, typeof i4.SkyDocsDemoPageSummaryComponent, typeof i5.SkyDocsDemoPageTypeDefinitionsComponent]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsDemoPageModule>;
 }

package/modules/shared/docs-tools-site-options.d.ts

@@ -0,0 +1,3 @@
+export declare class SkyDocsToolsSiteOptions {
+    previewFeaturesUrl: string;
+}

package/modules/type-definitions/class-definition.d.ts

@@ -5,6 +5,7 @@ import { SkyDocsClassMethodDefinition } from './method-definition';
  * Describes classes and services.
  */
 export interface SkyDocsClassDefinition extends SkyDocsEntryDefinition {
+    hasPreviewFeatures: boolean;
     methods?: SkyDocsClassMethodDefinition[];
     properties?: SkyDocsClassPropertyDefinition[];
 }

package/modules/type-definitions/directive-definition.d.ts

@@ -5,6 +5,7 @@ import { SkyDocsEntryDefinition } from './entry-definition';
  */
 export interface SkyDocsDirectiveDefinition extends SkyDocsEntryDefinition {
     eventProperties?: SkyDocsClassPropertyDefinition[];
+    hasPreviewFeatures: boolean;
     inputProperties?: SkyDocsClassPropertyDefinition[];
     selector: string;
 }

package/modules/type-definitions/enumeration-definition.d.ts

@@ -4,5 +4,6 @@ import { SkyDocsEnumerationMemberDefinition } from './enumeration-member-definit
  * Describes enumerations.
  */
 export interface SkyDocsEnumerationDefinition extends SkyDocsEntryDefinition {
+    hasPreviewFeatures: boolean;
     members: SkyDocsEnumerationMemberDefinition[];
 }

package/modules/type-definitions/enumeration-member-definition.d.ts

@@ -6,5 +6,6 @@ export interface SkyDocsEnumerationMemberDefinition {
     codeExampleLanguage?: string;
     deprecationWarning?: string;
     description?: string;
+    isPreview: boolean;
     name: string;
 }

package/modules/type-definitions/interface-definition.d.ts

@@ -5,6 +5,7 @@ import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
  * Describes interfaces.
  */
 export interface SkyDocsInterfaceDefinition extends SkyDocsEntryDefinition {
+    hasPreviewFeatures: boolean;
     properties: SkyDocsInterfacePropertyDefinition[];
     typeParameters?: SkyDocsTypeParameterDefinition[];
 }

package/modules/type-definitions/interface-property-definition.d.ts

@@ -4,4 +4,5 @@ import { SkyDocsEntryChildDefinition } from './entry-child-definition';
  */
 export interface SkyDocsInterfacePropertyDefinition extends SkyDocsEntryChildDefinition {
     isOptional: boolean;
+    isPreview: boolean;
 }

package/modules/type-definitions/method-definition.d.ts

@@ -5,6 +5,7 @@ import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
  */
 export interface SkyDocsClassMethodDefinition extends SkyDocsEntryChildDefinition {
     isStatic?: boolean;
+    isPreview: boolean;
     typeParameters?: SkyDocsTypeParameterDefinition[];
     parentName?: string;
 }

package/modules/type-definitions/method-definitions.component.d.ts

@@ -13,6 +13,7 @@ interface MethodViewModel {
     formattedName: string;
     sourceCode: string;
     isStatic: boolean;
+    isPreview: boolean;
 }
 export declare class SkyDocsMethodDefinitionsComponent implements OnInit {
     #private;

package/modules/type-definitions/preview-feature-indicator.component.d.ts

@@ -0,0 +1,5 @@
+import * as i0 from "@angular/core";
+export declare class SkyDocsPreviewIndicatorComponent {
+    static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsPreviewIndicatorComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SkyDocsPreviewIndicatorComponent, "sky-docs-preview-feature-indicator", never, {}, {}, never, never, true, never>;
+}

package/modules/type-definitions/property-definition.d.ts

@@ -7,4 +7,5 @@ export interface SkyDocsClassPropertyDefinition extends SkyDocsEntryChildDefinit
     decorator?: SkyDocsPropertyDecoratorDefinition;
     defaultValue?: string;
     isOptional: boolean;
+    isPreview: boolean;
 }

package/modules/type-definitions/property-definitions.component.d.ts

@@ -12,6 +12,7 @@ interface PropertyViewModel {
     formattedName: string;
     isOutput: boolean;
     isOptional: boolean;
+    isPreview: boolean;
 }
 export declare class SkyDocsPropertyDefinitionsComponent implements OnInit {
     private changeDetector;

package/modules/type-definitions/type-alias-definition.d.ts

@@ -5,6 +5,7 @@ import { SkyDocsTypeParameterDefinition } from './type-parameter-definition';
  * Describes type aliases.
  */
 export interface SkyDocsTypeAliasDefinition extends SkyDocsEntryDefinition {
+    isPreview: boolean;
     type: SkyDocsTypeDefinition;
     typeParameters?: SkyDocsTypeParameterDefinition[];
 }

package/modules/type-definitions/type-definitions.d.ts

@@ -12,6 +12,7 @@ export interface SkyDocsTypeDefinitions {
     components: SkyDocsDirectiveDefinition[];
     directives: SkyDocsDirectiveDefinition[];
     enumerations: SkyDocsEnumerationDefinition[];
+    hasPreviewFeatures: boolean;
     interfaces: SkyDocsInterfaceDefinition[];
     pipes: SkyDocsPipeDefinition[];
     services: SkyDocsClassDefinition[];

package/modules/type-definitions/type-definitions.module.d.ts

@@ -15,10 +15,11 @@ import * as i13 from "@blackbaud/skyux-lib-code-block";
 import * as i14 from "@skyux/layout";
 import * as i15 from "../heading-anchor/heading-anchor.module";
 import * as i16 from "../markdown/markdown.module";
-import * as i17 from "../safe-html/safe-html.module";
-import * as i18 from "@skyux/indicators";
+import * as i17 from "./preview-feature-indicator.component";
+import * as i18 from "../safe-html/safe-html.module";
+import * as i19 from "@skyux/indicators";
 export declare class SkyDocsTypeDefinitionsModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsModule, never>;
-    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.SkyDocsSafeHtmlModule, typeof i18.SkyIconModule], [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]>;
+    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 i19.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]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<SkyDocsTypeDefinitionsModule>;
 }

package/modules/type-definitions/typedoc-types.d.ts

@@ -9,7 +9,7 @@ export interface TypeDocComment {
             kind: string;
             text: string;
         }[];
-        tag: '@default' | '@defaultValue' | '@deprecated' | '@example' | '@param' | '@required';
+        tag: '@default' | '@defaultValue' | '@deprecated' | '@example' | '@param' | '@preview' | '@required';
     }[];
 }
 export interface TypeDocSource {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyux/docs-tools",
-  "version": "9.1.5",
+  "version": "9.2.0",
   "peerDependencies": {
     "@angular/common": "^16.2.5",
     "@angular/core": "^16.2.5",

package/public-api.d.ts

@@ -13,6 +13,7 @@ export * from './modules/markdown/markdown.pipe';
 export * from './modules/module-info/module-info.module';
 export * from './modules/shared/docs-tools-component-info';
 export * from './modules/shared/docs-tools-options';
+export * from './modules/shared/docs-tools-site-options';
 export * from './modules/shared/docs-tools-supportal.service';
 export * from './modules/source-code/source-code-provider';
 export * from './modules/thumbnail/thumbnail.module';