Skip to main content

Common Type Definitions

BaseUIProps

The philosophy around this BaseUIProps is that almost all of the components extends this interface.

  • status - To change the color appearance of the component
    • primary
    • accent
    • success
    • info
    • warning
    • error
  • size - To control the size of the component
    • small
    • medium
    • large
  • mode - You will also see this prop in a significant amount of component, and this is based on the component modes, where you will be able to control the appearance & look/feel of the component
PropData TypeDefault ValueDescription
Extends------
statusBlossomStatusprimary--
sizeBlossomSizemedium--

BaseBooleanFieldProps

PropData TypeDefault ValueDescription
ExtendsBaseUIProps--Inherits properties from BaseUIProps
position"left" | "right"rightControl the position of the field
adjacentbooleantrueSet it to false to position them apart i.e. space-between
defaultValuebooleanfalseDefault value for the field
disabledboolean--Set to true for disabled field
colorstring--Set custom color
labelstring--Label text above the input
captionstring--Caption text below the text input
errorstring--Error text in error `status` below caption text
containerStyleStyleProp<ViewStyle>--Container view style
textFieldsContainerStyleStyleProp<ViewStyle>--Text field Container view styleContainer for label, caption & error i.e. the right/left section opposite to the boolean field
labelStyleStyleProp<TextStyle>--Label text style
captionStyleStyleProp<TextStyle>--Caption text style
errorStyleStyleProp<TextStyle>--Error text style
statusBlossomStatusprimary--
sizeBlossomSizemedium--
childrenReactNode--Children

BlossomUIOptions

PropData TypeDefault ValueDescription
Extends------