Box
Box
React Bootstrap boxes are layout components which help to write build components for of the CSS utility needs.
Examples
Box component can be any component from React.ElementType like div, span, img, video etc. The basic component is a div.
Paragraph
import React from "react";import { CDBBox, CDBContainer } from "cdbreact";export const Box = () => {return (<CDBContainer><CDBBox tag="span">Span</CDBBox><CDBBox tag="div">Div</CDBBox><CDBBox tag="p">Paragraph</CDBBox><CDBBox tag="section">Section</CDBBox></CDBContainer>);};
Display
With CDBox component you can set any display CSS style from Bootstrap 4 to CDBox component like d-none, d-flex etc.
import React from "react";import { CDBBox, CDBContainer } from "cdbreact";export const Box = () => {return (<CDBContainer><CDBBox display="flex">Display Flex</CDBBox><CDBBox display="block">Display Block</CDBBox><CDBBox display="none">Dislpay None</CDBBox><CDBBox display="inline">Display Inline</CDBBox></CDBContainer>);};
Flex
With CDBox component you can set flexbox CSS styles to this component and render it on your website. You can use props justifyContent, flex, alignItems, alignContent, alignSelf.
Column
Column
Column
Row
Row
Row
import React from "react";import { CDBBox, CDBContainer } from "cdbreact";export const Box = () => {return (<CDBContainer><CDBBox display="flex" justifyContent="center">Justify Content Center</CDBBox><CDBBox display="flex" justifyContent="end">Justify Content End</CDBBox><CDBBox display="flex" flex="column"><CDBBox tag="p">Column</CDBBox><CDBBox tag="p">Column</CDBBox><CDBBox tag="p">Column</CDBBox></CDBBox><CDBBox display="flex" flex="row"><CDBBox tag="p">Row</CDBBox><CDBBox tag="p">Row</CDBBox><CDBBox tag="p">Row</CDBBox></CDBBox><CDBBox display="none"><CDBBox display="flex" flex="fill"><CDBBox tag="p">Fill</CDBBox></CDBBox><CDBBox display="flex" flex="row" alignItems="start">Align Items Start</CDBBox><CDBBox display="flex" flex="row" alignItems="center">Align Items Center</CDBBox><CDBBox display="flex" alignContent="start">Align Content Start</CDBBox><CDBBox display="flex" alignContent="center">Align Content Center</CDBBox><CDBBox display="flex" alignSelf="start">Align Self Start</CDBBox><CDBBox display="flex" alignSelf="center">Align Self Center</CDBBox></CDBBox></CDBContainer>);};
Colors
With CDBox component you can set text CSS colors to element between CDBox component.
import React from "react";import { CDBBox, CDBContainer } from "cdbreact";export const Box = () => {return (<CDBContainer><CDBBox color="red">Red Color</CDBBox><CDBBox color="green">Green Color</CDBBox><CDBBox color="yellow">Pink Color</CDBBox><CDBBox color="blue">Blue Color</CDBBox></CDBContainer>);};
Background Colors
With CDBox component you can set background CSS colors to element to CDBox component.
import React from "react";import { CDBBox, CDBContainer } from "cdbreact";export const Box = () => {return (<CDBContainer><CDBBox bg="success">Success Background</CDBBox><CDBBox bg="secondary">Secondary Background</CDBBox><CDBBox bg="danger">Danger Background</CDBBox><CDBBox bg="warning">Warning Background</CDBBox></CDBContainer>);};
API
In this section you will find advanced information about the Box component. You will find out which modules are required, what are the possibilities of configuring the component, and what events and methods you can use in working with it.
Contrast Box Import Statement
In order to use Box component make sure you have imported proper module first.
import { CDBBox } from "cdbreact";
API Reference: Contrast Box Properties
The table below shows the configuration options of the CDBBox component.
| Name | Type | Default | Description | Example |
|---|---|---|---|---|
| className | String | Adds custom classes | Adds custom classes | <CDBBox className="myClass" ... /> |
| color | String | Change color of text in the CDBox component. Choose one of these from CDB: red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, yellow, amber, orange, deep-orange, brown, grey, blue-grey, cdb-color white. You can also chose default colors from Bootstrap like: primary, secondary, success, info, default, warning, danger, dark, muted, light. | <CDBBox color="pink" ... /> | |
| alignContent | String | Set align-content class to children of CDBox. Choose one of these: start, end, center, between, stretch, around. | <CDBBox alignContent="start" .../> | |
| alignItems | String | Set align-items class to children of CDBox. Choose one of these: start, end, center, between, stretch. | <CDBBox alignItems="start" .../> | |
| alignSelf | String | Set align-self class to children of CDBox. Choose one of these: start, end, center, between, stretch. | <CDBBox alignSelf="start" .../> | |
| bgColor | String | Sets background color of the box component. Choose one of these: primary, secondary, success, danger, warning, info, light, dark | <CDBBox bgColor="light" .../> | |
| display | String | Set display to element. Choose one of these: none, inline, inline-block, block, table, table-row, table-cell, flex, inline-flex. | <CDBBox display="inline" ...> | |
| flex | String | Set flex class to children of CDBox. Choose one of these: row, column, row-reverse, column-reverse, wrap, nowrap, wrap-reverse, fill, grow-0, grow-0, shrink-0, shrink-1, center. | <CDBBox flex="column" .../> | |
| justifyContent | String | Set justify-content to children od CDBox. Choose one of these: start, end, center, between, around. | <CDBBox justifyContent="start" ...> | |
| m | String or Number | With margin you can set margin top/bottom/right/left/x/y from 0 to 5. You can use string or number. | <CDBox m="5" .../>, <CDBox mt="1" .../>, <CDBox mb="4" .../>, <CDBox my={2} .../>, <CDBox mx={4} .../> | |
| p | String or Number | With padding you can set padding top/bottom/right/left/x/y from 0 to 5. You can use string or number. | <CDBox p="5" .../>, <CDBox pt="1" .../>, <CDBox pb="4" .../>, <CDBox py={2} .../>, <CDBox px={4} .../> |