An icon indicator component.

Parameters:
NameTypeDescription
propsobject

Component props.

Properties
NameTypeDescription
bgColorstring

Background color for the indicator.

childrenJSX.Element

React element children.

customAttributesobject

Custom attributes for the component.

customClassesstring | Array | object

Custom classes for the component.

iconstring

The icon of the indicator if the type is unstyled.

iconColorstring

The color of the icon if the type is unstyled.

iconPrefixstring

The prefix for the icon library to be used.

spacingstring | number | Array | object

The spacing for the component, as a string, number, array, or object.

typestring

The type of the indicator, one of unstyled, info, card, warning, success, or error.

refobject | null

Ref to the component.

Since
  • 1.1.15
Source
Returns:

The icon indicator component.

Type: 
JSX.Element
Example
import IconIndicator from '@gravityforms/components/react/admin/modules/Indicators/IconIndicator';

return (
    <IconIndicator icon="api" type="info">
        { children }
    </IconIndicator>
);