import * as i0 from '@angular/core'; import { OnInit, TemplateRef, ChangeDetectorRef, AfterContentInit, OnDestroy, EventEmitter, QueryList, PipeTransform, AfterViewInit } from '@angular/core'; import * as i15 from '@skyux/core'; import { SkyAppWindowRef, SkyLogService } from '@skyux/core'; import { Subject } from 'rxjs'; import * as i14 from '@skyux/theme'; import { SkyThemeService } from '@skyux/theme'; import * as i10 from '@angular/common'; import * as i11 from '@skyux/help-inline'; import * as i12 from '@skyux/icon'; import * as i1 from '@skyux/i18n'; declare enum SkyProgressIndicatorItemStatus { /** * The item is active. */ Active = 0, /** * The item is complete. */ Complete = 1, /** * The item is incomplete. */ Incomplete = 2, /** * The item is pending. */ Pending = 3 } /** * Specifies a step to include in the progress indicator. Each step requires a label, * and you can also specify step details within the `sky-progress-indicator-item` element. */ declare class SkyProgressIndicatorItemComponent implements OnInit { #private; /** * The step label for the step in the progress indicator. * @required */ set title(value: string | undefined); get title(): string | undefined; /** * A help key that identifies the global help content to display. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) button is * placed beside the progress indicator item label. 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 `title` is also specified. */ helpKey: string | undefined; /** * The content of the help popover. When specified along with `title`, a [help inline](https://developer.blackbaud.com/skyux/components/help-inline) * button is added to the progress indicator item label. 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 `title` is also specified. */ helpPopoverContent: string | TemplateRef | undefined; /** * The title of the help popover. This property only applies when `helpPopoverContent` is * also specified. */ helpPopoverTitle: string | undefined; set status(value: SkyProgressIndicatorItemStatus | undefined); get status(): SkyProgressIndicatorItemStatus; formattedTitle: string | undefined; set isVisible(value: boolean | undefined); get isVisible(): boolean; set showStatusMarker(value: boolean | undefined); get showStatusMarker(): boolean; set showTitle(value: boolean | undefined); get showTitle(): boolean; statusName: string; constructor(changeDetector: ChangeDetectorRef); ngOnInit(): void; showStepNumber(step: number): void; hideStepNumber(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } interface SkyProgressIndicatorChange { /** * The active item. */ activeIndex?: number; /** * Whether the progress indicator is complete. */ isComplete?: boolean; /** * The array with the status of each item. */ itemStatuses?: SkyProgressIndicatorItemStatus[]; } type SkyProgressIndicatorDisplayModeType = 0 | 1 | 'vertical' | 'horizontal'; declare enum SkyProgressIndicatorMessageType { /** * The current step is complete. * This completes the active item and moves to the next item. */ Progress = 0, /** * Returns progress to the previous step. * This moves from the active item to the item that precedes it. */ Regress = 1, /** * Progress is incomplete. * This marks all items as incomplete and sets the first item as the active item. */ Reset = 2, /** * Progress is complete. * This marks all items as complete and sets the last item as the active item. */ Finish = 3, /** * Moves progress to the item indicated by the `data.activeIndex` property. */ GoTo = 4 } interface SkyProgressIndicatorMessage { /** * The type of state change for the progress indicator. */ type: SkyProgressIndicatorMessageType; /** * Used in conjunction with SkyProgressIndicatorMessageType.GoTo * to travel to a specific step by specifying an index number on the `data.activeIndex` property. */ data?: { activeIndex?: number; [key: string]: any; }; } declare class SkyProgressIndicatorComponent implements OnInit, AfterContentInit, OnDestroy { #private; /** * The orientation of the progress indicator, which can be vertical or horizontal. * For [passive progress indicators](https://developer.blackbaud.com/skyux/components/progress-indicator-passive) * and [waterfall progress indicators](https://developer.blackbaud.com/skyux/components/progress-indicator-waterfall), * use the vertical display mode. For [modal wizards](https://developer.blackbaud.com/skyux/components/progress-indicator-wizard), * use the horizontal display mode. * @deprecated The property was designed to create wizards by setting `displayMode="horizontal"` on progress indicators in modals, * but this wizard implementation was replaced by the * [wizard component that uses tabs](https://developer.blackbaud.com/skyux/components/tabs-wizard). * @default "vertical" */ set displayMode(value: SkyProgressIndicatorDisplayModeType | undefined); get displayMode(): SkyProgressIndicatorDisplayModeType; /** * Whether the progress indicator is passive. Passive progress indicators inform users of * progress that concerns them but that they are not responsible for, and they must use the vertical display mode. * @default false */ set isPassive(value: boolean | undefined); get isPassive(): boolean | undefined; /** * The observable of `SkyProgressIndicatorMessage` that determines the status to * display for items in the progress indicator. The message stream is a queue of * commanding messages to change the state of the progress indicator based on the message type. */ set messageStream(value: Subject | undefined); /** * The index for the item to make active when the progress indicator * loads. All steps that precede the active item are marked as complete, and all steps * that follow the active item are marked as incomplete. */ set startingIndex(value: number | undefined); get startingIndex(): number; /** * Fires when the progress indicator changes the status of an item. */ progressChanges: EventEmitter; get hasFinishButton(): boolean | undefined; set hasFinishButton(value: boolean | undefined); itemComponents: QueryList | undefined; cssClassNames: string[]; itemStatuses: SkyProgressIndicatorItemStatus[]; constructor(changeDetector: ChangeDetectorRef, windowRef: SkyAppWindowRef, logger: SkyLogService); ngOnInit(): void; ngAfterContentInit(): void; ngOnDestroy(): void; sendMessage(message: SkyProgressIndicatorMessage): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } declare class SkyProgressIndicatorMarkerClassPipe implements PipeTransform { transform(displayMode: string, status: SkyProgressIndicatorItemStatus): string; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } declare class SkyProgressIndicatorNavButtonClass implements PipeTransform { transform(buttonType: string): string[]; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } /** * The nav button type. */ type SkyProgressIndicatorNavButtonType = 'finish' | 'next' | 'previous' | 'reset'; declare class SkyProgressIndicatorNavButtonDisabledPipe implements PipeTransform { transform(disabled: boolean | undefined, buttonType: SkyProgressIndicatorNavButtonType, activeIndex: number | undefined, itemStatuses: SkyProgressIndicatorItemStatus[] | undefined): boolean | undefined; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵpipe: i0.ɵɵPipeDeclaration; } /** * Allows the consumer to decide whether the button's action should be completed successfully. * The handler is provided with all nav button types. */ declare class SkyProgressIndicatorActionClickProgressHandler { readonly advance: () => void; /** * * @param advance Advances the progress indicator to the next step. */ constructor(advance: () => void); } /** * The arguments passed to the `actionClick` event handler. */ interface SkyProgressIndicatorActionClickArgs { /** * The progress handler object that allows consumers to trigger step advancement manually. */ progressHandler: SkyProgressIndicatorActionClickProgressHandler; /** * The mouse event from the user click. */ event: MouseEvent; } /** * Displays a button to navigate the steps in modal wizards. We recommend against using it in * passive progress indicators and waterfall progress indicators. */ declare class SkyProgressIndicatorNavButtonComponent implements AfterViewInit, OnDestroy { #private; /** * The label to display on the nav button. * @default "Next" */ buttonText: string | undefined; /** * The type of nav button to include. * @default "next" */ set buttonType(value: SkyProgressIndicatorNavButtonType | undefined); get buttonType(): SkyProgressIndicatorNavButtonType; /** * Whether to disable the nav button. * @default false */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * The progress indicator component to associate with the nav button. * @required */ set progressIndicator(value: SkyProgressIndicatorComponent | undefined); get progressIndicator(): SkyProgressIndicatorComponent | undefined; /** * Fires when users select the nav button and emits a `SkyProgressIndicatorActionClickArgs` * object that is passed into the callback function to allow consumers to decide whether * the button’s action should complete successfully. */ actionClick: EventEmitter; set isVisible(value: boolean | undefined); get isVisible(): boolean | undefined; lastProgressChange: SkyProgressIndicatorChange | undefined; constructor(changeDetector: ChangeDetectorRef, parentComponent?: SkyProgressIndicatorComponent); ngAfterViewInit(): void; ngOnDestroy(): void; onClick(event: MouseEvent): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Displays a button to mark all items in the progress indicator as incomplete and set the * first item as the active item. The steps after the active item remain incomplete until * users reach them in their sequential order. */ declare class SkyProgressIndicatorResetButtonComponent implements OnDestroy { #private; /** * Whether to disable the reset button. * @default false */ set disabled(value: boolean | undefined); get disabled(): boolean | undefined; /** * The progress indicator component to associate with the reset button. * @required */ progressIndicator: SkyProgressIndicatorComponent | undefined; /** * Fires when users select the reset button that marks all items as incomplete and sets the * first item as the active item. */ resetClick: EventEmitter; constructor(changeDetector: ChangeDetectorRef); ngOnDestroy(): void; onClick(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Specifies the content to display in the status marker. * @internal */ declare class SkyProgressIndicatorStatusMarkerComponent implements OnDestroy { #private; set displayMode(value: 'vertical' | 'horizontal'); get displayMode(): 'vertical' | 'horizontal'; set status(value: SkyProgressIndicatorItemStatus); get status(): SkyProgressIndicatorItemStatus; isComplete: boolean; constructor(changeDetector: ChangeDetectorRef, themeSvc?: SkyThemeService); ngOnDestroy(): void; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Specifies a header to display above the progress indicator. */ declare class SkyProgressIndicatorTitleComponent { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; } /** * Import into any component library module that needs to use resource strings. */ declare class SkyProgressIndicatorResourcesModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } declare class SkyProgressIndicatorModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } /** * @deprecated Use `SkyProgressIndicatorDisplayModeType` instead. * @internal */ declare enum SkyProgressIndicatorDisplayMode { /** * The vertical layout for the progress indicator. */ Vertical = 0, /** * The horizontal layout for the progress indicator. */ Horizontal = 1 } export { SkyProgressIndicatorActionClickProgressHandler, SkyProgressIndicatorDisplayMode, SkyProgressIndicatorItemStatus, SkyProgressIndicatorMessageType, SkyProgressIndicatorModule, SkyProgressIndicatorItemComponent as λ1, SkyProgressIndicatorComponent as λ2, SkyProgressIndicatorNavButtonComponent as λ3, SkyProgressIndicatorResetButtonComponent as λ4, SkyProgressIndicatorTitleComponent as λ5 }; export type { SkyProgressIndicatorActionClickArgs, SkyProgressIndicatorChange, SkyProgressIndicatorDisplayModeType, SkyProgressIndicatorMessage, SkyProgressIndicatorNavButtonType };