Has not effect if the widget being decorated has no associated icon.

interface IconOverlay {
    background?: IconOverlayBackground;
    color?: string;
    icon: string;
    position: IconOverlayPosition;
}

Hierarchy (view full)

Properties

The optional background color of the overlay icon.

color?: string

The color of the overlaying icon. If not specified, then the default icon color will be used.

icon: string

This should be the name of the Font Awesome icon with out the fa fa- prefix, just the name, for instance paw. For the existing icons, see here: https://fontawesome.com/v4.7.0/icons/.

The position where the decoration will be placed on the top of the original icon.