@skyux/indicators
Version:
This library was generated with [Nx](https://nx.dev).
54 lines (53 loc) • 3.09 kB
TypeScript
import { OnInit, TemplateRef } from '@angular/core';
import { SkyIndicatorDescriptionType } from '../shared/indicator-description-type';
import { SkyIndicatorIconType } from '../shared/indicator-icon-type';
import * as i0 from "@angular/core";
/**
* Displays status text with an icon matching the specified indicator type.
* To display a help button beside the label, include a help button element, such as
* `sky-help-inline`, in the `sky-status-indicator` element and a `sky-control-help`
* CSS class on that help button element.
*/
export declare class SkyStatusIndicatorComponent implements OnInit {
#private;
/**
* The style for the status indicator, which determines the icon.
* @default "warning"
*/
set indicatorType(value: SkyIndicatorIconType);
/**
* The predefined text to be read by screen readers for users who
* cannot see the indicator icon.
* @required
*/
set descriptionType(value: SkyIndicatorDescriptionType | undefined);
get descriptionType(): SkyIndicatorDescriptionType | undefined;
/**
* The text to be read by screen readers for users who cannot see
* the indicator icon when `descriptionType` is `custom`.
*/
set customDescription(value: string | undefined);
get customDescription(): 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 status indicator. 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;
/**
* 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 status indicator label. Clicking the button invokes global help as configured by the application.
*/
helpKey: string | undefined;
descriptionComputed: string | undefined;
iconName: string | undefined;
indicatorTypeOrDefault: SkyIndicatorIconType;
ngOnInit(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<SkyStatusIndicatorComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<SkyStatusIndicatorComponent, "sky-status-indicator", never, { "indicatorType": { "alias": "indicatorType"; "required": false; }; "descriptionType": { "alias": "descriptionType"; "required": false; }; "customDescription": { "alias": "customDescription"; "required": false; }; "helpPopoverContent": { "alias": "helpPopoverContent"; "required": false; }; "helpPopoverTitle": { "alias": "helpPopoverTitle"; "required": false; }; "helpKey": { "alias": "helpKey"; "required": false; }; }, {}, never, ["*", ".sky-control-help"], false, never>;
}