UNPKG

@logo-software/info-container

Version:

Logo Info container library presents users feedbacks about the actions or items in the page. Feedbacks placed into the page DOM.

47 lines (46 loc) 1.63 kB
/** * IconPosition enum defines the icon position in the info container area. There is two option for the position: LEFT and RIGHT. */ export declare enum IconPosition { LEFT = "left", RIGHT = "right" } /** * InfoTypes enum defines the information area's color scheme also the icon if it will be shown. It will be SUCCESS, ERROR, INFO and WARNING. */ export declare enum InfoTypes { SUCCESS = "success", ERROR = "error", INFO = "info", WARNING = "warning" } /** * Developers can use Logo Info Container library with the sample below. This component will let the developers to modify the options of the feedbacks. * * <sub>app.component.html</sub> * * ```html * <logo-info-container * [infoType]="InfoTypes.SUCCESS" * [showIcon]="true" * [iconPosition]="IconPosition.LEFT" * > * Feedback content that user must catch. * </logo-info-container> * ``` */ export declare class InfoContainerComponent { /** * Type of Feedback. It will get InfoTypes enum which are 'SUCCESS', 'ERROR', 'WARNING' and 'INFO'. Default type is 'INFO'. */ infoType: InfoTypes; /** * Feedback icon position. Library will automatically show the related icon to the type of the Feedback. This option will let developers to show icon on left or on right. It will get the values from IconPosition enum which are 'LEFT' and 'RIGHT'. Default value is 'LEFT' */ iconPosition: IconPosition; /** * Option for show/hide feedback icon. Default value is 'true'. */ showIcon: boolean; getIcon(): "le-info" | "le-check_badge" | "le-warning" | "le-remove_badge"; }