Renders a banner component with optional file upload.

Parameters:
NameTypeAttributesDefaultDescription
childrenReact.ReactNode | Array.<React.ReactNode><optional>

React element children

customAttributesRecord.<string, any><optional>

Custom attributes for the component

customClassesstring | Array.<string> | Record.<string, boolean><optional>

Custom classes for the component

droplistAttributesRecord.<string, any><optional>

Custom attributes for the droplist component

droplistClassesstring | Array.<string> | Record.<string, boolean><optional>

Custom classes for the droplist component

fileUploadAttributesRecord.<string, any><optional>

Custom attributes for the file upload component

hasActionsboolean<optional>
false

Whether to show the actions droplist

hasUploadboolean<optional>
false

Whether to show the file upload

heightstring<optional>
''

The height of the component

i18nRecord.<string, any><optional>

The i18n strings for the component

idstring<optional>
''

The ID of the component

imageFilestring<optional>
''

The image file for the component

noImageGradientstring<optional>
''

The gradient for the component

noImageGradientColorstring<optional>
''

The gradient color for the component

noImageGradientLayoutobject<optional>

The optional gradient layout for the component

removeButtonAttributesRecord.<string, any><optional>

Custom attributes for the remove button

selectButtonAttributesRecord.<string, any><optional>

Custom attributes for the select button

spacingstring | number | Array.<string> | Record.<string, any><optional>
''

The spacing for the component

uploadButtonAttributesRecord.<string, any><optional>

Custom attributes for the upload button

refReact.RefObject.<HTMLElement> | null

Ref to the component

Since
  • 5.6.0
Source
Returns:

The banner component.

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

return (
    <Banner>
        { 'children' }
    </Banner>
);