UNPKG

@skyux/layout

Version:

This library was generated with [Nx](https://nx.dev).

1,069 lines (997 loc) 56.5 kB
import * as i7 from '@angular/router'; import { NavigationExtras } from '@angular/router'; import * as i0 from '@angular/core'; import { EventEmitter, ChangeDetectorRef, RendererFactory2, ElementRef, AfterViewInit, OnDestroy, OnInit, QueryList, TemplateRef, AfterContentInit, OnChanges, SimpleChanges } from '@angular/core'; import * as i9 from '@skyux/router'; import { SkyHrefChange } from '@skyux/router'; import * as i7$1 from '@skyux/core'; import { SkyCoreAdapterService, SkyAppWindowRef, SkyScrollableHostService, SkyDockService, SkyLogService } from '@skyux/core'; import * as i1 from '@skyux/theme'; import { SkyThemeService } from '@skyux/theme'; import * as i5 from '@angular/common'; import * as i6 from '@angular/cdk/observers'; import { Observable, Subject, BehaviorSubject } from 'rxjs'; import * as i1$1 from '@skyux/i18n'; import { SkyLibResourcesService } from '@skyux/i18n'; import * as i5$1 from '@skyux/help-inline'; import * as i6$1 from '@angular/forms'; import * as i7$2 from '@skyux/forms'; import * as i4 from '@skyux/indicators'; import { SkyModalService } from '@skyux/modals'; /** * Specifies an Angular router link with the `route` property or a direct * link with the `url` property. If it provides both, the action button uses * the `route` property. */ interface SkyActionButtonPermalink { /** * The Angular router link for the action button. This property accepts a * custom object with a `commands` property to specify router commands and an `extras` * property to specify * [Angular `NavigationExtras`](https://angular.dev/api/router/NavigationExtras). * This property passes the following properties: * - `permalink.route?.extras?.fragment` to * [`fragment`](https://angular.dev/api/router/NavigationExtras#fragment) * - `permalink.route?.extras?.queryParams` to * [`queryParams`](https://angular.dev/api/router/NavigationExtras#queryParams) * - `permalink.route?.extras?.queryParamsHandling` to * [`queryParamsHandling`](https://angular.dev/api/router/NavigationExtras#queryParamsHandling) * - `permalink.route?.commands` to * [`routerLink`](https://angular.dev/api/router/RouterLink) */ route?: { commands?: any[] | string; extras?: NavigationExtras; }; /** * The direct link for the action button. */ url?: string; } /** * Creates a button to present users with an option to move forward with tasks. */ declare class SkyActionButtonComponent { #private; hidden: boolean; /** * The link for the action button. */ permalink: SkyActionButtonPermalink | undefined; /** * Fires when users select the action button. */ actionClick: EventEmitter<any>; constructor(changeDetector: ChangeDetectorRef); buttonClicked(): void; enterPress(): void; onSkyHrefDisplayChange($event: SkyHrefChange): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonComponent, [{ skipSelf: true; }]>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyActionButtonComponent, "sky-action-button", never, { "permalink": { "alias": "permalink"; "required": false; }; }, { "actionClick": "actionClick"; }, never, ["sky-action-button-icon", "sky-action-button-header", "sky-action-button-details"], false, never>; } /** * @internal */ declare class SkyActionButtonAdapterService { #private; constructor(rendererFactory: RendererFactory2); getParentWidth(element: ElementRef): number | undefined; setResponsiveClass(element: ElementRef, width?: number): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonAdapterService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyActionButtonAdapterService>; } type SkyActionButtonContainerAlignItemsType = 'center' | 'left'; /** * Wraps action buttons to ensures that they have consistent height and spacing. * @required */ declare class SkyActionButtonContainerComponent implements AfterViewInit, OnDestroy, OnInit { #private; /** * How to display the action buttons inside the action button container. * Options are `"center"` or `"left"`. * @default "center" */ set alignItems(value: SkyActionButtonContainerAlignItemsType | undefined); get alignItems(): SkyActionButtonContainerAlignItemsType; actionButtons: QueryList<SkyActionButtonComponent> | undefined; containerRef: ElementRef | undefined; constructor(actionButtonAdapterService: SkyActionButtonAdapterService, changeDetector: ChangeDetectorRef, coreAdapterService: SkyCoreAdapterService, hostElRef: ElementRef, themeSvc?: SkyThemeService); ngOnInit(): void; ngAfterViewInit(): void; ngOnDestroy(): void; onContentChange(): void; onWindowResize(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonContainerComponent, [null, null, null, null, { optional: true; }]>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyActionButtonContainerComponent, "sky-action-button-container", never, { "alignItems": { "alias": "alignItems"; "required": false; }; }, {}, ["actionButtons"], ["*"], false, [{ directive: typeof i1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>; } /** * Specifies a description to display on an action button. */ declare class SkyActionButtonDetailsComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonDetailsComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyActionButtonDetailsComponent, "sky-action-button-details", never, {}, {}, never, ["*"], false, never>; } /** * Specifies a header to display on an action button. */ declare class SkyActionButtonHeaderComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonHeaderComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyActionButtonHeaderComponent, "sky-action-button-header", never, {}, {}, never, ["*"], false, [{ directive: typeof i1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>; } /** * Specifies an icon to display on the action button. */ declare class SkyActionButtonIconComponent { /** * The name of the Blackbaud SVG icon to display. */ iconName: string; protected readonly breakpoint: i0.Signal<"xs" | "sm" | "md" | "lg" | undefined>; static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonIconComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyActionButtonIconComponent, "sky-action-button-icon", never, { "iconName": { "alias": "iconName"; "required": true; }; }, {}, never, never, true, never>; } declare class SkyActionButtonModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyActionButtonModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyActionButtonModule, [typeof SkyActionButtonComponent, typeof SkyActionButtonContainerComponent, typeof SkyActionButtonDetailsComponent, typeof SkyActionButtonHeaderComponent], [typeof i5.CommonModule, typeof i6.ObserversModule, typeof i7.RouterModule, typeof SkyActionButtonIconComponent, typeof i9.SkyHrefModule, typeof i1.SkyThemeModule], [typeof SkyActionButtonComponent, typeof SkyActionButtonContainerComponent, typeof SkyActionButtonDetailsComponent, typeof SkyActionButtonHeaderComponent, typeof SkyActionButtonIconComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyActionButtonModule>; } /** * @deprecated Use `SkyActionButtonContainerAlignItemsType` instead. * @internal */ declare const enum SkyActionButtonContainerAlignItems { /** * Displays the action buttons as center-aligned. */ Center = "center", /** * Displays the action buttons as left-aligned. */ Left = "left" } /** * @internal */ declare class SkyBackToTopComponent { #private; get scrollToTopClick(): Observable<void>; onScrollToTopClick(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyBackToTopComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyBackToTopComponent, "sky-back-to-top", never, {}, {}, never, never, false, never>; } /** * @internal */ declare class SkyBackToTopDomAdapterService implements OnDestroy { #private; constructor(windowRef: SkyAppWindowRef, scrollableHostService: SkyScrollableHostService); ngOnDestroy(): void; /** * This event returns a boolean on scroll indicating whether the provided element is in view. * @param elementRef The target element reference. */ elementInViewOnScroll(elementRef: ElementRef): Observable<boolean>; /** * Scrolls the window or scrollable parent to the provided element. * @param elementRef The target element reference. */ scrollToElement(elementRef: ElementRef): void; isElementScrolledInView(element: ElementRef): boolean; static ɵfac: i0.ɵɵFactoryDeclaration<SkyBackToTopDomAdapterService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyBackToTopDomAdapterService>; } /** * The type of message to send to the back to top component. */ declare enum SkyBackToTopMessageType { /** * Scrolls the element back to the top. */ BackToTop = 0 } /** * Specifies messages to send to the back to top component. */ interface SkyBackToTopMessage { /** * The type of message to send. */ type?: SkyBackToTopMessageType; } /** * Specifies options for the back to top component. */ interface SkyBackToTopOptions { /** * Whether to hide the back to top button. * @default false */ buttonHidden?: boolean; } /** * Associates a button with an element on the page and displays that button * to return to the element after users scroll away. */ declare class SkyBackToTopDirective implements AfterViewInit, OnDestroy { #private; /** * Configuration options for the back to top component. */ set skyBackToTop(value: SkyBackToTopOptions | '' | undefined); /** * The observable to send commands to the back to top component. * The commands respect the `SkyBackToTopMessage` type. */ set skyBackToTopMessageStream(value: Subject<SkyBackToTopMessage> | undefined); constructor(dockService: SkyDockService, domAdapter: SkyBackToTopDomAdapterService, elementRef: ElementRef); ngAfterViewInit(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyBackToTopDirective, never>; static ɵdir: i0.ɵɵDirectiveDeclaration<SkyBackToTopDirective, "[skyBackToTop]", never, { "skyBackToTop": { "alias": "skyBackToTop"; "required": false; }; "skyBackToTopMessageStream": { "alias": "skyBackToTopMessageStream"; "required": false; }; }, {}, never, never, false, never>; } /** * Import into any component library module that needs to use resource strings. */ declare class SkyLayoutResourcesModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyLayoutResourcesModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyLayoutResourcesModule, never, never, [typeof i1$1.SkyI18nModule]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyLayoutResourcesModule>; } declare class SkyBackToTopModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyBackToTopModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyBackToTopModule, [typeof SkyBackToTopComponent, typeof SkyBackToTopDirective], [typeof SkyLayoutResourcesModule, typeof i1.SkyThemeModule], [typeof SkyBackToTopComponent, typeof SkyBackToTopDirective]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyBackToTopModule>; } type SkyBoxHeadingLevel = 2 | 3 | 4 | 5; type SkyBoxHeadingStyle = 2 | 3 | 4 | 5; /** * Specifies the controls to display in upper right corner of the box. These buttons typically let users edit the box content. */ declare class SkyBoxControlsComponent { #private; boxHasHeader(value: boolean): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxControlsComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyBoxControlsComponent, "sky-box-controls", never, {}, {}, never, ["*"], false, never>; } /** * Provides a common look-and-feel for box content with options to display a common box header, specify body content, and display common box controls. */ declare class SkyBoxComponent { #private; /** * The text to display as the box's heading. */ set headingText(value: string | undefined); get headingText(): string | undefined; /** * Indicates whether to hide the `headingText`. */ headingHidden: boolean; /** * The semantic heading level in the document structure. The default is 2. * @default 2 */ headingLevel: SkyBoxHeadingLevel; /** * The heading [font style](https://developer.blackbaud.com/skyux/design/styles/typography#headings). * @default 2 */ set headingStyle(value: SkyBoxHeadingStyle); /** * The content of the help popover. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) * button is added to the box heading. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover) * when clicked using the specified content and optional title. This property only applies when `headingText` is also specified. */ helpPopoverContent: string | TemplateRef<unknown> | undefined; /** * The title of the help popover. This property only applies when `helpPopoverContent` is * also specified. */ helpPopoverTitle: string | undefined; /** * A help key that identifies the global help content to display. When specified along with `headingText`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) * button is placed beside the box heading. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help) * as configured by the application. This property only applies when `headingText` is also specified. */ helpKey: string | undefined; /** * The ARIA label for the box. This sets the box's `aria-label` attribute to provide a text equivalent for screen readers * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility). * If the box includes a visible label, use `ariaLabelledBy` instead. * For more information about the `aria-label` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-label). * @deprecated Use `headingText` instead. */ ariaLabel: string | undefined; /** * The HTML element ID of the element that labels * the box. This sets the box's `aria-labelledby` attribute to provide a text equivalent for screen readers * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility). * If the box does not include a visible label, use `ariaLabel` instead. * For more information about the `aria-labelledby` attribute, see the [WAI-ARIA definition](https://www.w3.org/TR/wai-aria/#aria-labelledby). * @deprecated Use `headingText` instead. */ ariaLabelledBy: string | undefined; /** * The ARIA role for the box * [to support accessibility](https://developer.blackbaud.com/skyux/learn/accessibility) * by indicating what the box contains. For information about * how an ARIA role indicates what an item represents on a web page, * see the [WAI-ARIA roles model](https://www.w3.org/WAI/PF/aria/#roles). */ ariaRole: string | undefined; set boxHeaderRef(value: ElementRef | undefined); set boxControls(value: SkyBoxControlsComponent | undefined); headerId: string; protected headingClass: string; static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyBoxComponent, "sky-box", never, { "headingText": { "alias": "headingText"; "required": false; }; "headingHidden": { "alias": "headingHidden"; "required": false; }; "headingLevel": { "alias": "headingLevel"; "required": false; }; "headingStyle": { "alias": "headingStyle"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; "ariaRole": { "alias": "ariaRole"; "required": false; }; }, {}, ["boxHeaderRef", "boxControls"], ["sky-box-header", "sky-box-controls", "*"], false, never>; static ngAcceptInputType_headingHidden: unknown; static ngAcceptInputType_headingLevel: unknown; static ngAcceptInputType_headingStyle: unknown; } /** * Specifies a header for the box. * @deprecated Use `headingText` input on the `sky-box` component instead. */ declare class SkyBoxHeaderComponent { protected readonly boxHeaderId: string; constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxHeaderComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyBoxHeaderComponent, "sky-box-header", never, {}, {}, never, ["*", ".sky-control-help"], false, never>; } /** * Specifies the body content to display inside the box and provides padding around that content. */ declare class SkyBoxContentComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxContentComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyBoxContentComponent, "sky-box-content", never, {}, {}, never, ["*"], false, never>; } declare class SkyBoxModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyBoxModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyBoxModule, [typeof SkyBoxComponent, typeof SkyBoxHeaderComponent, typeof SkyBoxContentComponent, typeof SkyBoxControlsComponent], [typeof i5$1.SkyHelpInlineModule, typeof i1.SkyThemeModule, typeof i7$1.SkyTrimModule], [typeof SkyBoxComponent, typeof SkyBoxHeaderComponent, typeof SkyBoxContentComponent, typeof SkyBoxControlsComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyBoxModule>; } /** * Specifies an action that users can perform on the card. * @deprecated */ declare class SkyCardActionsComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyCardActionsComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyCardActionsComponent, "sky-card-actions", never, {}, {}, never, ["*"], false, [{ directive: typeof i1.SkyThemeComponentClassDirective; inputs: {}; outputs: {}; }]>; } /** * @internal */ declare class SkyInlineDeleteAdapterService { #private; constructor(coreAdapterService: SkyCoreAdapterService, rendererFactory: RendererFactory2); clearListeners(): void; setEl(element: HTMLElement): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyInlineDeleteAdapterService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyInlineDeleteAdapterService>; } /** * The type of inline delete that is shown. * @internal */ declare enum SkyInlineDeleteType { /** * The standard styling for inline deletes. */ Standard = "standard", /** * The styling for inline delete components which are used in card components. */ Card = "card" } declare class SkyInlineDeleteComponent implements OnDestroy { #private; /** * Whether the deletion is pending. * @default false */ pending: boolean | undefined; /** * Fires when users click the cancel button. */ cancelTriggered: EventEmitter<void>; /** * Fires when users click the delete button. */ deleteTriggered: EventEmitter<void>; assistiveTextId: string; type: SkyInlineDeleteType; deleteButton: ElementRef | undefined; protected readonly enterAnimationTrigger: i0.WritableSignal<boolean>; constructor(adapterService: SkyInlineDeleteAdapterService, changeDetector: ChangeDetectorRef, elRef: ElementRef); protected onAnimationEnd(): void; ngOnDestroy(): void; /** * @internal */ onCancelClick(): void; /** * @internal */ onDeleteClick(): void; /** * Sets the inline delete to one of its predefined types. * @param type The inline delete type * @internal */ setType(type: SkyInlineDeleteType): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyInlineDeleteComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyInlineDeleteComponent, "sky-inline-delete", never, { "pending": { "alias": "pending"; "required": false; }; }, { "cancelTriggered": "cancelTriggered"; "deleteTriggered": "deleteTriggered"; }, never, never, false, never>; } /** * Specifies a title to identify what the card represents. * @deprecated */ declare class SkyCardTitleComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyCardTitleComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyCardTitleComponent, "sky-card-title", never, {}, {}, never, ["*"], false, never>; } /** * Creates a a small container to highlight important information. * @deprecated `SkyCardComponent` 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. */ declare class SkyCardComponent implements AfterContentInit, OnDestroy { #private; /** * The size of the card. The valid options are `"large"` and `"small"`. * @default "large" */ set size(value: string | undefined); get size(): string; /** * Whether to display a checkbox to the right of the card title. * Users can select multiple checkboxes and perform actions on the selected cards. * @default false */ selectable: boolean | undefined; /** * Whether the card is selected. This only applies to card where * `selectable` is set to `true`. * @default false */ selected: boolean | undefined; /** * Fires when users select or deselect the card. */ selectedChange: EventEmitter<boolean>; inlineDeleteComponent: QueryList<SkyInlineDeleteComponent> | undefined; titleComponent: QueryList<SkyCardTitleComponent> | undefined; showTitle: boolean; constructor(logger: SkyLogService); ngAfterContentInit(): void; contentClick(): void; onCheckboxChange(newValue: boolean): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyCardComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyCardComponent, "sky-card", never, { "size": { "alias": "size"; "required": false; }; "selectable": { "alias": "selectable"; "required": false; }; "selected": { "alias": "selected"; "required": false; }; }, { "selectedChange": "selectedChange"; }, ["inlineDeleteComponent", "titleComponent"], ["sky-inline-delete", "sky-card-title", "sky-card-content", "sky-card-actions"], false, never>; } /** * Specifies the content to display in the body of the card. * @deprecated */ declare class SkyCardContentComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyCardContentComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyCardContentComponent, "sky-card-content", never, {}, {}, never, ["*"], false, never>; } declare class SkyInlineDeleteModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyInlineDeleteModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyInlineDeleteModule, [typeof SkyInlineDeleteComponent], [typeof i7$1._SkyAnimationEndHandlerDirective, typeof SkyLayoutResourcesModule, typeof i4.SkyWaitModule], [typeof SkyInlineDeleteComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyInlineDeleteModule>; } /** * @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. */ declare class SkyCardModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyCardModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyCardModule, [typeof SkyCardActionsComponent, typeof SkyCardComponent, typeof SkyCardContentComponent, typeof SkyCardTitleComponent], [typeof i5.CommonModule, typeof i6$1.FormsModule, typeof i7$2.SkyCheckboxModule, typeof SkyLayoutResourcesModule, typeof SkyInlineDeleteModule], [typeof SkyCardActionsComponent, typeof SkyCardComponent, typeof SkyCardContentComponent, typeof SkyCardTitleComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyCardModule>; } /** * @internal */ declare class SkyDefinitionListService { labelWidth: BehaviorSubject<string | undefined>; defaultValue: BehaviorSubject<string | undefined>; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyDefinitionListService>; } /** * Creates a definition list to display label-value pairs. * @deprecated Use `SkyDescriptionListComponent` instead. */ declare class SkyDefinitionListComponent { service: SkyDefinitionListService; /** * The width of the label portion of the definition list. * @default "90px" */ set labelWidth(value: string | undefined); /** * The default value to display when no value is provided * for a label-value pair. * @default "None found" */ set defaultValue(value: string | undefined); constructor(service: SkyDefinitionListService, logger: SkyLogService); static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDefinitionListComponent, "sky-definition-list", never, { "labelWidth": { "alias": "labelWidth"; "required": false; }; "defaultValue": { "alias": "defaultValue"; "required": false; }; }, {}, never, ["sky-definition-list-heading", "sky-definition-list-content"], false, never>; } /** * Wraps the label-value pairs in the definition list. * @deprecated Use `SkyDescriptionListContentComponent` instead. */ declare class SkyDefinitionListContentComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListContentComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDefinitionListContentComponent, "sky-definition-list-content", never, {}, {}, never, ["*"], false, never>; } /** * Specifies a title for the definition list. * @deprecated */ declare class SkyDefinitionListHeadingComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListHeadingComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDefinitionListHeadingComponent, "sky-definition-list-heading", never, {}, {}, never, ["*"], false, never>; } /** * Specifies the label in a label-value pair. * @deprecated Use `SkyDescriptionListTermComponent` instead. */ declare class SkyDefinitionListLabelComponent { service: SkyDefinitionListService; labelWidth: number | undefined; constructor(service: SkyDefinitionListService); static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListLabelComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDefinitionListLabelComponent, "sky-definition-list-label", never, {}, {}, never, ["*"], false, never>; } /** * Specifies the value in a label-value pair. * @deprecated Use `SkyDescriptionListDescriptionComponent` instead. */ declare class SkyDefinitionListValueComponent { service: SkyDefinitionListService; defaultValue: string | undefined; constructor(service: SkyDefinitionListService); static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListValueComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDefinitionListValueComponent, "sky-definition-list-value", never, {}, {}, never, ["*"], false, never>; } /** * @deprecated Use `SkyDescriptionListModule` instead. */ declare class SkyDefinitionListModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyDefinitionListModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDefinitionListModule, [typeof SkyDefinitionListComponent, typeof SkyDefinitionListContentComponent, typeof SkyDefinitionListHeadingComponent, typeof SkyDefinitionListLabelComponent, typeof SkyDefinitionListValueComponent], [typeof i5.CommonModule, typeof SkyLayoutResourcesModule], [typeof SkyDefinitionListComponent, typeof SkyDefinitionListContentComponent, typeof SkyDefinitionListHeadingComponent, typeof SkyDefinitionListLabelComponent, typeof SkyDefinitionListValueComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyDefinitionListModule>; } /** * @internal */ declare class SkyDescriptionListAdapterService { #private; constructor(rendererFactory: RendererFactory2); getWidth(elementRef: ElementRef): number; setResponsiveClass(element: ElementRef): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListAdapterService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyDescriptionListAdapterService>; } /** * @internal */ declare class SkyDescriptionListService implements OnDestroy { #private; get defaultDescription(): Observable<string>; ngOnDestroy(): void; updateDefaultDescription(value: string): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyDescriptionListService>; } /** * Specifies the description in a term-description pair. */ declare class SkyDescriptionListDescriptionComponent implements OnDestroy, OnInit { #private; service: SkyDescriptionListService; defaultDescription: string | undefined; themeName: string | undefined; templateRef: TemplateRef<unknown> | undefined; constructor(service: SkyDescriptionListService, changeDetector: ChangeDetectorRef, themeSvc?: SkyThemeService); ngOnInit(): void; ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListDescriptionComponent, [null, null, { optional: true; }]>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDescriptionListDescriptionComponent, "sky-description-list-description", never, {}, {}, never, ["*"], false, never>; } /** * Specifies the term in a term-description pair. To display a help button beside * the term, include a help button element in the sky-description-list-term element * and a sky-control-help CSS class on that element. */ declare class SkyDescriptionListTermComponent { templateRef: TemplateRef<unknown> | undefined; protected readonly content: SkyDescriptionListContentComponent | null; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListTermComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDescriptionListTermComponent, "sky-description-list-term", never, {}, {}, never, ["*", ".sky-control-help"], false, never>; } /** * Wraps the term-description pairs in the description list. */ declare class SkyDescriptionListContentComponent { termComponents: QueryList<SkyDescriptionListTermComponent> | undefined; descriptionComponents: QueryList<SkyDescriptionListDescriptionComponent> | undefined; /** * A help key that identifies the global help content to display. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is * placed beside the description list content label. Clicking the button invokes [global help](https://developer.blackbaud.com/skyux/learn/develop/global-help) as configured by the application. */ helpKey: string | undefined; /** * The content of the help popover. When specified, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) * button is added to the description list content. The help inline button displays a [popover](https://developer.blackbaud.com/skyux/components/popover) * when clicked using the specified content and optional title. */ helpPopoverContent: string | TemplateRef<unknown> | undefined; /** * The title of the help popover. This property only applies when `helpPopoverContent` is * also specified. */ helpPopoverTitle: string | undefined; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListContentComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDescriptionListContentComponent, "sky-description-list-content", never, { "helpKey": { "alias": "helpKey"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; }, {}, ["termComponents", "descriptionComponents"], ["*"], false, never>; } /** * How to display the term-description pairs within a description list. */ type SkyDescriptionListModeType = 'horizontal' | 'longDescription' | 'vertical'; /** * Creates a description list to display term-description pairs. */ declare class SkyDescriptionListComponent implements AfterContentInit, OnDestroy { #private; /** * The default description to display when no description is provided * for a term-description pair. * @default "None found" */ set defaultDescription(value: string); /** * The width of term-description pairs when `mode` is set to `"horizontal"`. By default, * the width is responsive based on the width of the container element. */ listItemWidth: string | undefined; /** * How to display term-description pairs within the description list. * @default "vertical" */ set mode(value: SkyDescriptionListModeType | undefined); get mode(): SkyDescriptionListModeType; contentComponents: QueryList<SkyDescriptionListContentComponent> | undefined; elementRef: ElementRef | undefined; constructor(adapterService: SkyDescriptionListAdapterService, changeDetector: ChangeDetectorRef, descriptionListService: SkyDescriptionListService); ngAfterContentInit(): void; ngOnDestroy(): void; onWindowResize(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyDescriptionListComponent, "sky-description-list", never, { "defaultDescription": { "alias": "defaultDescription"; "required": false; }; "listItemWidth": { "alias": "listItemWidth"; "required": false; }; "mode": { "alias": "mode"; "required": false; }; }, {}, ["contentComponents"], never, false, never>; } declare class SkyDescriptionListModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyDescriptionListModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyDescriptionListModule, [typeof SkyDescriptionListComponent, typeof SkyDescriptionListContentComponent, typeof SkyDescriptionListTermComponent, typeof SkyDescriptionListDescriptionComponent], [typeof i5.CommonModule, typeof i5$1.SkyHelpInlineModule, typeof i7$1.SkyIdModule, typeof SkyLayoutResourcesModule, typeof i1.SkyThemeModule, typeof i7$1.SkyTrimModule], [typeof SkyDescriptionListComponent, typeof SkyDescriptionListContentComponent, typeof SkyDescriptionListTermComponent, typeof SkyDescriptionListDescriptionComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyDescriptionListModule>; } /** * @deprecated Use `SkyDescriptionListModeType` instead. * @internal * How to display the term-description pairs within a description list. */ declare enum SkyDescriptionListMode { /** * Displays term-description pairs side by side in a horizontal list. * This mode provides a responsive layout. */ horizontal = "horizontal", /** * Displays terms and descriptions side by side with the term on the left and the description * on the right. This mode includes room for long descriptions and uses a responsive layout * that stacks term-description pairs vertically. */ longDescription = "longDescription", /** * Displays term-description pairs in a vertical list. */ vertical = "vertical" } /** * Displays a row within the `sky-fluid-grid` wrapper. Previously, you could display a row * without a wrapper, but we no longer officially support that option. */ declare class SkyRowComponent { /** * Whether to reverse the display order for columns in the row. * @default false */ reverseColumnOrder: boolean | undefined; static ɵfac: i0.ɵɵFactoryDeclaration<SkyRowComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyRowComponent, "sky-row", never, { "reverseColumnOrder": { "alias": "reverseColumnOrder"; "required": false; }; }, {}, never, ["*"], false, never>; } /** * Displays a column within a row of the fluid grid. */ declare class SkyColumnComponent implements OnInit, OnChanges { #private; /** * The number of columns (1-12) on extra-small screens * (less than 768px). If you do not specify a value, the fluid grid displays * the column at the full width of the screen. * @default 12 */ set screenXSmall(value: number | undefined); get screenXSmall(): number; /** * The number of columns (1-12) on small screens * (768-991px). If you do not specify a value, the column inherits * the `screenXSmall` value. */ screenSmall: number | undefined; /** * The number of columns (1-12) on medium screens * (992-1199px). If you do not specify a value, the column inherits * the `screenSmall` value. */ screenMedium: number | undefined; /** * The number of columns (1-12) on large screens * (more than 1200px). If you do not specify a value, the column * inherits the `screenMedium` value. */ screenLarge: number | undefined; classnames: string | undefined; ngOnChanges(changes: SimpleChanges): void; getClassNames(): string; ngOnInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyColumnComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyColumnComponent, "sky-column", never, { "screenXSmall": { "alias": "screenXSmall"; "required": false; }; "screenSmall": { "alias": "screenSmall"; "required": false; }; "screenMedium": { "alias": "screenMedium"; "required": false; }; "screenLarge": { "alias": "screenLarge"; "required": false; }; }, {}, never, ["*"], false, never>; } type SkyFluidGridGutterSizeType = 'small' | 'medium' | 'large'; /** * Wraps the fluid grid to ensure proper spacing. Without the wrapper, the * alignment, padding, and margins do not behave as expected. */ declare class SkyFluidGridComponent { #private; /** * Disables the outer left and right margin of the fluid grid container. * @default false */ disableMargin: boolean | undefined; /** * The type that defines the size of the padding * between columns. * @default "large" */ set gutterSize(value: SkyFluidGridGutterSizeType | undefined); get gutterSize(): SkyFluidGridGutterSizeType; static ɵfac: i0.ɵɵFactoryDeclaration<SkyFluidGridComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyFluidGridComponent, "sky-fluid-grid", never, { "disableMargin": { "alias": "disableMargin"; "required": false; }; "gutterSize": { "alias": "gutterSize"; "required": false; }; }, {}, never, ["*"], false, never>; } declare class SkyFluidGridModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyFluidGridModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyFluidGridModule, [typeof SkyRowComponent, typeof SkyColumnComponent, typeof SkyFluidGridComponent], [typeof i5.CommonModule], [typeof SkyRowComponent, typeof SkyColumnComponent, typeof SkyFluidGridComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyFluidGridModule>; } /** * @internal */ interface SkyFormatItem { text?: string; templateRef?: TemplateRef<any>; } declare class SkyFormatComponent { #private; itemsForDisplay: SkyFormatItem[]; /** * The tokenized string that represents the template. Tokens use the `{n}` notation * where `n` is the ordinal of the item to replace the token. */ set text(value: string | undefined); get text(): string | undefined; /** * An array of `TemplateRef` objects to be placed in the template, where the `nth` * item is placed at the `{n}` location in the template. */ set args(value: TemplateRef<any>[] | undefined); get args(): TemplateRef<any>[] | undefined; static ɵfac: i0.ɵɵFactoryDeclaration<SkyFormatComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyFormatComponent, "sky-format", never, { "text": { "alias": "text"; "required": false; }; "args": { "alias": "args"; "required": false; }; }, {}, never, never, false, never>; } declare class SkyFormatModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyFormatModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyFormatModule, [typeof SkyFormatComponent], [typeof i5.CommonModule], [typeof SkyFormatComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyFormatModule>; } /** * Displays messages that require immediate attention as [alerts](https://developer.blackbaud.com/skyux/components/alert) within * the page summary. * @deprecated */ declare class SkyPageSummaryAlertComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryAlertComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryAlertComponent, "sky-page-summary-alert", never, {}, {}, never, ["*"], false, never>; } /** * Highlights important information about a page in the key information section of the * page summary. * @deprecated */ declare class SkyPageSummaryKeyInfoComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryKeyInfoComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryKeyInfoComponent, "sky-page-summary-key-info", never, {}, {}, never, ["*"], false, never>; } /** * Specifies the components to display in the page summary. * @deprecated `SkyPageSummaryComponent` 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. */ declare class SkyPageSummaryComponent { #private; protected keyInfoComponents: i0.Signal<readonly SkyPageSummaryKeyInfoComponent[]>; constructor(); static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryComponent, "sky-page-summary", never, {}, {}, ["keyInfoComponents"], ["sky-page-summary-alert", "sky-page-summary-image", "sky-page-summary-title", "sky-page-summary-subtitle", "sky-page-summary-status", "sky-page-summary-content", "sky-page-summary-key-info"], false, never>; } /** * Displays content in the arbitrary section of the page summary. * @deprecated */ declare class SkyPageSummaryContentComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryContentComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryContentComponent, "sky-page-summary-content", never, {}, {}, never, ["*"], false, never>; } /** * Displays an image in the page summary to identify a record * or help users complete a core task. * @deprecated */ declare class SkyPageSummaryImageComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryImageComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryImageComponent, "sky-page-summary-image", never, {}, {}, never, ["*"], false, never>; } /** * Displays [labels](https://developer.blackbaud.com/skyux/components/label) * to highlight important status information about a page's content. * @deprecated */ declare class SkyPageSummaryStatusComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryStatusComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryStatusComponent, "sky-page-summary-status", never, {}, {}, never, ["*"], false, never>; } /** * Specifies a subtitle to identify the page content. * @deprecated */ declare class SkyPageSummarySubtitleComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummarySubtitleComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummarySubtitleComponent, "sky-page-summary-subtitle", never, {}, {}, never, ["*"], false, never>; } /** * Specifies a title to identify the page content. * @deprecated */ declare class SkyPageSummaryTitleComponent { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryTitleComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyPageSummaryTitleComponent, "sky-page-summary-title", never, {}, {}, never, ["*"], false, never>; } /** * @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. */ declare class SkyPageSummaryModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyPageSummaryModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyPageSummaryModule, [typeof SkyPageSummaryAlertComponent, typeof SkyPageSummaryComponent, typeof SkyPageSummaryContentComponent, typeof SkyPageSummaryImageComponent, typeof SkyPageSummaryKeyInfoComponent, typeof SkyPageSummaryStatusComponent, typeof SkyPageSummarySubtitleComponent, typeof SkyPageSummaryTitleComponent], [typeof i5.CommonModule], [typeof SkyPageSummaryAlertComponent, typeof SkyPageSummaryComponent, typeof SkyPageSummaryContentComponent, typeof SkyPageSummaryImageComponent, typeof SkyPageSummaryKeyInfoComponent, typeof SkyPageSummaryStatusComponent, typeof SkyPageSummarySubtitleComponent, typeof SkyPageSummaryTitleComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyPageSummaryModule>; } /** * @internal */ declare class SkyTextExpandAdapterService { #private; constructor(rendererFactory: RendererFactory2); getContainerHeight(containerEl: ElementRef): number; removeContainerMaxHeight(containerEl: ElementRef): void; setContainerMaxHeight(containerEl: ElementRef, height: number): void; setText(textEl: ElementRef, text: string): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyTextExpandAdapterService, never>; static ɵprov: i0.ɵɵInjectableDeclaration<SkyTextExpandAdapterService>; } declare class SkyTextExpandComponent implements AfterContentInit { #private; /** * The title to display when the component expands the full text in a modal. * @default "Expanded view" */ expandModalTitle: string | undefined; /** * The maximum number of text characters to display inline when users select the link * to expand the full text. If the text exceeds this limit, then the component expands * the full text in a modal instead. * @default 600 */ set maxExpandedLength(value: number | undefined); get maxExpandedLength(): number; /** * The maximum number of newline characters to display inline when users select * the link to expand the full text. If the text exceeds this limit, then * the component expands the full text in a modal view instead. * @default 2 */ set maxExpandedNewlines(value: number | undefined); get maxExpandedNewlines(): number; /** * The number of text characters to display before truncating the text. * To avoid truncating text in the middle of a word, the component looks for a space * in the 10 characters before the last character. * @default 200 */ set maxLength(value: number | undefined); get maxLength(): number; /** * The text to truncate. */ set text(value: string | undefined); get text(): string; /** * Whether to replace newline characters in truncated text with spaces. */ truncateNewlines: boolean; buttonText: string; contentSectionId: string; expandable: boolean; isExpanded: boolean | undefined; isModal: boolean; containerEl: ElementRef | undefined; set textEl(value: ElementRef | undefined); get textEl(): ElementRef | undefined; constructor(resources: SkyLibResourcesService, modalSvc: SkyModalService, textExpandAdapter: SkyTextExpandAdapterService); textExpand(): void; animationEnd(): void; ngAfterContentInit(): void; static ɵfac: i0.ɵɵFactoryDeclaration<SkyTextExpandComponent, never>; static ɵcmp: i0.ɵɵComponentDeclaration<SkyTextExpandComponent, "sky-text-expand", never, { "expandModalTitle": { "alias": "expandModalTitle"; "required": false; }; "maxExpandedLength": { "alias": "maxExpandedLength"; "required": false; }; "maxExpandedNewlines": { "alias": "maxExpandedNewlines"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; }; "text": { "alias": "text"; "required": false; }; "truncateNewlines": { "alias": "truncateNewlines"; "required": false; }; }, {}, never, never, true, never>; } declare class SkyTextExpandModule { static ɵfac: i0.ɵɵFactoryDeclaration<SkyTextExpandModule, never>; static ɵmod: i0.ɵɵNgModuleDeclaration<SkyTextExpandModule, never, [typeof SkyTextExpandComponent], [typeof SkyTextExpandComponent]>; static ɵinj: i0.ɵɵInjectorDeclaration<SkyTextExpandModule>; } type SkyTextExpandRepeaterListStyleType = 'unordered' | 'ordered' | 'unstyled'; declare class SkyTextExpandRepeaterComponent<TData = unknown> { #private; /** * The data to truncate. */ readonly data: i0.InputSignal<TData[] | undefined>; /** * The template for items in the list. */ readonly itemTemplate: i0.InputSignal<TemplateRef<unknown> | undefined>; /** * The style of bullet to use * @default "unordered" */ readonly listStyle: i0.InputSignal<SkyTextExpandRepeaterListStyleType | undefined>; /** * The number of items to display before truncating the list. If not supplied, all items are shown. */ readonly maxItems: i0.InputSignalWithTransform<number, unknown>; protected expandable: boolean; contentSectionId: string; protected readonly isExpanded: i0.WritableSignal<boolean>; protected readonly buttonText: i0.Signal<string>; protected containerEl: i0.Signal<ElementRef<any> | undefined>; protected readonly trackedData: i0.Signal<{ item: TData; index: number; }[]>; constructor(); animationEnd(): void; repeaterExpand(): void