diff --git a/libs/components/ag-grid/src/lib/modules/ag-grid/ag-grid.module.ts b/libs/components/ag-grid/src/lib/modules/ag-grid/ag-grid.module.ts index d6e21b9bf7..4237f73b48 100644 --- a/libs/components/ag-grid/src/lib/modules/ag-grid/ag-grid.module.ts +++ b/libs/components/ag-grid/src/lib/modules/ag-grid/ag-grid.module.ts @@ -29,6 +29,9 @@ import { SkyAgGridCellValidatorModule } from './cell-validator/ag-grid-cell-vali import { SkyAgGridHeaderGroupComponent } from './header/header-group.component'; import { SkyAgGridHeaderComponent } from './header/header.component'; +/** + * @docsIncludeIds SkyAgGridWrapperComponent, SkyAgGridService, SkyGetGridOptionsArgs, SkyAgGridRowDeleteDirective, SkyAgGridRowDeleteConfirmArgs, SkyAgGridRowDeleteCancelArgs, SkyAgGridCellEditorInitialAction, SkyAgGridCellEditorUtils, SkyCellType, SkyAgGridHeaderInfo, SkyAgGridHeaderParams, SkyAgGridHeaderGroupInfo, SkyAgGridHeaderGroupParams,SkyAgGridAutocompleteProperties, SkyAutocompleteProperties, SkyAgGridCurrencyProperties, SkyAgGridDatepickerProperties, SkyDatepickerProperties, SkyAgGridLookupProperties, SkyAgGridNumberProperties, SkyAgGridTextProperties, SkyAgGridValidatorProperties + */ @NgModule({ declarations: [ SkyAgGridDataManagerAdapterDirective, diff --git a/libs/components/core/src/lib/modules/dock/dock.module.ts b/libs/components/core/src/lib/modules/dock/dock.module.ts index 03a569c039..6353299fec 100644 --- a/libs/components/core/src/lib/modules/dock/dock.module.ts +++ b/libs/components/core/src/lib/modules/dock/dock.module.ts @@ -2,6 +2,7 @@ import { NgModule } from '@angular/core'; /** * @deprecated The `SkyDockModule` is no longer needed and can be removed from your application. + * @internal */ @NgModule({}) export class SkyDockModule {} diff --git a/libs/components/core/src/lib/modules/overlay/overlay.module.ts b/libs/components/core/src/lib/modules/overlay/overlay.module.ts index 56fef16627..a9cd1b5263 100644 --- a/libs/components/core/src/lib/modules/overlay/overlay.module.ts +++ b/libs/components/core/src/lib/modules/overlay/overlay.module.ts @@ -2,6 +2,7 @@ import { NgModule } from '@angular/core'; /** * @deprecated The `SkyOverlayModule` is no longer needed and can be removed from your application. + * @internal */ @NgModule({}) export class SkyOverlayModule {} diff --git a/libs/components/data-manager/src/lib/modules/data-manager/data-manager.module.ts b/libs/components/data-manager/src/lib/modules/data-manager/data-manager.module.ts index ff2da4b95a..3b14d4aae7 100644 --- a/libs/components/data-manager/src/lib/modules/data-manager/data-manager.module.ts +++ b/libs/components/data-manager/src/lib/modules/data-manager/data-manager.module.ts @@ -9,6 +9,9 @@ import { SkyDataManagerToolbarComponent } from './data-manager-toolbar/data-mana import { SkyDataManagerComponent } from './data-manager.component'; import { SkyDataViewComponent } from './data-view.component'; +/** + * @docsIncludeIds SkyDataManagerComponent, SkyDataManagerService, SkyDataManagerToolbarComponent, SkyDataManagerToolbarSectionComponent, SkyDataManagerToolbarPrimaryItemComponent, SkyDataManagerToolbarLeftItemComponent, SkyDataManagerToolbarRightItemComponent, SkyDataViewComponent, SkyDataViewConfig, SkyDataViewColumnWidths, SkyDataViewState, SkyDataViewStateOptions, SkyDataManagerConfig, SkyDataManagerFilterData, SkyDataManagerInitArgs, SkyDataManagerSortOption, SkyDataManagerState, SkyDataManagerStateOptions, SkyDataManagerStateUpdateFilterArgs, SkyDataManagerColumnPickerOption, SkyDataManagerColumnPickerSortStrategy, SkyDataManagerFilterModalContext, + */ @NgModule({ imports: [ SkyDataManagerComponent, diff --git a/libs/components/grids/src/lib/modules/grid/grid.module.ts b/libs/components/grids/src/lib/modules/grid/grid.module.ts index d5b4a20704..2c74e5177f 100644 --- a/libs/components/grids/src/lib/modules/grid/grid.module.ts +++ b/libs/components/grids/src/lib/modules/grid/grid.module.ts @@ -18,6 +18,7 @@ import { SkyGridColumnComponent } from './grid-column.component'; import { SkyGridComponent } from './grid.component'; /** + * @docsIncludeIds SkyGridComponent, SkyGridColumnComponent, SkyGridColumnAlignment, SkyGridColumnWidthModelChange, SkyGridSelectedRowsModelChange, SkyGridMessage, SkyGridMessageType * @deprecated `SkyGridComponent` and its features are deprecated. We recommend using the data grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-grid */ @NgModule({ diff --git a/libs/components/help-inline/src/lib/modules/help-inline/help-inline.module.ts b/libs/components/help-inline/src/lib/modules/help-inline/help-inline.module.ts index 3390a072a0..e347036175 100644 --- a/libs/components/help-inline/src/lib/modules/help-inline/help-inline.module.ts +++ b/libs/components/help-inline/src/lib/modules/help-inline/help-inline.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyHelpInlineComponent } from './help-inline.component'; +/** + * @docsIncludeIds SkyHelpInlineComponent, SkyHelpInlineHarness, SkyHelpInlineHarnessFilters + */ @NgModule({ imports: [SkyHelpInlineComponent], exports: [SkyHelpInlineComponent], diff --git a/libs/components/i18n/src/lib/modules/i18n/i18n.module.ts b/libs/components/i18n/src/lib/modules/i18n/i18n.module.ts index bf31b83adf..2a06a3b900 100644 --- a/libs/components/i18n/src/lib/modules/i18n/i18n.module.ts +++ b/libs/components/i18n/src/lib/modules/i18n/i18n.module.ts @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core'; import { SkyLibResourcesPipe } from './lib-resources.pipe'; import { SkyAppResourcesPipe } from './resources.pipe'; +/** + * @docsIncludeIds SkyAppResourcesPipe, SkyAppResourcesService, SkyAppResources, SkyLibResourcesPipe, SkyLibResourcesService, SkyLibResources, SkyAppLocaleInfo, SkyAppLocaleProvider, SkyAppResourceNameProvider, SkyI18nCurrencyFormatService, SkyIntlDateFormatter, SkyIntlNumberFormatter, SkyI18nCurrencyFormat, SkyI18nCurrencySymbolLocation, SkyIntlNumberFormatStyle + */ @NgModule({ declarations: [SkyAppResourcesPipe, SkyLibResourcesPipe], exports: [SkyAppResourcesPipe, SkyLibResourcesPipe], diff --git a/libs/components/i18n/src/lib/modules/i18n/lib-resources-provider.ts b/libs/components/i18n/src/lib/modules/i18n/lib-resources-provider.ts index 6dfe682347..4510ef03a3 100644 --- a/libs/components/i18n/src/lib/modules/i18n/lib-resources-provider.ts +++ b/libs/components/i18n/src/lib/modules/i18n/lib-resources-provider.ts @@ -5,6 +5,7 @@ import { SkyAppLocaleInfo } from './locale-info'; /** * @deprecated `SkyLibResourcesProvider` is no longer needed and will be removed in a future major version of SKY UX. + * @internal */ export abstract class SkyLibResourcesProvider { public abstract getString: ( diff --git a/libs/components/i18n/src/lib/modules/i18n/lib-resources-providers-token.ts b/libs/components/i18n/src/lib/modules/i18n/lib-resources-providers-token.ts index b53b812d75..3d95baafb3 100644 --- a/libs/components/i18n/src/lib/modules/i18n/lib-resources-providers-token.ts +++ b/libs/components/i18n/src/lib/modules/i18n/lib-resources-providers-token.ts @@ -7,6 +7,7 @@ import { SkyLibResourcesProvider } from './lib-resources-provider'; /** * @deprecated `SKY_LIB_RESOURCES_PROVIDERS` is no longer needed and will be removed in a future major version of SKY UX. + * @internal */ export const SKY_LIB_RESOURCES_PROVIDERS = new InjectionToken< SkyLibResourcesProvider[] diff --git a/libs/components/icon/src/lib/modules/icon/icon.module.ts b/libs/components/icon/src/lib/modules/icon/icon.module.ts index b9fe683646..6614396c0b 100644 --- a/libs/components/icon/src/lib/modules/icon/icon.module.ts +++ b/libs/components/icon/src/lib/modules/icon/icon.module.ts @@ -6,6 +6,9 @@ import { SkyIconStackComponent } from './icon-stack.component'; import { SkyIconSvgComponent } from './icon-svg.component'; import { SkyIconComponent } from './icon.component'; +/** + * @docsIncludeIds SkyIconComponent, SkyIconType, SkyIconVariantType, SkyIconHarness, SkyIconHarnessFilters + */ @NgModule({ declarations: [SkyIconClassListPipe, SkyIconComponent, SkyIconStackComponent], imports: [CommonModule, SkyIconSvgComponent], diff --git a/libs/components/indicators/src/lib/modules/alert/alert.module.ts b/libs/components/indicators/src/lib/modules/alert/alert.module.ts index 6df355a544..602ef3c08b 100644 --- a/libs/components/indicators/src/lib/modules/alert/alert.module.ts +++ b/libs/components/indicators/src/lib/modules/alert/alert.module.ts @@ -7,6 +7,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources import { SkyAlertComponent } from './alert.component'; +/** + * @docsIncludeIds SkyAlertComponent, SkyAlertHarness, SkyAlertHarnessFilters + */ @NgModule({ declarations: [SkyAlertComponent], imports: [ diff --git a/libs/components/indicators/src/lib/modules/chevron/chevron.module.ts b/libs/components/indicators/src/lib/modules/chevron/chevron.module.ts index 52222eb35b..c08ec7792e 100644 --- a/libs/components/indicators/src/lib/modules/chevron/chevron.module.ts +++ b/libs/components/indicators/src/lib/modules/chevron/chevron.module.ts @@ -7,6 +7,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources import { SkyChevronComponent } from './chevron.component'; +/** + * @internal + */ @NgModule({ declarations: [SkyChevronComponent], imports: [ diff --git a/libs/components/indicators/src/lib/modules/illustration/illustration.module.ts b/libs/components/indicators/src/lib/modules/illustration/illustration.module.ts index 8d09124169..18bd0d1562 100644 --- a/libs/components/indicators/src/lib/modules/illustration/illustration.module.ts +++ b/libs/components/indicators/src/lib/modules/illustration/illustration.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyIllustrationComponent } from './illustration.component'; +/** + * @docsIncludeIds SkyIllustrationComponent, SkyIllustrationResolverService, SkyIllustrationSize, SkyIllustrationHarness, SkyIllustrationHarnessFilters + */ @NgModule({ imports: [SkyIllustrationComponent], exports: [SkyIllustrationComponent], diff --git a/libs/components/indicators/src/lib/modules/key-info/key-info.module.ts b/libs/components/indicators/src/lib/modules/key-info/key-info.module.ts index c0ddf5abe6..7058ce2e88 100644 --- a/libs/components/indicators/src/lib/modules/key-info/key-info.module.ts +++ b/libs/components/indicators/src/lib/modules/key-info/key-info.module.ts @@ -7,6 +7,9 @@ import { SkyKeyInfoLabelComponent } from './key-info-label.component'; import { SkyKeyInfoValueComponent } from './key-info-value.component'; import { SkyKeyInfoComponent } from './key-info.component'; +/** + * @docsIncludeIds SkyKeyInfoComponent, SkyKeyInfoLabelComponent, SkyKeyInfoValueComponent, SkyKeyInfoLayoutType, SkyKeyInfoHarness, SkyKeyInfoHarnessFilters + */ @NgModule({ declarations: [ SkyKeyInfoComponent, diff --git a/libs/components/indicators/src/lib/modules/label/label.module.ts b/libs/components/indicators/src/lib/modules/label/label.module.ts index 6715894897..f989677049 100644 --- a/libs/components/indicators/src/lib/modules/label/label.module.ts +++ b/libs/components/indicators/src/lib/modules/label/label.module.ts @@ -6,6 +6,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources import { SkyLabelComponent } from './label.component'; +/** + * @docsIncludeIds SkyLabelComponent, SkyLabelType, SkyLabelHarness, SkyLabelHarnessFilters + */ @NgModule({ declarations: [SkyLabelComponent], imports: [CommonModule, SkyIconModule, SkyIndicatorsResourcesModule], diff --git a/libs/components/indicators/src/lib/modules/status-indicator/status-indicator.module.ts b/libs/components/indicators/src/lib/modules/status-indicator/status-indicator.module.ts index 4cd4cc9832..80e2197166 100644 --- a/libs/components/indicators/src/lib/modules/status-indicator/status-indicator.module.ts +++ b/libs/components/indicators/src/lib/modules/status-indicator/status-indicator.module.ts @@ -8,6 +8,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources import { SkyStatusIndicatorComponent } from './status-indicator.component'; +/** + * @docsIncludeIds SkyStatusIndicatorComponent, SkyStatusIndicatorHarness, SkyStatusIndicatorHarnessFilters + */ @NgModule({ declarations: [SkyStatusIndicatorComponent], imports: [ diff --git a/libs/components/indicators/src/lib/modules/text-highlight/text-highlight.module.ts b/libs/components/indicators/src/lib/modules/text-highlight/text-highlight.module.ts index 7664d76464..2ec9f5a868 100644 --- a/libs/components/indicators/src/lib/modules/text-highlight/text-highlight.module.ts +++ b/libs/components/indicators/src/lib/modules/text-highlight/text-highlight.module.ts @@ -3,6 +3,9 @@ import { SkyMutationObserverService } from '@skyux/core'; import { SkyTextHighlightDirective } from './text-highlight.directive'; +/** + * @docsIncludeIds SkyTextHighlightDirective + */ @NgModule({ imports: [SkyTextHighlightDirective], exports: [SkyTextHighlightDirective], diff --git a/libs/components/indicators/src/lib/modules/tokens/tokens.module.ts b/libs/components/indicators/src/lib/modules/tokens/tokens.module.ts index d49534b70e..d889d452d6 100644 --- a/libs/components/indicators/src/lib/modules/tokens/tokens.module.ts +++ b/libs/components/indicators/src/lib/modules/tokens/tokens.module.ts @@ -8,6 +8,9 @@ import { SkyIndicatorsResourcesModule } from '../shared/sky-indicators-resources import { SkyTokenComponent } from './token.component'; import { SkyTokensComponent } from './tokens.component'; +/** + * @docsIncludeIds SkyTokensComponent, SkyTokenComponent, SkyToken, SkyTokenSelectedEventArgs, SkyTokensMessage, SkyTokensMessageType, SkyTokensHarness, SkyTokenHarness + */ @NgModule({ declarations: [SkyTokenComponent, SkyTokensComponent], imports: [ diff --git a/libs/components/indicators/src/lib/modules/wait/wait.module.ts b/libs/components/indicators/src/lib/modules/wait/wait.module.ts index 69a3063ff8..b5e9633b96 100644 --- a/libs/components/indicators/src/lib/modules/wait/wait.module.ts +++ b/libs/components/indicators/src/lib/modules/wait/wait.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyWaitComponent } from './wait.component'; +/** + * @docsIncludeIds SkyWaitComponent, SkyWaitService, SkyWaitHarness, SkyWaitHarnessFilters + */ @NgModule({ imports: [SkyWaitComponent], exports: [SkyWaitComponent], diff --git a/libs/components/indicators/testing/src/modules/chevron/chevron-harness.ts b/libs/components/indicators/testing/src/modules/chevron/chevron-harness.ts index 8d43b1d337..544709c213 100644 --- a/libs/components/indicators/testing/src/modules/chevron/chevron-harness.ts +++ b/libs/components/indicators/testing/src/modules/chevron/chevron-harness.ts @@ -2,6 +2,7 @@ import { SkyComponentHarness } from '@skyux/core/testing'; /** * Harness for interacting with a chevron component in tests. + * @internal */ export class SkyChevronHarness extends SkyComponentHarness { /** diff --git a/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness-filters.ts b/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness-filters.ts index 3f6eecd1d3..211ed45107 100644 --- a/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness-filters.ts +++ b/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness-filters.ts @@ -2,6 +2,8 @@ import { SkyHarnessFilters } from '@skyux/core/testing'; /** * A set of criteria that can be used to filter a list of SkyHelpInlineHarness instances. + * @docsId SkyHelpInlineHarnessFiltersLegacy + * @deprecated Use the `SkyHelpInlineHarnessFilters` from `@skyux/help-inline/testing` instead. */ // eslint-disable-next-line @typescript-eslint/no-empty-interface, @typescript-eslint/no-empty-object-type export interface SkyHelpInlineHarnessFilters extends SkyHarnessFilters {} diff --git a/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness.ts b/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness.ts index c6e2e2f263..9c701b7ce3 100644 --- a/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness.ts +++ b/libs/components/indicators/testing/src/modules/help-inline/help-inline-harness.ts @@ -5,8 +5,9 @@ import { SkyHelpInlineHarnessFilters } from './help-inline-harness-filters'; /** * Harness for interacting with a help inline component in tests. + * @docsId SkyHelpInlineHarnessLegacy + * @deprecated Use the `SkyHelpInlineHarness` from `@skyux/help-inline/testing` instead. */ - export class SkyHelpInlineHarness extends SkyComponentHarness { /** * @internal diff --git a/libs/components/inline-form/src/lib/modules/inline-form/inline-form.module.ts b/libs/components/inline-form/src/lib/modules/inline-form/inline-form.module.ts index 57454d62e1..8ec466423b 100644 --- a/libs/components/inline-form/src/lib/modules/inline-form/inline-form.module.ts +++ b/libs/components/inline-form/src/lib/modules/inline-form/inline-form.module.ts @@ -5,6 +5,9 @@ import { SkyInlineFormResourcesModule } from '../shared/sky-inline-form-resource import { SkyInlineFormComponent } from './inline-form.component'; +/** + * @docsIncludeIds SkyInlineFormComponent, SkyInlineFormConfig, SkyInlineFormButtonConfig, SkyInlineFormButtonLayout, SkyInlineFormCloseArgs + */ @NgModule({ declarations: [SkyInlineFormComponent], imports: [CommonModule, SkyInlineFormResourcesModule], diff --git a/libs/components/layout/src/lib/modules/action-button/action-button.module.ts b/libs/components/layout/src/lib/modules/action-button/action-button.module.ts index b505c16050..fa4a6735ff 100644 --- a/libs/components/layout/src/lib/modules/action-button/action-button.module.ts +++ b/libs/components/layout/src/lib/modules/action-button/action-button.module.ts @@ -11,6 +11,9 @@ import { SkyActionButtonHeaderComponent } from './action-button-header.component import { SkyActionButtonIconComponent } from './action-button-icon.component'; import { SkyActionButtonComponent } from './action-button.component'; +/** + * @docsIncludeIds SkyActionButtonContainerComponent, SkyActionButtonComponent, SkyActionButtonIconComponent, SkyActionButtonHeaderComponent, SkyActionButtonDetailsComponent, SkyActionButtonPermalink, SkyActionButtonContainerAlignItemsType + */ @NgModule({ declarations: [ SkyActionButtonComponent, diff --git a/libs/components/layout/src/lib/modules/back-to-top/back-to-top.module.ts b/libs/components/layout/src/lib/modules/back-to-top/back-to-top.module.ts index b12888e3e0..dc81b55bac 100644 --- a/libs/components/layout/src/lib/modules/back-to-top/back-to-top.module.ts +++ b/libs/components/layout/src/lib/modules/back-to-top/back-to-top.module.ts @@ -6,6 +6,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module' import { SkyBackToTopComponent } from './back-to-top.component'; import { SkyBackToTopDirective } from './back-to-top.directive'; +/** + * @docsIncludeIds SkyBackToTopDirective, SkyBackToTopOptions, SkyBackToTopMessage, SkyBackToTopMessageType + */ @NgModule({ declarations: [SkyBackToTopComponent, SkyBackToTopDirective], imports: [SkyLayoutResourcesModule, SkyThemeModule], diff --git a/libs/components/layout/src/lib/modules/box/box.module.ts b/libs/components/layout/src/lib/modules/box/box.module.ts index 196c0ce43a..d636da2f56 100644 --- a/libs/components/layout/src/lib/modules/box/box.module.ts +++ b/libs/components/layout/src/lib/modules/box/box.module.ts @@ -8,6 +8,9 @@ import { SkyBoxControlsComponent } from './box-controls.component'; import { SkyBoxHeaderComponent } from './box-header.component'; import { SkyBoxComponent } from './box.component'; +/** + * @docsIncludeIds SkyBoxComponent, SkyBoxHeaderComponent, SkyBoxContentComponent, SkyBoxControlsComponent, SkyBoxHeadingLevel, SkyBoxHeadingStyle, SkyBoxHarness, SkyBoxHarnessFilters + */ @NgModule({ declarations: [ SkyBoxComponent, diff --git a/libs/components/layout/src/lib/modules/card/card.module.ts b/libs/components/layout/src/lib/modules/card/card.module.ts index 5ddb9da76c..7d5ea89ca2 100644 --- a/libs/components/layout/src/lib/modules/card/card.module.ts +++ b/libs/components/layout/src/lib/modules/card/card.module.ts @@ -13,6 +13,7 @@ import { SkyCardComponent } from './card.component'; /** * @deprecated `SkyCardModule` is deprecated. For other SKY UX components that group and list content, see the content containers guidelines. For more information, see https://developer.blackbaud.com/skyux/design/guidelines/content-containers. + * @docsIncludeIds SkyCardComponent, SkyCardTitleComponent, SkyCardContentComponent, SkyCardActionsComponent */ @NgModule({ declarations: [ diff --git a/libs/components/layout/src/lib/modules/definition-list/definition-list.module.ts b/libs/components/layout/src/lib/modules/definition-list/definition-list.module.ts index 3eecaaddb7..11be86290f 100644 --- a/libs/components/layout/src/lib/modules/definition-list/definition-list.module.ts +++ b/libs/components/layout/src/lib/modules/definition-list/definition-list.module.ts @@ -10,6 +10,7 @@ import { SkyDefinitionListValueComponent } from './definition-list-value.compone import { SkyDefinitionListComponent } from './definition-list.component'; /** + * @docsIncludeIds SkyDefinitionListComponent, SkyDefinitionListHeadingComponent, SkyDefinitionListContentComponent, SkyDefinitionListLabelComponent, SkyDefinitionListValueComponent * @deprecated Use `SkyDescriptionListModule` instead. */ @NgModule({ diff --git a/libs/components/layout/src/lib/modules/description-list/description-list.module.ts b/libs/components/layout/src/lib/modules/description-list/description-list.module.ts index df90912af6..2679edbe6c 100644 --- a/libs/components/layout/src/lib/modules/description-list/description-list.module.ts +++ b/libs/components/layout/src/lib/modules/description-list/description-list.module.ts @@ -11,6 +11,9 @@ import { SkyDescriptionListDescriptionComponent } from './description-list-descr import { SkyDescriptionListTermComponent } from './description-list-term.component'; import { SkyDescriptionListComponent } from './description-list.component'; +/** + * @docsIncludeIds SkyDescriptionListComponent, SkyDescriptionListContentComponent, SkyDescriptionListDescriptionComponent, SkyDescriptionListTermComponent, SkyDescriptionListModeType + */ @NgModule({ declarations: [ SkyDescriptionListComponent, diff --git a/libs/components/layout/src/lib/modules/fluid-grid/fluid-grid.module.ts b/libs/components/layout/src/lib/modules/fluid-grid/fluid-grid.module.ts index ee71ba3cc5..c4e35f4566 100644 --- a/libs/components/layout/src/lib/modules/fluid-grid/fluid-grid.module.ts +++ b/libs/components/layout/src/lib/modules/fluid-grid/fluid-grid.module.ts @@ -5,6 +5,9 @@ import { SkyColumnComponent } from './column.component'; import { SkyFluidGridComponent } from './fluid-grid.component'; import { SkyRowComponent } from './row.component'; +/** + * @docsIncludeIds SkyFluidGridComponent, SkyRowComponent, SkyColumnComponent, SkyFluidGridGutterSizeType, SkyColumnHarness, SkyColumnHarnessFilters, SkyFluidGridHarness, SkyFluidGridHarnessFilters, SkyRowHarness, SkyRowHarnessFilters + */ @NgModule({ imports: [CommonModule], declarations: [SkyRowComponent, SkyColumnComponent, SkyFluidGridComponent], diff --git a/libs/components/layout/src/lib/modules/format/format.module.ts b/libs/components/layout/src/lib/modules/format/format.module.ts index 21d7776f1d..77f406b690 100644 --- a/libs/components/layout/src/lib/modules/format/format.module.ts +++ b/libs/components/layout/src/lib/modules/format/format.module.ts @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core'; import { SkyFormatComponent } from './format.component'; +/** + * @docsIncludeIds SkyFormatComponent, SkyAppFormat + */ @NgModule({ declarations: [SkyFormatComponent], imports: [CommonModule], diff --git a/libs/components/layout/src/lib/modules/inline-delete/inline-delete.module.ts b/libs/components/layout/src/lib/modules/inline-delete/inline-delete.module.ts index 3b4fb4a7d5..b7dd97fa42 100644 --- a/libs/components/layout/src/lib/modules/inline-delete/inline-delete.module.ts +++ b/libs/components/layout/src/lib/modules/inline-delete/inline-delete.module.ts @@ -5,6 +5,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module' import { SkyInlineDeleteComponent } from './inline-delete.component'; +/** + * @docsIncludeIds SkyInlineDeleteComponent + */ @NgModule({ declarations: [SkyInlineDeleteComponent], imports: [SkyLayoutResourcesModule, SkyWaitModule], diff --git a/libs/components/layout/src/lib/modules/page-summary/page-summary.module.ts b/libs/components/layout/src/lib/modules/page-summary/page-summary.module.ts index b13ed7afd5..e434daab19 100644 --- a/libs/components/layout/src/lib/modules/page-summary/page-summary.module.ts +++ b/libs/components/layout/src/lib/modules/page-summary/page-summary.module.ts @@ -11,6 +11,7 @@ import { SkyPageSummaryTitleComponent } from './page-summary-title.component'; import { SkyPageSummaryComponent } from './page-summary.component'; /** + * @docsIncludeIds SkyPageSummaryComponent, SkyPageSummaryTitleComponent, SkyPageSummarySubtitleComponent, SkyPageSummaryAlertComponent, SkyPageSummaryContentComponent, SkyPageSummaryImageComponent, SkyPageSummaryKeyInfoComponent, SkyPageSummaryStatusComponent * @deprecated `SkyPageSummaryModule` is deprecated. For page templates and techniques to summarize page content, see the page design guidelines. For more information, see https://developer.blackbaud.com/skyux/design/guidelines/page-layouts. */ @NgModule({ diff --git a/libs/components/layout/src/lib/modules/page/page-layout-type.ts b/libs/components/layout/src/lib/modules/page/page-layout-type.ts index 2d9fa48ba3..27ff8e2f78 100644 --- a/libs/components/layout/src/lib/modules/page/page-layout-type.ts +++ b/libs/components/layout/src/lib/modules/page/page-layout-type.ts @@ -1,4 +1,5 @@ /** + * @docsId SkyPageLayoutLegacy * @deprecated Use `SkyPageLayoutType` in `@skyux/pages` instead. */ export type SkyPageLayoutType = 'auto' | 'fit'; diff --git a/libs/components/layout/src/lib/modules/page/page.component.ts b/libs/components/layout/src/lib/modules/page/page.component.ts index ed8b715686..b2027a71ea 100644 --- a/libs/components/layout/src/lib/modules/page/page.component.ts +++ b/libs/components/layout/src/lib/modules/page/page.component.ts @@ -6,6 +6,7 @@ import { SkyPageThemeAdapterService } from './page-theme-adapter.service'; /** * Displays page contents using the specified layout. + * @docsId SkyPageComponentLegacy * @deprecated Use the `sky-page` component in `@skyux/pages` instead. */ @Component({ diff --git a/libs/components/layout/src/lib/modules/page/page.module.ts b/libs/components/layout/src/lib/modules/page/page.module.ts index babce1eda2..011bf5c222 100644 --- a/libs/components/layout/src/lib/modules/page/page.module.ts +++ b/libs/components/layout/src/lib/modules/page/page.module.ts @@ -4,6 +4,8 @@ import { NgModule } from '@angular/core'; import { SkyPageComponent } from './page.component'; /** + * @docsId SkyPageModuleLegacy + * @docsIncludeIds SkyPageComponentLegacy, SkyPageLayoutLegacy * @deprecated Use the SkyPageModule in `@skyux/pages` instead. */ @NgModule({ diff --git a/libs/components/layout/src/lib/modules/text-expand-repeater/text-expand-repeater.module.ts b/libs/components/layout/src/lib/modules/text-expand-repeater/text-expand-repeater.module.ts index 75b9729726..9c2ee99927 100644 --- a/libs/components/layout/src/lib/modules/text-expand-repeater/text-expand-repeater.module.ts +++ b/libs/components/layout/src/lib/modules/text-expand-repeater/text-expand-repeater.module.ts @@ -5,6 +5,9 @@ import { SkyLayoutResourcesModule } from '../shared/sky-layout-resources.module' import { SkyTextExpandRepeaterComponent } from './text-expand-repeater.component'; +/** + * @docsIncludeIds SkyTextExpandRepeaterComponent, SkyTextExpandRepeaterListStyleType + */ @NgModule({ declarations: [SkyTextExpandRepeaterComponent], imports: [SkyLayoutResourcesModule, CommonModule], diff --git a/libs/components/layout/src/lib/modules/text-expand/text-expand.module.ts b/libs/components/layout/src/lib/modules/text-expand/text-expand.module.ts index 8fcf520adb..367a6d4392 100644 --- a/libs/components/layout/src/lib/modules/text-expand/text-expand.module.ts +++ b/libs/components/layout/src/lib/modules/text-expand/text-expand.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyTextExpandComponent } from './text-expand.component'; +/** + * @docsIncludeIds SkyTextExpandComponent, SkyTextExpandHarness, SkyTextExpandModalHarness + */ @NgModule({ declarations: [SkyTextExpandComponent], exports: [SkyTextExpandComponent], diff --git a/libs/components/layout/src/lib/modules/toolbar/toolbar.module.ts b/libs/components/layout/src/lib/modules/toolbar/toolbar.module.ts index 2d6e4d6d43..90a9285a4a 100644 --- a/libs/components/layout/src/lib/modules/toolbar/toolbar.module.ts +++ b/libs/components/layout/src/lib/modules/toolbar/toolbar.module.ts @@ -6,6 +6,9 @@ import { SkyToolbarSectionComponent } from './toolbar-section.component'; import { SkyToolbarViewActionsComponent } from './toolbar-view-actions.component'; import { SkyToolbarComponent } from './toolbar.component'; +/** + * @docsIncludeIds SkyToolbarComponent, SkyToolbarSectionComponent, SkyToolbarItemComponent, SkyToolbarViewActionsComponent, SkyToolbarHarness, SkyToolbarHarnessFilters, SkyToolbarSectionHarness, SkyToolbarSectionHarnessFilters, SkyToolbarItemHarness, SkyToolbarItemHarnessFilters, SkyToolbarViewActionsHarness + */ @NgModule({ declarations: [ SkyToolbarComponent, diff --git a/libs/components/list-builder-view-checklist/src/lib/modules/list-view-checklist/list-view-checklist.module.ts b/libs/components/list-builder-view-checklist/src/lib/modules/list-view-checklist/list-view-checklist.module.ts index bbaf8ae3bf..a2922660ab 100644 --- a/libs/components/list-builder-view-checklist/src/lib/modules/list-view-checklist/list-view-checklist.module.ts +++ b/libs/components/list-builder-view-checklist/src/lib/modules/list-view-checklist/list-view-checklist.module.ts @@ -7,6 +7,7 @@ import { SkyListViewChecklistItemComponent } from './list-view-checklist-item.co import { SkyListViewChecklistComponent } from './list-view-checklist.component'; /** + * @docsIncludeIds SkyListViewChecklistComponent, SkyListViewChecklistItemComponent, ChecklistStateAction, ChecklistStateModel, ChecklistStateDispatcher, ChecklistStateOrchestrator, ChecklistState, ListViewChecklistItemModel, ListViewChecklistItemsOrchestrator, ListViewChecklistItemsLoadAction * @deprecated List builder view checklist and its features are deprecated. Use repeater instead. For more information, see https://developer.blackbaud.com/skyux/components/repeater. */ @NgModule({ diff --git a/libs/components/list-builder-view-grids/src/lib/modules/column-selector/column-selector-modal.module.ts b/libs/components/list-builder-view-grids/src/lib/modules/column-selector/column-selector-modal.module.ts index 51b2a0b918..a5ba8180eb 100644 --- a/libs/components/list-builder-view-grids/src/lib/modules/column-selector/column-selector-modal.module.ts +++ b/libs/components/list-builder-view-grids/src/lib/modules/column-selector/column-selector-modal.module.ts @@ -9,6 +9,7 @@ import { SkyListBuilderViewGridsResourcesModule } from '../shared/sky-list-build import { SkyColumnSelectorComponent } from './column-selector-modal.component'; /** + * @docsIncludeIds SkyColumnSelectorContext, SkyColumnSelectorModel * @deprecated List builder view grid and its features are deprecated. Use data entry grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-entry-grid. */ @NgModule({ diff --git a/libs/components/list-builder-view-grids/src/lib/modules/list-column-selector-action/list-column-selector-action.module.ts b/libs/components/list-builder-view-grids/src/lib/modules/list-column-selector-action/list-column-selector-action.module.ts index 4c3dfc4921..5b4eabd96e 100644 --- a/libs/components/list-builder-view-grids/src/lib/modules/list-column-selector-action/list-column-selector-action.module.ts +++ b/libs/components/list-builder-view-grids/src/lib/modules/list-column-selector-action/list-column-selector-action.module.ts @@ -14,6 +14,7 @@ import { SkyListColumnSelectorActionComponent } from './list-column-selector-act import { SkyListColumnSelectorButtonComponent } from './list-column-selector-button.component'; /** + * @docsIncludeIds SkyListColumnSelectorActionComponent * @deprecated List builder view grid and its features are deprecated. Use data entry grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-entry-grid. */ @NgModule({ diff --git a/libs/components/list-builder-view-grids/src/lib/modules/list-view-grid/list-view-grid.module.ts b/libs/components/list-builder-view-grids/src/lib/modules/list-view-grid/list-view-grid.module.ts index 18b2bfc64d..5c2d02acb0 100644 --- a/libs/components/list-builder-view-grids/src/lib/modules/list-view-grid/list-view-grid.module.ts +++ b/libs/components/list-builder-view-grids/src/lib/modules/list-view-grid/list-view-grid.module.ts @@ -9,6 +9,7 @@ import { SkyListBuilderViewGridsResourcesModule } from '../shared/sky-list-build import { SkyListViewGridComponent } from './list-view-grid.component'; /** + * @docsIncludeIds SkyListViewGridComponent, SkyListViewGridMessageType, SkyListViewGridMessage, SkyListViewGridRowDeleteCancelArgs, SkyListViewGridRowDeleteConfirmArgs * @deprecated List builder view grid and its features are deprecated. Use data entry grid instead. For more information, see https://developer.blackbaud.com/skyux/components/data-entry-grid. */ @NgModule({ diff --git a/libs/components/list-builder/src/lib/modules/list-filters/list-filters.module.ts b/libs/components/list-builder/src/lib/modules/list-filters/list-filters.module.ts index 032713f874..4e9e1ca6a6 100644 --- a/libs/components/list-builder/src/lib/modules/list-filters/list-filters.module.ts +++ b/libs/components/list-builder/src/lib/modules/list-filters/list-filters.module.ts @@ -9,6 +9,7 @@ import { SkyListFilterInlineComponent } from './list-filter-inline.component'; import { SkyListFilterSummaryComponent } from './list-filter-summary.component'; /** + * @docsIncludeIds SkyListFilterInlineComponent, SkyListFilterInlineItemComponent, SkyListFilterSummaryComponent, SkyListFilterButtonComponent, ListFilterModel * @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager. */ @NgModule({ diff --git a/libs/components/list-builder/src/lib/modules/list-paging/list-paging.module.ts b/libs/components/list-builder/src/lib/modules/list-paging/list-paging.module.ts index 9a03692c67..6a6e5705ef 100644 --- a/libs/components/list-builder/src/lib/modules/list-paging/list-paging.module.ts +++ b/libs/components/list-builder/src/lib/modules/list-paging/list-paging.module.ts @@ -5,6 +5,7 @@ import { SkyPagingModule } from '@skyux/lists'; import { SkyListPagingComponent } from './list-paging.component'; /** + * @docsIncludeIds SkyListPagingComponent * @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager. */ @NgModule({ diff --git a/libs/components/list-builder/src/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.module.ts b/libs/components/list-builder/src/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.module.ts index 39dca75693..0c0856cbd2 100644 --- a/libs/components/list-builder/src/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.module.ts +++ b/libs/components/list-builder/src/lib/modules/list-toolbar/list-secondary-actions/list-secondary-actions.module.ts @@ -10,6 +10,7 @@ import { SkyListSecondaryActionsHostComponent } from './list-secondary-actions-h import { SkyListSecondaryActionsComponent } from './list-secondary-actions.component'; /** + * @docsIncludeIds SkyListToolbarComponent, SkyListSecondaryActionsComponent, SkyListSecondaryActionComponent, SkyListToolbarItemComponent, SkyListToolbarSearchActionsComponent, SkyListToolbarSortComponent, SkyListToolbarViewActionsComponent * @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager. */ @NgModule({ diff --git a/libs/components/list-builder/src/lib/modules/list/list.module.ts b/libs/components/list-builder/src/lib/modules/list/list.module.ts index c21440328c..474414b543 100644 --- a/libs/components/list-builder/src/lib/modules/list/list.module.ts +++ b/libs/components/list-builder/src/lib/modules/list/list.module.ts @@ -4,6 +4,7 @@ import { NgModule } from '@angular/core'; import { SkyListComponent } from './list.component'; /** + * @docsIncludeIds SkyListComponent, ListDataRequestModel, ListDataResponseModel, ListSearchModel, ListSelectedModel, ListSortLabelModel, ListSortModel * @deprecated List builder and its features are deprecated. Use data manager instead. For more information, see https://developer.blackbaud.com/skyux/components/data-manager. */ @NgModule({ diff --git a/libs/components/lists/src/lib/modules/filter/filter.module.ts b/libs/components/lists/src/lib/modules/filter/filter.module.ts index 5942ad3a7a..08c35e975f 100644 --- a/libs/components/lists/src/lib/modules/filter/filter.module.ts +++ b/libs/components/lists/src/lib/modules/filter/filter.module.ts @@ -12,6 +12,9 @@ import { SkyFilterInlineComponent } from './filter-inline.component'; import { SkyFilterSummaryItemComponent } from './filter-summary-item.component'; import { SkyFilterSummaryComponent } from './filter-summary.component'; +/** + * @docsIncludeIds SkyFilterInlineComponent, SkyFilterInlineItemComponent, SkyFilterSummaryComponent, SkyFilterSummaryItemComponent, SkyFilterButtonComponent + */ @NgModule({ declarations: [ SkyFilterButtonComponent, diff --git a/libs/components/lists/src/lib/modules/infinite-scroll/infinite-scroll.module.ts b/libs/components/lists/src/lib/modules/infinite-scroll/infinite-scroll.module.ts index df9af115b7..6c6829e36b 100644 --- a/libs/components/lists/src/lib/modules/infinite-scroll/infinite-scroll.module.ts +++ b/libs/components/lists/src/lib/modules/infinite-scroll/infinite-scroll.module.ts @@ -5,6 +5,9 @@ import { SkyListsResourcesModule } from '../shared/sky-lists-resources.module'; import { SkyInfiniteScrollComponent } from './infinite-scroll.component'; +/** + * @docsIncludeIds SkyInfiniteScrollComponent + */ @NgModule({ declarations: [SkyInfiniteScrollComponent], imports: [SkyListsResourcesModule, SkyWaitModule], diff --git a/libs/components/lists/src/lib/modules/paging/paging.module.ts b/libs/components/lists/src/lib/modules/paging/paging.module.ts index 199491facd..ce0f07bf5d 100644 --- a/libs/components/lists/src/lib/modules/paging/paging.module.ts +++ b/libs/components/lists/src/lib/modules/paging/paging.module.ts @@ -9,6 +9,9 @@ import { SkyListsResourcesModule } from '../shared/sky-lists-resources.module'; import { SkyPagingContentComponent } from './paging-content.component'; import { SkyPagingComponent } from './paging.component'; +/** + * @docsIncludeIds SkyPagingComponent, SkyPagingContentComponent, SkyPagingContentChangeArgs + */ @NgModule({ declarations: [SkyPagingComponent], imports: [ diff --git a/libs/components/lists/src/lib/modules/repeater/repeater.module.ts b/libs/components/lists/src/lib/modules/repeater/repeater.module.ts index dc85c92a1c..a012309c2c 100644 --- a/libs/components/lists/src/lib/modules/repeater/repeater.module.ts +++ b/libs/components/lists/src/lib/modules/repeater/repeater.module.ts @@ -17,6 +17,9 @@ import { SkyRepeaterItemTitleComponent } from './repeater-item-title.component'; import { SkyRepeaterItemComponent } from './repeater-item.component'; import { SkyRepeaterComponent } from './repeater.component'; +/** + * @docsIncludeIds SkyRepeaterComponent, SkyRepeaterItemComponent, SkyRepeaterItemTitleComponent, SkyRepeaterItemContentComponent, SkyRepeaterItemContextMenuComponent, SkyRepeaterExpandModeType, SkyRepeaterHarness, SkyRepeaterItemHarness + */ @NgModule({ declarations: [ SkyRepeaterComponent, diff --git a/libs/components/lists/src/lib/modules/sort/sort.module.ts b/libs/components/lists/src/lib/modules/sort/sort.module.ts index d37d8a28e9..3317bdeba8 100644 --- a/libs/components/lists/src/lib/modules/sort/sort.module.ts +++ b/libs/components/lists/src/lib/modules/sort/sort.module.ts @@ -11,6 +11,9 @@ import { SkySortItemComponent } from './sort-item.component'; import { SkySortMenuHeadingComponent } from './sort-menu-heading.component'; import { SkySortComponent } from './sort.component'; +/** + * @docsIncludeIds SkySortComponent, SkySortItemComponent + */ @NgModule({ declarations: [ SkySortComponent, diff --git a/libs/components/lookup/src/lib/modules/autocomplete/autocomplete.module.ts b/libs/components/lookup/src/lib/modules/autocomplete/autocomplete.module.ts index 6190b673a2..7847ba834f 100644 --- a/libs/components/lookup/src/lib/modules/autocomplete/autocomplete.module.ts +++ b/libs/components/lookup/src/lib/modules/autocomplete/autocomplete.module.ts @@ -12,6 +12,9 @@ import { SkyAutocompleteInputDirective } from './autocomplete-input.directive'; import { SkyAutocompleteSearchAsyncDisabledPipe } from './autocomplete-search-async-disabled.pipe'; import { SkyAutocompleteComponent } from './autocomplete.component'; +/** + * @docsIncludeIds SkyAutocompleteComponent, SkyAutocompleteInputDirective, SkyAutocompleteSearchArgs, SkyAutocompleteSearchAsyncArgs, AutocompleteSearchAsyncResultDisplayType, SkyAutocompleteSearchAsyncResult, SkyAutocompleteSearchContext, SkyAutocompleteSearchFunctionFilter, SkyAutocompleteSearchFunctionResponse, SkyAutocompleteSearchFunction, SkyAutocompleteSelectionChange, SkyAutocompleteHarness, SkyAutocompleteHarnessFilters, SkyAutocompleteSearchResultHarness + */ @NgModule({ declarations: [ SkyAutocompleteComponent, diff --git a/libs/components/lookup/src/lib/modules/country-field/country-field.module.ts b/libs/components/lookup/src/lib/modules/country-field/country-field.module.ts index 731906303d..00d1de0a8a 100644 --- a/libs/components/lookup/src/lib/modules/country-field/country-field.module.ts +++ b/libs/components/lookup/src/lib/modules/country-field/country-field.module.ts @@ -9,6 +9,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module' import { SkyCountryFieldComponent } from './country-field.component'; +/** + * @docsIncludeIds SkyCountryFieldComponent, SkyCountryFieldCountry, SkyCountryFieldHarness, SkyCountryFieldHarnessFilters, SkyCountryFieldSearchResultHarness + */ @NgModule({ declarations: [SkyCountryFieldComponent], imports: [ diff --git a/libs/components/lookup/src/lib/modules/lookup/lookup.module.ts b/libs/components/lookup/src/lib/modules/lookup/lookup.module.ts index 9457686265..c3fb4323a4 100644 --- a/libs/components/lookup/src/lib/modules/lookup/lookup.module.ts +++ b/libs/components/lookup/src/lib/modules/lookup/lookup.module.ts @@ -9,6 +9,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module' import { SkyLookupComponent } from './lookup.component'; +/** + * @docsIncludeIds SkyLookupComponent, SkyLookupAddCallbackArgs, SkyLookupAddClickEventArgs, SkyLookupSelectModeType, SkyLookupShowMoreConfig, SkyLookupShowMoreCustomPickerContext, SkyLookupShowMoreCustomPicker, SkyLookupShowMoreNativePickerConfig, SkyLookupHarness + */ @NgModule({ declarations: [SkyLookupComponent], imports: [ diff --git a/libs/components/lookup/src/lib/modules/search/search.module.ts b/libs/components/lookup/src/lib/modules/search/search.module.ts index 2d9a889ac8..ce5337efab 100644 --- a/libs/components/lookup/src/lib/modules/search/search.module.ts +++ b/libs/components/lookup/src/lib/modules/search/search.module.ts @@ -10,6 +10,9 @@ import { SkyLookupResourcesModule } from '../shared/sky-lookup-resources.module' import { SkySearchComponent } from './search.component'; +/** + * @docsIncludeIds SkySearchComponent, SkySearchHarness + */ @NgModule({ declarations: [SkySearchComponent], imports: [ diff --git a/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.module.ts b/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.module.ts index 89010adb2a..99f6f01096 100644 --- a/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.module.ts +++ b/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.module.ts @@ -2,6 +2,7 @@ import { NgModule } from '@angular/core'; /** * @deprecated The `SkySelectionModalModule` is no longer needed and can be removed from your application. + * @internal */ @NgModule({}) export class SkySelectionModalModule {} diff --git a/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.service.ts b/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.service.ts index 375e08ad65..f3bcc6522a 100644 --- a/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.service.ts +++ b/libs/components/lookup/src/lib/modules/selection-modal/selection-modal.service.ts @@ -15,6 +15,7 @@ import { SkySelectionModalOpenArgs } from './types/selection-modal-open-args'; /** * Displays a modal for selecting one or more values. + * @docsIncludeIds SkySelectionModalAddCallbackArgs, SkySelectionModalAddClickEventArgs, SkySelectionModalCloseArgs, SkySelectionModalOpenArgs, SkySelectionModalResult, SkySelectionModalSearchArgs, SkySelectionModalSearchResult, SkySelectionModalHarness, SkySelectionModalSearchResultHarnessFilters, SkySelectionModalSearchResultHarness */ @Injectable({ providedIn: 'root', diff --git a/libs/components/manifest/src/generator/__snapshots__/generate-manifest.test.ts.snap b/libs/components/manifest/src/generator/__snapshots__/generate-manifest.test.ts.snap index 3bda396239..7f3adbcb61 100644 --- a/libs/components/manifest/src/generator/__snapshots__/generate-manifest.test.ts.snap +++ b/libs/components/manifest/src/generator/__snapshots__/generate-manifest.test.ts.snap @@ -262,9 +262,8 @@ exports[`generate-manifest should generate manifest 1`] = ` \\"anchorId\\": \\"class_foo-with-docs-id-override-class\\", \\"docsId\\": \\"docs-id-override\\", \\"docsIncludeIds\\": [ - \\"foo\\", - \\"bar\\", - \\"baz\\" + \\"FooWithStaticPropertiesClass\\", + \\"FooClass\\" ], \\"filePath\\": \\"libs/components/manifest/src/generator/testing/fixtures/example-packages/foo/src/lib/foo.class.ts\\", \\"kind\\": \\"class\\", diff --git a/libs/components/manifest/src/generator/assign-docs-include-ids.ts b/libs/components/manifest/src/generator/assign-docs-include-ids.ts index e23706f106..ca36f30a9b 100644 --- a/libs/components/manifest/src/generator/assign-docs-include-ids.ts +++ b/libs/components/manifest/src/generator/assign-docs-include-ids.ts @@ -1,8 +1,75 @@ import fsPromises from 'node:fs/promises'; import * as ts from 'typescript'; +import type { SkyManifestParentDefinition } from '../types/base-def'; + import { type PackagesMap } from './get-public-api'; +function getDefinitionByDocsId( + docsId: string, + packages: PackagesMap, +): SkyManifestParentDefinition | undefined { + for (const [, definitions] of packages) { + for (const definition of definitions) { + if (definition.docsId === docsId) { + return definition; + } + } + } + + return; +} + +function validateDocsIds(packages: PackagesMap): string[] { + const errors: string[] = []; + const ids: string[] = []; + + for (const [, definitions] of packages) { + for (const definition of definitions) { + if (ids.includes(definition.docsId)) { + errors.push(`Duplicate @docsId encountered: ${definition.docsId}`); + continue; + } + + ids.push(definition.docsId); + } + } + + return errors; +} + +function validateDocsIncludeIds(packages: PackagesMap): string[] { + const errors: string[] = []; + + for (const [, definitions] of packages) { + for (const definition of definitions) { + const docsIncludeIds = definition.docsIncludeIds; + + if (docsIncludeIds) { + for (const docsId of docsIncludeIds) { + const referencedDefinition = getDefinitionByDocsId(docsId, packages); + + if (!referencedDefinition) { + errors.push( + `The @docsId "${docsId}" referenced by "${definition.name}" is not recognized.`, + ); + continue; + } + + if (referencedDefinition.isInternal) { + errors.push( + `The @docsId "${docsId}" referenced by "${definition.name}" is not included in the public API.`, + ); + continue; + } + } + } + } + } + + return errors; +} + /** * Assign `docsIncludeIds` for each entry-point module, based on the types * included in its `exports` array. @@ -10,6 +77,8 @@ import { type PackagesMap } from './get-public-api'; export async function assignDocsIncludeIds( packages: PackagesMap, ): Promise { + const errors: string[] = []; + for (const [, definitions] of packages) { for (const definition of definitions) { if ( @@ -48,12 +117,14 @@ export async function assignDocsIncludeIds( property.initializer.elements.forEach((element) => { if (ts.isIdentifier(element)) { const exportName = element.escapedText.toString(); + const definition = definitions.find( + (definition) => definition.name === exportName, + ); if ( exportName.startsWith('Sky') && - definitions.some( - (definition) => definition.name === exportName, - ) + definition && + !definition.isInternal ) { moduleExports.push(element.escapedText.toString()); } @@ -83,4 +154,11 @@ export async function assignDocsIncludeIds( definition.docsIncludeIds = moduleExports; } } + + errors.push(...validateDocsIds(packages)); + errors.push(...validateDocsIncludeIds(packages)); + + if (errors.length > 0) { + throw new Error(errors.join('\n')); + } } diff --git a/libs/components/manifest/src/generator/generate-manifest.test.ts b/libs/components/manifest/src/generator/generate-manifest.test.ts index f7aa4557bf..25d31b7e2d 100644 --- a/libs/components/manifest/src/generator/generate-manifest.test.ts +++ b/libs/components/manifest/src/generator/generate-manifest.test.ts @@ -1,7 +1,10 @@ const projectsRootDirectory = 'libs/components/manifest/src/generator/testing/fixtures/example-packages'; -function setup(options: { outDirExists: boolean }): { +function setup(options: { + outDirExists: boolean; + projectName: 'foo' | 'invalid-docs-id'; +}): { mkdirMock: jest.Mock; writeFileMock: jest.Mock; } { @@ -30,7 +33,7 @@ function setup(options: { outDirExists: boolean }): { jest.mock('./get-project-definitions', () => { return { getProjectDefinitions: jest.fn().mockImplementation(() => { - const projectRoot = `${projectsRootDirectory}/foo`; + const projectRoot = `${projectsRootDirectory}/${options.projectName}`; return [ { @@ -38,8 +41,8 @@ function setup(options: { outDirExists: boolean }): { `${projectRoot}/src/index.ts`, `${projectRoot}/testing/src/public-api.ts`, ], - packageName: '@skyux/foo', - projectName: 'foo', + packageName: `@skyux/${options.projectName}`, + projectName: options.projectName, projectRoot, }, ]; @@ -59,6 +62,7 @@ describe('generate-manifest', () => { it('should generate manifest', async () => { const { writeFileMock } = setup({ outDirExists: true, + projectName: 'foo', }); const { generateManifest } = await import('./generate-manifest'); @@ -75,6 +79,7 @@ describe('generate-manifest', () => { it('should create the out directory if it does not exist', async () => { const { mkdirMock } = setup({ outDirExists: false, + projectName: 'foo', }); const { generateManifest } = await import('./generate-manifest'); @@ -87,4 +92,25 @@ describe('generate-manifest', () => { expect(mkdirMock).toHaveBeenCalledWith('/dist'); }, 60000); + + it('should throw for invalid docs IDs', async () => { + setup({ + outDirExists: true, + projectName: 'invalid-docs-id', + }); + + const { generateManifest } = await import('./generate-manifest'); + + await expect( + generateManifest({ + outDir: '/dist', + projectNames: ['invalid-docs-id'], + projectsRootDirectory, + }), + ).rejects.toThrow( + 'Duplicate @docsId encountered: my-duplicate\n' + + 'The @docsId "SomeInternalClass" referenced by "ReferencingInternalDocsIds" is not included in the public API.\n' + + 'The @docsId "foo" referenced by "UnrecognizedDocsIncludeIds" is not recognized.', + ); + }, 60000); }); diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/foo/src/lib/foo.class.ts b/libs/components/manifest/src/generator/testing/fixtures/example-packages/foo/src/lib/foo.class.ts index 9fb7ebba08..7c6b5bfeb4 100644 --- a/libs/components/manifest/src/generator/testing/fixtures/example-packages/foo/src/lib/foo.class.ts +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/foo/src/lib/foo.class.ts @@ -111,7 +111,7 @@ export abstract class FooWithStaticPropertiesClass { /** * @docsId docs-id-override - * @docsIncludeIds foo, bar, baz + * @docsIncludeIds FooWithStaticPropertiesClass, FooClass,FooClass,FooClass */ export class FooWithDocsIdOverrideClass {} diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/index.ts b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/index.ts new file mode 100644 index 0000000000..fd6eaca520 --- /dev/null +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/index.ts @@ -0,0 +1,7 @@ +export { + DuplicateDocsId1, + DuplicateDocsId2, + ReferencingInternalDocsIds, + SomeInternalClass, + UnrecognizedDocsIncludeIds, +} from './invalid-docs-id'; diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/invalid-docs-id.ts b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/invalid-docs-id.ts new file mode 100644 index 0000000000..2d8c884ac8 --- /dev/null +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/src/invalid-docs-id.ts @@ -0,0 +1,24 @@ +/** + * @docsId my-duplicate + */ +export class DuplicateDocsId1 {} + +/** + * @docsId my-duplicate + */ +export class DuplicateDocsId2 {} + +/** + * @docsIncludeIds foo + */ +export class UnrecognizedDocsIncludeIds {} + +/** + * @docsIncludeIds SomeInternalClass + */ +export class ReferencingInternalDocsIds {} + +/** + * @internal + */ +export class SomeInternalClass {} diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.json b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.json new file mode 100644 index 0000000000..a0fc30c825 --- /dev/null +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.json @@ -0,0 +1,13 @@ +{ + "extends": "../../../../../../../../../tsconfig.base.json", + "files": [], + "include": [], + "references": [ + { + "path": "./tsconfig.lib.json" + }, + { + "path": "./tsconfig.lib.prod.json" + } + ] +} diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.json b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.json new file mode 100644 index 0000000000..4cd769720b --- /dev/null +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.json @@ -0,0 +1,11 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "outDir": "../../../../dist/out-tsc", + "declaration": true, + "declarationMap": true, + "inlineSources": true + }, + "exclude": ["src/test.ts", "**/*.spec.ts"], + "include": ["**/*.ts"] +} diff --git a/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.prod.json b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.prod.json new file mode 100644 index 0000000000..2a2faa884c --- /dev/null +++ b/libs/components/manifest/src/generator/testing/fixtures/example-packages/invalid-docs-id/tsconfig.lib.prod.json @@ -0,0 +1,9 @@ +{ + "extends": "./tsconfig.lib.json", + "compilerOptions": { + "declarationMap": false + }, + "angularCompilerOptions": { + "compilationMode": "partial" + } +} diff --git a/libs/components/manifest/src/generator/utility/get-class.ts b/libs/components/manifest/src/generator/utility/get-class.ts index 4e7a6effad..5eb842533a 100644 --- a/libs/components/manifest/src/generator/utility/get-class.ts +++ b/libs/components/manifest/src/generator/utility/get-class.ts @@ -12,6 +12,7 @@ import { getAnchorId } from './get-anchor-id'; import { getComment } from './get-comment'; import { getDefaultValue } from './get-default-value'; import { getParameters } from './get-parameters'; +import { remapLambdaName } from './remap-lambda-names'; export function getMethods( reflection: DeclarationReflection, @@ -126,6 +127,7 @@ export function getClass( isPreview, } = getComment(reflection); + const className = remapLambdaName(reflection); const methods = getMethods(reflection) ?? []; const properties = getProperties(reflection) ?? []; const children = [...methods, ...properties]; @@ -137,14 +139,14 @@ export function getClass( codeExampleLanguage, deprecationReason, description, - docsId: docsId ?? reflection.name, + docsId: docsId ?? className, docsIncludeIds, filePath, isDeprecated, isInternal, isPreview, kind, - name: reflection.name, + name: className, typeParameters: formatTypeParameters(reflection), }; diff --git a/libs/components/manifest/src/generator/utility/get-comment.ts b/libs/components/manifest/src/generator/utility/get-comment.ts index a00e189441..edcca7b1ee 100644 --- a/libs/components/manifest/src/generator/utility/get-comment.ts +++ b/libs/components/manifest/src/generator/utility/get-comment.ts @@ -65,10 +65,13 @@ function getCodeExample(comment: CommentTag): { } function getDocsIncludeIds(tag: CommentTag): string[] { - return ( - getCommentTagText(tag.content) - ?.split(',') - .map((id) => id.trim()) || [] + return Array.from( + new Set( + getCommentTagText(tag.content) + ?.split(',') + .map((id) => id.trim()) + .filter((id) => id) || [], + ), ); } diff --git a/libs/components/manifest/src/generator/utility/get-pipe.ts b/libs/components/manifest/src/generator/utility/get-pipe.ts index cf89501313..24ac913262 100644 --- a/libs/components/manifest/src/generator/utility/get-pipe.ts +++ b/libs/components/manifest/src/generator/utility/get-pipe.ts @@ -7,7 +7,6 @@ import type { DeclarationReflectionWithDecorators } from '../types/declaration-r import { getAnchorId } from './get-anchor-id'; import { getClass } from './get-class'; -import { remapLambdaName } from './remap-lambda-names'; export function getPipe( decl: DeclarationReflectionWithDecorators, @@ -15,7 +14,7 @@ export function getPipe( ): SkyManifestPipeDefinition { const reflection = getClass(decl, 'class', filePath); - const pipeName = remapLambdaName(decl); + const pipeName = reflection.name; const templateBindingName = decl.decorators?.[0]?.arguments?.[ 'name' ] as string; diff --git a/libs/components/manifest/src/index.ts b/libs/components/manifest/src/index.ts index 50647d401c..b5c35c1894 100644 --- a/libs/components/manifest/src/index.ts +++ b/libs/components/manifest/src/index.ts @@ -1,4 +1,4 @@ -export { getPublicApi } from './get-public-api'; +export { getPublicApi, getPublicApiByDocsId } from './get-public-api'; export type { SkyManifestChildDefinition, SkyManifestChildDefinitionKind, diff --git a/libs/components/modals/src/lib/modules/confirm/confirm.module.ts b/libs/components/modals/src/lib/modules/confirm/confirm.module.ts index d3ec201eb1..00726499bf 100644 --- a/libs/components/modals/src/lib/modules/confirm/confirm.module.ts +++ b/libs/components/modals/src/lib/modules/confirm/confirm.module.ts @@ -2,6 +2,7 @@ import { NgModule } from '@angular/core'; /** * @deprecated The `SkyConfirmModule` is no longer needed and can be removed from your application. + * @internal */ @NgModule({}) export class SkyConfirmModule {} diff --git a/libs/components/modals/src/lib/modules/confirm/confirm.service.ts b/libs/components/modals/src/lib/modules/confirm/confirm.service.ts index 0837bf5553..56fddf988e 100644 --- a/libs/components/modals/src/lib/modules/confirm/confirm.service.ts +++ b/libs/components/modals/src/lib/modules/confirm/confirm.service.ts @@ -10,6 +10,7 @@ import { SkyConfirmComponent } from './confirm.component'; /** * Launches a dialog. + * @docsIncludeIds SkyConfirmConfig, SkyConfirmInstance, SkyConfirmType, SkyConfirmButtonConfig, SkyConfirmButtonStyleType, SkyConfirmCloseEventArgs, SkyConfirmHarness, SkyConfirmButtonHarnessFilters, SkyConfirmTestingModule, SkyConfirmTestingController */ @Injectable({ providedIn: 'root', diff --git a/libs/components/modals/src/lib/modules/modal/modal.module.ts b/libs/components/modals/src/lib/modules/modal/modal.module.ts index ef7758a24e..8822dbec38 100644 --- a/libs/components/modals/src/lib/modules/modal/modal.module.ts +++ b/libs/components/modals/src/lib/modules/modal/modal.module.ts @@ -6,6 +6,9 @@ import { SkyModalHeaderComponent } from './modal-header.component'; import { SkyModalIsDirtyDirective } from './modal-is-dirty.directive'; import { SkyModalComponent } from './modal.component'; +/** + * @docsIncludeIds SkyModalComponent, SkyModalHeaderComponent, SkyModalContentComponent, SkyModalFooterComponent, SkyModalService, SkyModalConfigurationInterface, SkyModalInstance, SkyModalCloseArgs, SkyModalBeforeCloseHandler, SkyModalError, SkyModalIsDirtyDirective, SkyModalHarness, SkyModalHarnessFilters, SkyModalTestingModule, SkyModalTestingController + */ @NgModule({ imports: [ SkyModalComponent, diff --git a/libs/components/modals/testing/src/modules/confirm/confirm-testing.module.ts b/libs/components/modals/testing/src/modules/confirm/confirm-testing.module.ts index 8d3af4e425..a839f86c88 100644 --- a/libs/components/modals/testing/src/modules/confirm/confirm-testing.module.ts +++ b/libs/components/modals/testing/src/modules/confirm/confirm-testing.module.ts @@ -4,6 +4,7 @@ import { provideConfirmTesting } from './provide-confirm-testing'; /** * Configures the `SkyConfirmTestingController` as the backend for the `SkyConfirmService`. + * @docsIncludeIds SkyConfirmTestingController */ @NgModule({ providers: [provideConfirmTesting()], diff --git a/libs/components/modals/testing/src/modules/modal/controller/modal-testing.module.ts b/libs/components/modals/testing/src/modules/modal/controller/modal-testing.module.ts index 1523297a39..0bd1a1612b 100644 --- a/libs/components/modals/testing/src/modules/modal/controller/modal-testing.module.ts +++ b/libs/components/modals/testing/src/modules/modal/controller/modal-testing.module.ts @@ -4,6 +4,7 @@ import { provideModalTesting } from './provide-modal-testing'; /** * Configures the `SkyModalTestingController` as the implementation for the `SkyModalService`. + * @docsIncludeIds SkyModalTestingController */ @NgModule({ providers: [provideModalTesting()], diff --git a/libs/components/navbar/src/lib/modules/navbar/navbar.module.ts b/libs/components/navbar/src/lib/modules/navbar/navbar.module.ts index 20523ca6c7..1dd7c018c3 100644 --- a/libs/components/navbar/src/lib/modules/navbar/navbar.module.ts +++ b/libs/components/navbar/src/lib/modules/navbar/navbar.module.ts @@ -4,6 +4,9 @@ import { NgModule } from '@angular/core'; import { SkyNavbarItemComponent } from './navbar-item.component'; import { SkyNavbarComponent } from './navbar.component'; +/** + * @docsIncludeIds SkyNavbarComponent, SkyNavbarItemComponent + */ @NgModule({ declarations: [SkyNavbarComponent, SkyNavbarItemComponent], imports: [CommonModule], diff --git a/libs/components/pages/src/lib/modules/action-hub/action-hub.module.ts b/libs/components/pages/src/lib/modules/action-hub/action-hub.module.ts index 96cdeb233c..dafd4e0dfd 100644 --- a/libs/components/pages/src/lib/modules/action-hub/action-hub.module.ts +++ b/libs/components/pages/src/lib/modules/action-hub/action-hub.module.ts @@ -16,6 +16,9 @@ import { SkyActionHubRecentLinksResolvePipe } from './action-hub-recent-links-re import { SkyActionHubRelatedLinksSortPipe } from './action-hub-related-links-sort.pipe'; import { SkyActionHubComponent } from './action-hub.component'; +/** + * @docsIncludeIds SkyActionHubComponent, SkyActionHubContentComponent, SkyActionHubButtonsComponent, SkyActionHubNeedsAttentionClickHandlerArgs, SkyActionHubNeedsAttentionClickHandler, SkyActionHubNeedsAttentionInput, SkyActionHubNeedsAttention, SkyPageLink, SkyPageLinksInput, SkyPageModalLink, SkyPageModalLinksInput, SkyRecentLink, SkyRecentLinksInput, SkyActionHubHarness, SkyActionHubHarnessFilters + */ @NgModule({ imports: [ SkyActionHubRecentLinksResolvePipe, diff --git a/libs/components/pages/src/lib/modules/link-list/link-list.module.ts b/libs/components/pages/src/lib/modules/link-list/link-list.module.ts index 2d977b57bc..b473495ddb 100644 --- a/libs/components/pages/src/lib/modules/link-list/link-list.module.ts +++ b/libs/components/pages/src/lib/modules/link-list/link-list.module.ts @@ -5,6 +5,9 @@ import { SkyLinkListRecentlyAccessedComponent } from '../link-list-recently-acce import { SkyLinkListItemComponent } from './link-list-item.component'; import { SkyLinkListComponent } from './link-list.component'; +/** + * @docsIncludeIds SkyLinkListComponent, SkyLinkListItemComponent, SkyLinkListHarness, SkyLinkListHarnessFilters, SkyLinkListItemHarness, SkyLinkListItemHarnessFilters + */ @NgModule({ exports: [ SkyLinkListComponent, diff --git a/libs/components/pages/src/lib/modules/page-header/page-header.module.ts b/libs/components/pages/src/lib/modules/page-header/page-header.module.ts index 9be230368d..6ed4916722 100644 --- a/libs/components/pages/src/lib/modules/page-header/page-header.module.ts +++ b/libs/components/pages/src/lib/modules/page-header/page-header.module.ts @@ -10,6 +10,9 @@ import { SkyPageHeaderAvatarComponent } from './page-header-avatar.component'; import { SkyPageHeaderDetailsComponent } from './page-header-details.component'; import { SkyPageHeaderComponent } from './page-header.component'; +/** + * @docsIncludeIds SkyPageHeaderComponent, SkyPageHeaderDetailsComponent, SkyPageHeaderActionsComponent, SkyPageHeaderAlertsComponent, SkyPageHeaderAvatarComponent, SkyPageHeaderHarness, SkyPageHeaderHarnessFilters + */ @NgModule({ imports: [ RouterModule, diff --git a/libs/components/pages/src/lib/modules/page/page.module.ts b/libs/components/pages/src/lib/modules/page/page.module.ts index 4c57d7dc17..eb0ccbfbab 100644 --- a/libs/components/pages/src/lib/modules/page/page.module.ts +++ b/libs/components/pages/src/lib/modules/page/page.module.ts @@ -9,6 +9,9 @@ import { SkyPageContentComponent } from './page-content.component'; import { SkyPageLinksComponent } from './page-links.component'; import { SkyPageComponent } from './page.component'; +/** + * @docsIncludeIds SkyPageComponent, SkyPageHeaderModule, SkyPageContentComponent, SkyPageLinksComponent, SkyPageLayoutType, SkyPageHarness, SkyPageHarnessFilters + */ @NgModule({ declarations: [SkyPageComponent, SkyPageContentComponent], imports: [ diff --git a/libs/components/phone-field/src/lib/modules/phone-field/phone-field.module.ts b/libs/components/phone-field/src/lib/modules/phone-field/phone-field.module.ts index 6cd0ed776f..65ea54734c 100644 --- a/libs/components/phone-field/src/lib/modules/phone-field/phone-field.module.ts +++ b/libs/components/phone-field/src/lib/modules/phone-field/phone-field.module.ts @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core'; import { SkyPhoneFieldInputDirective } from './phone-field-input.directive'; import { SkyPhoneFieldComponent } from './phone-field.component'; +/** + * @docsIncludeIds SkyPhoneFieldComponent, SkyPhoneFieldInputDirective, SkyPhoneFieldCountry, SkyPhoneFieldNumberReturnFormat, SkyPhoneFieldHarness, SkyPhoneFieldHarnessFilters + */ @NgModule({ imports: [SkyPhoneFieldComponent, SkyPhoneFieldInputDirective], exports: [SkyPhoneFieldComponent, SkyPhoneFieldInputDirective], diff --git a/libs/components/popovers/src/lib/modules/dropdown/dropdown.module.ts b/libs/components/popovers/src/lib/modules/dropdown/dropdown.module.ts index df78ec8bbd..1396360f50 100644 --- a/libs/components/popovers/src/lib/modules/dropdown/dropdown.module.ts +++ b/libs/components/popovers/src/lib/modules/dropdown/dropdown.module.ts @@ -15,6 +15,9 @@ import { SkyDropdownItemComponent } from './dropdown-item.component'; import { SkyDropdownMenuComponent } from './dropdown-menu.component'; import { SkyDropdownComponent } from './dropdown.component'; +/** + * @docsIncludeIds SkyDropdownComponent, SkyDropdownButtonComponent, SkyDropdownMenuComponent, SkyDropdownItemComponent, SkyDropdownButtonType, SkyDropdownHorizontalAlignment, SkyDropdownTriggerType, SkyDropdownHarness, SkyDropdownHarnessFilters, SkyDropdownItemHarness, SkyDropdownItemHarnessFilters, SkyDropdownMenuHarness, SkyDropdownMenuHarnessFilters + */ @NgModule({ declarations: [ SkyDropdownButtonComponent, diff --git a/libs/components/popovers/src/lib/modules/popover/popover.module.ts b/libs/components/popovers/src/lib/modules/popover/popover.module.ts index e820ed26da..cd659c14eb 100644 --- a/libs/components/popovers/src/lib/modules/popover/popover.module.ts +++ b/libs/components/popovers/src/lib/modules/popover/popover.module.ts @@ -10,6 +10,9 @@ import { SkyPopoverContentComponent } from './popover-content.component'; import { SkyPopoverComponent } from './popover.component'; import { SkyPopoverDirective } from './popover.directive'; +/** + * @docsIncludeIds SkyPopoverComponent, SkyPopoverDirective, SkyPopoverAlignment, SkyPopoverPlacement, SkyPopoverTrigger, SkyPopoverType, SkyPopoverMessage, SkyPopoverMessageType, SkyPopoverHarness, SkyPopoverHarnessFilters, SkyPopoverContentHarness, + */ @NgModule({ declarations: [ SkyPopoverComponent, diff --git a/libs/components/progress-indicator/src/lib/modules/progress-indicator/progress-indicator.module.ts b/libs/components/progress-indicator/src/lib/modules/progress-indicator/progress-indicator.module.ts index c950b45cfe..2ba0472cce 100644 --- a/libs/components/progress-indicator/src/lib/modules/progress-indicator/progress-indicator.module.ts +++ b/libs/components/progress-indicator/src/lib/modules/progress-indicator/progress-indicator.module.ts @@ -17,6 +17,9 @@ import { SkyProgressIndicatorStatusMarkerComponent } from './progress-indicator- import { SkyProgressIndicatorTitleComponent } from './progress-indicator-title/progress-indicator-title.component'; import { SkyProgressIndicatorComponent } from './progress-indicator.component'; +/** + * @docsIncludeIds SkyProgressIndicatorComponent, SkyProgressIndicatorTitleComponent, SkyProgressIndicatorItemComponent, SkyProgressIndicatorNavButtonComponent, SkyProgressIndicatorResetButtonComponent, SkyProgressIndicatorActionClickArgs, SkyProgressIndicatorActionClickProgressHandler, SkyProgressIndicatorChange, SkyProgressIndicatorDisplayModeType, SkyProgressIndicatorItemStatus, SkyProgressIndicatorNavButtonType, SkyProgressIndicatorMessage, SkyProgressIndicatorMessageType, SkyProgressIndicatorHarness, SkyProgressIndicatorFilters, SkyProgressIndicatorItemHarness, SkyProgressIndicatorItemFilters + */ @NgModule({ declarations: [ SkyProgressIndicatorComponent, diff --git a/libs/components/router/src/lib/modules/href/href.module.ts b/libs/components/router/src/lib/modules/href/href.module.ts index f6f0ab08f4..f751d02537 100644 --- a/libs/components/router/src/lib/modules/href/href.module.ts +++ b/libs/components/router/src/lib/modules/href/href.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyHrefDirective } from './href.directive'; +/** + * @docsIncludeIds SkyHrefDirective, SkyHrefResolver, SkyHrefResolverService, SkyHrefChange, SkyHrefQueryParams, SkyHrefResolverArgs, SkyHref, SkyHrefHarness, SkyHrefTestingModule + */ @NgModule({ declarations: [SkyHrefDirective], exports: [SkyHrefDirective], diff --git a/libs/components/router/src/lib/modules/link/link.module.ts b/libs/components/router/src/lib/modules/link/link.module.ts index b2887f5702..f5a00b6075 100644 --- a/libs/components/router/src/lib/modules/link/link.module.ts +++ b/libs/components/router/src/lib/modules/link/link.module.ts @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core'; import { SkyAppLinkExternalDirective } from './link-external.directive'; import { SkyAppLinkDirective } from './link.directive'; +/** + * @docsIncludeIds SkyAppLinkDirective, SkyAppLinkExternalDirective, SkyAppLinkQueryParams + */ @NgModule({ declarations: [SkyAppLinkDirective, SkyAppLinkExternalDirective], exports: [SkyAppLinkDirective, SkyAppLinkExternalDirective], diff --git a/libs/components/select-field/src/lib/modules/select-field/select-field.module.ts b/libs/components/select-field/src/lib/modules/select-field/select-field.module.ts index 45baf98ca7..003d41a70b 100644 --- a/libs/components/select-field/src/lib/modules/select-field/select-field.module.ts +++ b/libs/components/select-field/src/lib/modules/select-field/select-field.module.ts @@ -3,6 +3,7 @@ import { NgModule } from '@angular/core'; import { SkySelectFieldComponent } from './select-field.component'; /** + * @docsIncludeIds SkySelectFieldComponent, SkySelectFieldPickerContext, SkySelectFieldCustomPicker, SkySelectFieldSelectMode, SkySelectField * @deprecated `SkySelectFieldComponent` is deprecated. Use `SkyLookupComponent` instead. */ @NgModule({ diff --git a/libs/components/split-view/src/lib/modules/split-view/split-view.module.ts b/libs/components/split-view/src/lib/modules/split-view/split-view.module.ts index a6c4586086..0df4ebed71 100644 --- a/libs/components/split-view/src/lib/modules/split-view/split-view.module.ts +++ b/libs/components/split-view/src/lib/modules/split-view/split-view.module.ts @@ -7,6 +7,9 @@ import { SkySplitViewWorkspaceHeaderComponent } from './split-view-workspace-hea import { SkySplitViewWorkspaceComponent } from './split-view-workspace.component'; import { SkySplitViewComponent } from './split-view.component'; +/** + * @docsIncludeIds SkySplitViewComponent, SkySplitViewDrawerComponent, SkySplitViewWorkspaceComponent, SkySplitViewWorkspaceContentComponent, SkySplitViewWorkspaceFooterComponent, SkySplitViewDockType, SkySplitViewMessage, SkySplitViewMessageType, SkySplitViewHarness, SkySplitViewHarnessFilters, SkySplitViewDrawerHarness, SkySplitViewWorkspaceHarness, SkySplitViewWorkspaceContentHarness, SkySplitViewWorkspaceFooterHarness + */ @NgModule({ imports: [ SkySplitViewComponent, diff --git a/libs/components/tabs/src/lib/modules/sectioned-form/sectioned-form.module.ts b/libs/components/tabs/src/lib/modules/sectioned-form/sectioned-form.module.ts index e275e98951..95f3c09c98 100644 --- a/libs/components/tabs/src/lib/modules/sectioned-form/sectioned-form.module.ts +++ b/libs/components/tabs/src/lib/modules/sectioned-form/sectioned-form.module.ts @@ -8,6 +8,9 @@ import { SkyVerticalTabsetModule } from '../vertical-tabset/vertical-tabset.modu import { SkySectionedFormSectionComponent } from './sectioned-form-section.component'; import { SkySectionedFormComponent } from './sectioned-form.component'; +/** + * @docsIncludeIds SkySectionedFormComponent, SkySectionedFormSectionComponent, SkySectionedFormService, SkySectionedFormMessage, SkySectionedFormMessageType + */ @NgModule({ declarations: [SkySectionedFormComponent, SkySectionedFormSectionComponent], imports: [ diff --git a/libs/components/tabs/src/lib/modules/tabs/tabs.module.ts b/libs/components/tabs/src/lib/modules/tabs/tabs.module.ts index a1db820875..17936ea51d 100644 --- a/libs/components/tabs/src/lib/modules/tabs/tabs.module.ts +++ b/libs/components/tabs/src/lib/modules/tabs/tabs.module.ts @@ -13,6 +13,9 @@ import { SkyTabsetNavButtonDisabledPipe } from './tabset-nav-button-disabled.pip import { SkyTabsetNavButtonComponent } from './tabset-nav-button.component'; import { SkyTabsetComponent } from './tabset.component'; +/** + * @docsIncludeIds SkyTabsetComponent, SkyTabComponent, SkyTabsetNavButtonComponent, SkyTabIndex, SkyTabLayoutType, SkyTabsetButtonsDisplayMode, SkyTabsetStyle, SkyTabsetTabIndexesChange + */ @NgModule({ declarations: [ SkyTabButtonComponent, diff --git a/libs/components/tabs/src/lib/modules/vertical-tabset/vertical-tabset.module.ts b/libs/components/tabs/src/lib/modules/vertical-tabset/vertical-tabset.module.ts index 0ad86d7a19..6ff7f9a1eb 100644 --- a/libs/components/tabs/src/lib/modules/vertical-tabset/vertical-tabset.module.ts +++ b/libs/components/tabs/src/lib/modules/vertical-tabset/vertical-tabset.module.ts @@ -15,6 +15,9 @@ import { SkyVerticalTabsetAdapterService } from './vertical-tabset-adapter.servi import { SkyVerticalTabsetGroupComponent } from './vertical-tabset-group.component'; import { SkyVerticalTabsetComponent } from './vertical-tabset.component'; +/** + * @docsIncludeIds SkyVerticalTabsetComponent, SkyVerticalTabComponent, SkyVerticalTabsetGroupComponent + */ @NgModule({ declarations: [ SkyVerticalTabsetComponent, diff --git a/libs/components/text-editor/src/lib/modules/rich-text-display/rich-text-display.module.ts b/libs/components/text-editor/src/lib/modules/rich-text-display/rich-text-display.module.ts index 41cb71bc59..aa829e7c11 100644 --- a/libs/components/text-editor/src/lib/modules/rich-text-display/rich-text-display.module.ts +++ b/libs/components/text-editor/src/lib/modules/rich-text-display/rich-text-display.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyRichTextDisplayComponent } from './rich-text-display.component'; +/** + * @docsIncludeIds SkyRichTextDisplayComponent + */ @NgModule({ exports: [SkyRichTextDisplayComponent], declarations: [SkyRichTextDisplayComponent], diff --git a/libs/components/text-editor/src/lib/modules/text-editor/text-editor.module.ts b/libs/components/text-editor/src/lib/modules/text-editor/text-editor.module.ts index 0d507d00d4..f657235e32 100644 --- a/libs/components/text-editor/src/lib/modules/text-editor/text-editor.module.ts +++ b/libs/components/text-editor/src/lib/modules/text-editor/text-editor.module.ts @@ -3,6 +3,9 @@ import { SkyFormErrorModule } from '@skyux/forms'; import { SkyTextEditorComponent } from './text-editor.component'; +/** + * @docsIncludeIds SkyTextEditorComponent, SkyTextEditorFont, SkyTextEditorLinkWindowOptionsType, SkyTextEditorMenuType, SkyTextEditorStyleState, SkyTextEditorMergeField, SkyTextEditorToolbarActionType + */ @NgModule({ imports: [SkyTextEditorComponent], exports: [SkyTextEditorComponent, SkyFormErrorModule], diff --git a/libs/components/theme/src/lib/theme.module.ts b/libs/components/theme/src/lib/theme.module.ts index d15e68fdcc..c0b0a9be13 100644 --- a/libs/components/theme/src/lib/theme.module.ts +++ b/libs/components/theme/src/lib/theme.module.ts @@ -4,6 +4,9 @@ import { SkyThemeClassDirective } from './theming/theme-class.directive'; import { SkyThemeIfDirective } from './theming/theme-if.directive'; import { SkyThemeDirective } from './theming/theme.directive'; +/** + * @docsIncludeIds SkyThemeDirective, SkyThemeClassDirective, SkyThemeIfDirective + */ @NgModule({ declarations: [ SkyThemeClassDirective, diff --git a/libs/components/tiles/src/lib/modules/tiles/tiles.module.ts b/libs/components/tiles/src/lib/modules/tiles/tiles.module.ts index 889aafcd6b..e78da40e04 100644 --- a/libs/components/tiles/src/lib/modules/tiles/tiles.module.ts +++ b/libs/components/tiles/src/lib/modules/tiles/tiles.module.ts @@ -5,6 +5,9 @@ import { SkyTileDashboardColumnModule } from './tile-dashboard-column/tile-dashb import { SkyTileDashboardModule } from './tile-dashboard/tile-dashboard.module'; import { SkyTileModule } from './tile/tile.module'; +/** + * @docsIncludeIds SkyTileComponent, SkyTileTitleComponent, SkyTileSummaryComponent, SkyTileContentComponent, SkyTileContentSectionComponent, SkyTileDashboardComponent, SkyTileDashboardService, SkyTileDashboardConfig, SkyTileDashboardConfigLayout, SkyTileDashboardConfigLayoutColumn, SkyTileDashboardConfigLayoutTile, SkyTileDashboardConfigTile, SkyTileDashboardConfigReorderData, SkyTileDashboardMessage, SkyTileDashboardMessageType, SkyTileHarness, SkyTileHarnessFilters, SkyTileContentHarness, SkyTileContentSectionHarness, SkyTileContentSectionHarnessFilters, SkyTileDashboardHarness, SkyTileDashboardHarnessFilters + */ @NgModule({ exports: [ SkyTileContentModule, diff --git a/libs/components/toast/src/lib/modules/toast/toast.module.ts b/libs/components/toast/src/lib/modules/toast/toast.module.ts index 47d3764020..3906925f43 100644 --- a/libs/components/toast/src/lib/modules/toast/toast.module.ts +++ b/libs/components/toast/src/lib/modules/toast/toast.module.ts @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core'; import { SkyToastComponent } from './toast.component'; +/** + * @docsIncludeIds SkyToastService, SkyToastConfig, SkyToastType, SkyToastInstance, SkyToastContainerOptions, SkyToastDisplayDirection + */ @NgModule({ imports: [SkyToastComponent], exports: [SkyToastComponent], diff --git a/libs/components/validation/src/lib/modules/email-validation/email-validation.module.ts b/libs/components/validation/src/lib/modules/email-validation/email-validation.module.ts index 39c64cd0d5..4e56afdcf7 100644 --- a/libs/components/validation/src/lib/modules/email-validation/email-validation.module.ts +++ b/libs/components/validation/src/lib/modules/email-validation/email-validation.module.ts @@ -3,6 +3,9 @@ import { FormsModule } from '@angular/forms'; import { SkyEmailValidationDirective } from './email-validation.directive'; +/** + * @docsIncludeIds SkyEmailValidationDirective + */ @NgModule({ declarations: [SkyEmailValidationDirective], imports: [FormsModule], diff --git a/libs/components/validation/src/lib/modules/url-validation/url-validation.module.ts b/libs/components/validation/src/lib/modules/url-validation/url-validation.module.ts index 7221a883c2..5fc216aba6 100644 --- a/libs/components/validation/src/lib/modules/url-validation/url-validation.module.ts +++ b/libs/components/validation/src/lib/modules/url-validation/url-validation.module.ts @@ -3,6 +3,9 @@ import { FormsModule } from '@angular/forms'; import { SkyUrlValidationDirective } from './url-validation.directive'; +/** + * @docsIncludeIds SkyUrlValidationDirective, SkyUrlValidationOptions + */ @NgModule({ declarations: [SkyUrlValidationDirective], imports: [FormsModule], diff --git a/scripts/__snapshots__/deprecations.json b/scripts/__snapshots__/deprecations.json index f0122e1ab6..871eb1a32f 100644 --- a/scripts/__snapshots__/deprecations.json +++ b/scripts/__snapshots__/deprecations.json @@ -102,6 +102,8 @@ "@skyux/icon:SkyIconStackItem:iconType", "@skyux/icon:SkyIconType", "@skyux/indicators/testing:SkyAlertFixture", + "@skyux/indicators/testing:SkyHelpInlineHarness", + "@skyux/indicators/testing:SkyHelpInlineHarnessFilters", "@skyux/layout:SkyActionButtonContainerAlignItems", "@skyux/layout:SkyActionButtonIconComponent:iconType", "@skyux/layout:SkyBoxComponent:ariaLabel",