Skip to content

Banner

Displays a customizable banner for an impactful visual, made at minimum with a title and an image.

Component source </>

Installation

To install with Mason CLI, run the following:

Terminal window
mason make flex_ui --component banner

To install manually, copy and paste the component source files linked at the top of this page into your Flutter project.

Dependencies

Internal

This component relies on some Flex UI primitive components:

  1. FlexImage
  2. FlexButton (TODO)

Properties

NameTypeDescription
overlineWidget?Heading line to emphasise the title
titleWidgetTitle of the banner
descriptionWidget?Long descriptive text below the title
imageFlexImageImage of the banner
orientationAxis?The banner can be horizontal or vertical (default: horizontal)
imageLayoutFlexBannerImageLayoutThe image can be placed after the rest of the elements, or before (default: after)
themeCardThemeThe banner leverages the Material theme for its styling (elevation, rounded corners, background color, etc.). The provided instance is merged with the one inherited from the app

Examples

Minimal

Full