ColorInput

Source@react-form-builder/components-mantine

Introduction

The ColorInput component combines a text input for hex (or other) color values with an optional color swatch and picker popover. It is used for theme or style customization. The component is based on Mantine ColorInput.

It is included within the following NPM package: @react-form-builder/components-mantine.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Label	string	Label for the input
Value	string	Current color value (e.g. hex) (uncontrolled value)
Format	string	Color format (e.g. 'hex', 'rgba')
Description	string	Helper text below the field
Error	string	Error message; when set, applies error styling
Size	'xs' | 'sm' | 'md' | 'lg' | 'xl'	Size of the input
Disabled	boolean	Disables the input
Disallow input	boolean	If true, user cannot type; only picker can set value
On change	event	Fired when the color changes

At the bottom of the Main properties menu, you can find additional options:

• Render When: Provides conditional rendering for your component as described in the corresponding chapter.
• HTML attributes: Allows you to provide custom HTML attributes for your form.

Style properties

These are properties that allow to customize the size, color and other style properties of your component:

• For Device: You can provide component's style customization for all devices or specific devices by using this dropdown list. Refer to Adaptive Layout for more details.

• Component > Class Name: Add a class name for your component for the subsequent styling if necessary.

• Wrapper: The options below enable you to tailor the appearance of your component and customize it for a specific device type, as selected in the For Device property:

  Name	Type	Description
  Width	number	Specifies the width for your component
  Height	number	Specifies the height for your component
  Margin top/right/bottom/left	number	Margin values for you component
  Color	string	Allows customizing the text color
  Background color	string	Enables customizing the background color