Module: Alert

An alert component with predefined types and many customization arguments.

Parameters:

Name Type Description

props

object

The props for the component template.

Properties

Name	Type	Description
`children`	JSX.Element	React element children.
`content`	string	The content of the alert.
`contentCustomAttributes`	object	Custom attributes for the content.
`contentCustomClasses`	string \| Array \| object	Custom classes for the content.
`ctaLabel`	string	The label for the call-to-action button.
`ctaLink`	string	The link href for the call-to-action button.
`customAttributes`	object	Any custom attributes.
`customClasses`	string \| Array \| object	An array of additional classes for the toggle.
`customIcon`	string	An icon override for the defaults that are set based on type.
`customIconPrefix`	string	The prefix for the custom override.
`dismissableAriaLabel`	string	The aria-label for the dismiss button.
`dismissableTitle`	string	The title for the dismiss button.
`hasCta`	boolean	Whether or not the alert has a call-to-action button.
`id`	string	Id for the alert, auto generated if not passed.
`isDismissable`	boolean	Whether or not the alert is dismissable.
`isInline`	boolean	Whether or not the alert is inline.
`spacing`	string \| number \| Array \| object	The spacing for the component, string, number, object or array.
`theme`	string	Theme for the alert, primary or cosmos.
`type`	string	The type of the alert. Default, notice, success, error and accessibility.

ref

object | null

Ref to the component.

Since: 2.1.0
Source: modules/Alert/index.js, line 10

Returns:

The alert component.

Type:: JSX.Element

Example

import Alert from '@gravityforms/components/react/admin/modules/Alert';
import Text from '@gravityforms/components/react/admin/elements/Text';

return (
    <Alert>
        <Text content="Some text for my alert!">
    </Alert>
);