Box

Source@react-form-builder/components-material-ui

Introduction

The Box component is a generic container component for layout and styling with Material UI's styling system. It serves as a wrapper component for most CSS utility needs, providing a convenient way to apply spacing, sizing, colors, and other styling properties.

The Box component is based on Material UI Box. It is included within the following NPM package: @react-form-builder/components-material-ui.

The Box component can be styled and configured to fit specific design and functionality requirements by using various properties that are presented and described below.

Main properties

The following general properties are available within the Main tab:

Name	Type	Description
Sx	object	The system prop that allows defining system overrides as well as additional CSS styles

System props (available via sx prop)

The Box component supports all system props from Material UI's system. Here are the most commonly used:

Category	Properties	Description
Spacing	m, mt, mr, mb, ml, mx, my, p, pt, pr, pb, pl, px, py	Margin and padding utilities
Sizing	width, height, minWidth, maxWidth, minHeight, maxHeight	Width and height utilities
Layout	display, flexDirection, flexWrap, justifyContent, alignItems, alignContent, order, flex, flexGrow, flexShrink, flexBasis, alignSelf	Flexbox utilities
Positioning	position, top, right, bottom, left, zIndex	Positioning utilities
Background	bgcolor, backgroundColor, backgroundImage, backgroundSize, backgroundPosition, backgroundRepeat	Background utilities
Borders	border, borderTop, borderRight, borderBottom, borderLeft, borderColor, borderRadius	Border utilities
Typography	fontFamily, fontSize, fontWeight, lineHeight, letterSpacing, textAlign, color	Typography utilities
Shadows	boxShadow	Shadow utilities
Grid	gridGap, gridColumnGap, gridRowGap, gridColumn, gridRow, gridAutoFlow, gridAutoColumns, gridAutoRows, gridTemplateColumns, gridTemplateRows, gridTemplateAreas, gridArea	CSS Grid utilities

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