Skip to content

Commit

Permalink
feat: add @docsIncludeIds to action bars, tree, autonumeric, avatar…
Browse files Browse the repository at this point in the history
…, colorpicker, core, datetime, errors, flyout, and forms packages (#3074)
  • Loading branch information
Blackbaud-SteveBrush authored Jan 29, 2025
1 parent da19379 commit b5747b2
Show file tree
Hide file tree
Showing 30 changed files with 84 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkySummaryActionBarSecondaryActionsComponent } from './actions/summary-
import { SkySummaryActionBarComponent } from './summary-action-bar.component';
import { SkySummaryActionBarSummaryComponent } from './summary/summary-action-bar-summary.component';

/**
* @docsIncludeIds SkySummaryActionBarComponent, SkySummaryActionBarActionsComponent, SkySummaryActionBarPrimaryActionComponent, SkySummaryActionBarSecondaryActionsComponent, SkySummaryActionBarSecondaryActionComponent, SkySummaryActionBarCancelComponent, SkySummaryActionBarSummaryComponent
*/
@NgModule({
imports: [
SkySummaryActionBarActionsComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import { SkyAngularTreeNodeComponent } from './angular-tree-node.component';
import { SkyTreeViewToolbarComponent } from './angular-tree-toolbar.component';
import { SkyAngularTreeWrapperComponent } from './angular-tree-wrapper.component';

/**
* @docsIncludeIds SkyAngularTreeWrapperComponent, SkyAngularTreeNodeComponent
*/
@NgModule({
declarations: [
SkyAngularTreeContextMenuComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { FormsModule, ReactiveFormsModule } from '@angular/forms';

import { SkyAutonumericDirective } from './autonumeric.directive';

/**
* @docsIncludeIds SkyAutonumericDirective, SkyAutonumericOptions, SkyAutonumericOptionsProvider
*/
@NgModule({
declarations: [SkyAutonumericDirective],
imports: [FormsModule, ReactiveFormsModule],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyAvatarResourcesModule } from '../shared/sky-avatar-resources.module'
import { SkyAvatarComponent } from './avatar.component';
import { SkyAvatarInnerComponent } from './avatar.inner.component';

/**
* @docsIncludeIds SkyAvatarComponent, SkyAvatarSize, SkyAvatarSrc, SkyAvatarHarness
*/
@NgModule({
declarations: [SkyAvatarInnerComponent, SkyAvatarComponent],
imports: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ import { SkyColorpickerSliderDirective } from './colorpicker-slider.directive';
import { SkyColorpickerTextDirective } from './colorpicker-text.directive';
import { SkyColorpickerComponent } from './colorpicker.component';

/**
* @docsIncludeIds SkyColorpickerComponent, SkyColorpickerInputDirective, SkyColorpickerCmyk, SkyColorpickerHsla, SkyColorpickerHsva, SkyColorpickerMessage, SkyColorpickerMessageType, SkyColorpickerOutput, SkyColorpickerResult, SkyColorpickerRgba, SkyColorpickerHarness, SkyColorpickerHarnessFilters, SkyColorpickerDropdownHarness, SkyColorpickerDropdownHarnessFilters
*/
@NgModule({
declarations: [
SkyColorpickerComponent,
Expand Down
3 changes: 3 additions & 0 deletions libs/components/core/src/lib/modules/affix/affix.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { NgModule } from '@angular/core';

import { SkyAffixDirective } from './affix.directive';

/**
* @docsIncludeIds SkyAffixDirective, SkyAffixService, SkyAffixer, SkyAffixConfig, SkyAffixAutoFitContext, SkyAffixHorizontalAlignment, SkyAffixOffset, SkyAffixOffsetChange, SkyAffixPlacement, SkyAffixPlacementChange, SkyAffixPosition, SkyAffixVerticalAlignment
*/
@NgModule({
imports: [CommonModule],
exports: [SkyAffixDirective],
Expand Down
1 change: 1 addition & 0 deletions libs/components/core/src/lib/modules/dock/dock.service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { sortByStackOrder } from './sort-by-stack-order';

/**
* This service docks components to specific areas on the page.
* @docsIncludeIds SkyDockOptions, SkyDockInsertComponentConfig, SkyDockLocation, SkyDockItem, SkyDockItemConfig
*/
@Injectable({
providedIn: 'root',
Expand Down
3 changes: 3 additions & 0 deletions libs/components/core/src/lib/modules/id/id.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyIdDirective } from './id.directive';

/**
* @docsIncludeIds SkyIdDirective, SkyIdService
*/
@NgModule({
declarations: [SkyIdDirective],
exports: [SkyIdDirective],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ const DEFAULT_BREAKPOINT = SkyMediaBreakpoints.md;

/**
* Utility used to subscribe to viewport and container breakpoint changes.
* @docsIncludeIds SkyMediaBreakpoints, SkyMediaQueryListener, provideSkyMediaQueryTesting, SkyMediaQueryTestingController
*/
@Injectable({
providedIn: 'root',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import { SkyCoreResourcesModule } from '../shared/sky-core-resources.module';

import { SkyNumericPipe } from './numeric.pipe';

/**
* @docsIncludeIds SkyNumericPipe, SkyNumericService, SkyNumericOptions
*/
@NgModule({
declarations: [SkyNumericPipe],
providers: [SkyNumericPipe],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ import { SkyCoreResourcesModule } from '../shared/sky-core-resources.module';

import { SkyPercentPipe } from './percent.pipe';

/**
* @docsIncludeIds SkyPercentPipe
*/
@NgModule({
declarations: [SkyPercentPipe],
providers: [SkyPercentPipe],
Expand Down
3 changes: 3 additions & 0 deletions libs/components/core/src/lib/modules/trim/trim.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyTrimDirective } from './trim.directive';

/**
* @docsIncludeIds SkyTrimDirective
*/
@NgModule({
declarations: [SkyTrimDirective],
exports: [SkyTrimDirective],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyViewkeeperDirective } from './viewkeeper.directive';

/**
* @docsIncludeIds SkyViewkeeperDirective, SkyViewkeeperService, SkyViewkeeperOptions, SkyViewkeeperHostOptions
*/
@NgModule({
declarations: [SkyViewkeeperDirective],
exports: [SkyViewkeeperDirective],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { SkyHelpTestingService } from './help-testing.service';

/**
* Mocks SkyHelpService to enable testing of global help.
* @docsIncludeIds SkyHelpTestingController
*/
@NgModule({
providers: [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyDatetimeResourcesModule } from '../shared/sky-datetime-resources.mod
import { SkyDatePipe } from './date.pipe';
import { SkyFuzzyDatePipe } from './fuzzy-date.pipe';

/**
* @docsIncludeIds SkyDatePipe, SkyFuzzyDatePipe
*/
@NgModule({
declarations: [SkyDatePipe, SkyFuzzyDatePipe],
providers: [SkyDatePipe, SkyFuzzyDatePipe],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ import { SkyFormErrorModule } from '@skyux/forms';

import { SkyDateRangePickerComponent } from './date-range-picker.component';

/**
* @docsIncludeIds SkyDateRangePickerComponent, SkyDateRangeService, SkyDateRange, SkyDateRangeCalculation, SkyDateRangeCalculator, SkyDateRangeCalculatorConfig, SkyDateRangeCalculatorId, SkyDateRangeCalculatorType, SkyDateRangeCalculatorGetValueFunction, SkyDateRangeCalculatorValidateFunction, SkyDateRangePickerHarness, SkyDateRangePickerFilters
*/
@NgModule({
exports: [SkyDateRangePickerComponent, SkyFormErrorModule],
imports: [SkyDateRangePickerComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import { SkyDatepickerInputDirective } from './datepicker-input.directive';
import { SkyDatepickerComponent } from './datepicker.component';
import { SkyFuzzyDatepickerInputDirective } from './fuzzy/datepicker-input-fuzzy.directive';

/**
* @docsIncludeIds SkyDatepickerComponent, SkyDatepickerInputDirective, SkyDatepickerCalendarChange, SkyDatepickerConfigService, SkyDatepickerCustomDate, SkyFuzzyDatepickerInputDirective, SkyFuzzyDate, SkyDatepickerHarness, SkyDatepickerFilters, SkyDatepickerCalendarHarness, SkyDatepickerCalendarHarnessFilters
*/
@NgModule({
imports: [
SkyDatepickerCalendarComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyDatetimeResourcesModule } from '../shared/sky-datetime-resources.mod
import { SkyTimepickerComponent } from './timepicker.component';
import { SkyTimepickerInputDirective } from './timepicker.directive';

/**
* @docsIncludeIds SkyTimepickerComponent, SkyTimepickerInputDirective, SkyTimepickerTimeFormatType, SkyTimepickerTimeOutput
*/
@NgModule({
declarations: [SkyTimepickerInputDirective, SkyTimepickerComponent],
imports: [
Expand Down
3 changes: 3 additions & 0 deletions libs/components/errors/src/lib/modules/error/error.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ import { SkyErrorImageComponent } from './error-image.component';
import { SkyErrorTitleComponent } from './error-title.component';
import { SkyErrorComponent } from './error.component';

/**
* @docsIncludeIds SkyErrorComponent, SkyErrorImageComponent, SkyErrorTitleComponent, SkyErrorDescriptionComponent, SkyErrorActionComponent, SkyErrorType, SkyErrorModalService, ErrorModalConfig
*/
@NgModule({
declarations: [
SkyErrorComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyFlyoutComponent } from './flyout.component';

/**
* @docsIncludeIds SkyFlyoutService, SkyFlyoutConfig, SkyFlyoutInstance, SkyFlyoutAction, SkyFlyoutBeforeCloseHandler, SkyFlyoutCloseArgs, SkyFlyoutPermalink
*/
@NgModule({
imports: [SkyFlyoutComponent],
exports: [SkyFlyoutComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkyCharacterCounterIndicatorComponent } from './character-counter-indic
import { SkyCharacterCounterScreenReaderPipe } from './character-counter-screen-reader.pipe';
import { SkyCharacterCounterInputDirective } from './character-counter.directive';

/**
* @docsIncludeIds SkyCharacterCounterIndicatorComponent, SkyCharacterCounterInputDirective, SkyCharacterCounterScreenReaderPipe, SkyCharacterCounterIndicatorHarness
*/
@NgModule({
declarations: [
SkyCharacterCounterInputDirective,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ import { SkyCheckboxLabelTextLabelComponent } from './checkbox-label-text-label.
import { SkyCheckboxLabelComponent } from './checkbox-label.component';
import { SkyCheckboxComponent } from './checkbox.component';

/**
* @docsIncludeIds SkyCheckboxComponent, SkyCheckboxGroupComponent, SkyCheckboxLabelComponent, SkyCheckboxChange, SkyCheckboxGroupHeadingLevel, SkyCheckboxGroupHeadingStyle, SkyCheckboxHarness, SkyCheckboxGroupHarness
*/
@NgModule({
declarations: [
SkyCheckboxComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyFieldGroupComponent } from './field-group.component';

/**
* @docsIncludeIds SkyFieldGroupComponent, SkyFieldGroupHeadingLevel, SkyFieldGroupHeadingStyle, SkyFieldGroupHarness
*/
@NgModule({
imports: [SkyFieldGroupComponent],
exports: [SkyFieldGroupComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyFormErrorModule } from '../../form-error/form-error.module';
import { SkyFileAttachmentLabelComponent } from './file-attachment-label.component';
import { SkyFileAttachmentComponent } from './file-attachment.component';

/**
* @docsIncludeIds SkyFileAttachmentComponent, SkyFileAttachmentLabelComponent, SkyFileAttachmentChange, SkyFileAttachmentClick, SkyFileLink, SkyFileItemErrorType, SkyFileItem, SkyFileValidateFn, SkyFileAttachmentHarness, provideSkyFileAttachmentTesting
*/
@NgModule({
exports: [
SkyFileAttachmentComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ import { SkyFormErrorModule } from '../../form-error/form-error.module';
import { SkyFileDropComponent } from './file-drop.component';
import { SkyFileItemComponent } from './file-item.component';

/**
* @docsIncludeIds SkyFileDropComponent, SkyFileItemComponent, SkyFileDropChange, SkyFileLink, SkyFileItem, SkyFileValidateFn, SkyFileDropHarness, SkyFileItemHarness, SkyFileItemHarnessFilters, provideSkyFileAttachmentTesting
*/
@NgModule({
exports: [SkyFileDropComponent, SkyFileItemComponent, SkyFormErrorModule],
imports: [SkyFileDropComponent, SkyFileItemComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import { NgModule } from '@angular/core';

import { SkyFormErrorComponent } from './form-error.component';

/**
* @docsIncludeIds SkyFormErrorComponent, SkyFormErrorsHarness, SkyFormErrorsHarnessFilters, SkyFormErrorHarness, SkyFormErrorHarnessFilters
*/
@NgModule({
imports: [SkyFormErrorComponent],
exports: [SkyFormErrorComponent],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ import { SkyInputBoxControlDirective } from './input-box-control.directive';
import { SkyInputBoxHintTextPipe } from './input-box-hint-text.pipe';
import { SkyInputBoxComponent } from './input-box.component';

/**
* @docsIncludeIds SkyInputBoxComponent, SkyInputBoxHarness
*/
@NgModule({
declarations: [SkyInputBoxComponent],
imports: [
Expand Down
3 changes: 3 additions & 0 deletions libs/components/forms/src/lib/modules/radio/radio.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ import { SkyRadioGroupComponent } from './radio-group.component';
import { SkyRadioLabelComponent } from './radio-label.component';
import { SkyRadioComponent } from './radio.component';

/**
* @docsIncludeIds SkyRadioGroupComponent, SkyRadioComponent, SkyRadioLabelComponent, SkyRadioGroupHeadingLevel, SkyRadioGroupHeadingStyle, SkyRadioChange, SkyRadioType, SkyRadioGroupHarness, SkyRadioHarness
*/
@NgModule({
declarations: [
SkyRadioComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@ import { SkySelectionBoxGridComponent } from './selection-box-grid.component';
import { SkySelectionBoxHeaderComponent } from './selection-box-header.component';
import { SkySelectionBoxComponent } from './selection-box.component';

/**
* @docsIncludeIds SkySelectionBoxComponent, SkySelectionBoxHeaderComponent, SkySelectionBoxDescriptionComponent, SkySelectionBoxGridComponent
*/
@NgModule({
declarations: [
SkySelectionBoxGridComponent,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ import { SkyHelpInlineModule } from '@skyux/help-inline';
import { SkyToggleSwitchLabelComponent } from './toggle-switch-label.component';
import { SkyToggleSwitchComponent } from './toggle-switch.component';

/**
* @docsIncludeIds SkyToggleSwitchComponent, SkyToggleSwitchLabelComponent, SkyToggleSwitchChange
*/
@NgModule({
declarations: [SkyToggleSwitchLabelComponent, SkyToggleSwitchComponent],
imports: [
Expand Down

0 comments on commit b5747b2

Please sign in to comment.