Skip to main content

Messages

Component to display messages that require attention with colored message blocks, to emphasize part of your page.

The FlexNative Messages is part of the FlexNative Framework and is available under the @flexnative/messages NPM package.

Dependencies

Installation

You can installing FlexNative Messages packages using npm:

npm i @flexnative/messages

API

import Message from '@flexnative/messages';

Component

Message

Type: React.PureComponent<MessageBoxProps>

This component uses the ThemeContext to apply theme-based styles. Component extending React.PureComponent, which is optimized for performance by implementing a shallow prop and state comparison.

Properties

info

MessageBoxProps extends ViewProps from React Native, so any prop of ViewProps it is applicable on Message component.

NameTypeRequiredDefault ValueDescription
radiusBorderRadiusfalsemediumMessage box border radius. Specifies the roundness of the message box corners.
borderWidthBorderWidthfalsenodeOptional message box borders width. Specifies the thickness of the message box borders.
borderColorColorValuefalseundefinedSpecifies the color of the message box borders. Borders color according to react-native ColorValue.
fillFillModefalseghostFill Mode of the message box. Determines the appearance of the message box.
warning
To have appearance for ghost with custom color you should use hex colors.
sizeSizesfalsenormalMessage box size. Defines the overall size of the message box component.
colorColorfalsetheme.color.defaultColor by theme or a custom color according react-native ColorValue. Sets the primary color of the message box, either by theme or a specified color code.
textstringfalseundefinedString that contains the text or message to be displayed inside the message box. If the children property is used, this text property will be ignored.
childrenReact.ReactNodefalseundefinedChildren to display inside the Message box. Can be any React elements that will be rendered within the message box.

FillMode

One of 'ghost' | 'solid'

NameTypeDescription
ghoststringMessage Box with a transparent background.
solidstringMessage Box with a solid background color.

Use case Examples

The following example demonstrates the Message component in action.

Color

default Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
primary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
secondary Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
info Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
success Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
warning Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
error Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
dark Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
light Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
crimson Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
#ed143d Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
rgb(237, 20, 61) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
rgba(237, 20, 61, 0.5) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

BorderColors

borderColors will have effect effect only when borderWidth has a value.

`crimson` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
#ed143d Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
rgb(237, 20, 61) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
rgba(237, 20, 61, 0.5) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

BorderRadius

`none` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`small` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`medium` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`large` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`full` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
12 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

BorderWidth

`none` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`hairline` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`thin` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`base` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`thick` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
5 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

BorderWidth

`none` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`hairline` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`thin` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`base` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`thick` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
5 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

FillMode

`ghost` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
`ghost` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
`ghost` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
ghost To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
ghost To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
ghost To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
`solid` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
`solid` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
`solid` To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
solid To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
solid To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.
solid To have nice effect for fill='ghost' type using custom colors use hex color with a specific opacity.

Size

`small` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`default` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`medium` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
`large` Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.
5 Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aenean mollis.

Children

Using prop children to render custom React Element in Message component.

Playground

Live Editor
render(<Message color='info' size='medium' text='Play with props to see live changes' />);
Result
Loading...