es6-react-admin-lte
Version:
An AdminLTE Template made to use for React and ES2015-and-so-on
68 lines (49 loc) • 1.32 kB
Markdown
# The ContentWrapper
> ./src/js/components/content-wrapper/
## Purpose
This component holds changing 'page content' of the admin panel.
## Important Items
- content-wrapper.jsx
## Props
__header__
* Required - _false_
* Data Type - _ELEMENT_
* Functionality - _Displays your choice of element for the header in the component. Takes priority over the 'heading', 'subheading', and 'breadcrumbs' props_
__heading__
* Required - _false_
* Data Type - _STRING || ELEMENT_
* Functionality - _Displays a page title heading_
* Default - _''_
__subheading__
* Required - _false_
* Data Type - _STRING || ELEMENT_
* Functionality - _Displays a page title subheading_
__breadcrumbs__
* Required - _false_
* Data Type - _BOOLEAN_
* Functionality - _Displays a Breadcrumbs component_
* Default - _false_
__Takes Children__
* Expected Type - _ELEMENTS && STRING_
* Displays Inside - _A <section> classed .content/body_
## Example
```
import ContentWrapper from './src/js/components/content-wrapper/content-wrapper.jsx';
<ContentWrapper
heading="Cool Cats"
subheading={(
<span>
A list of really cool cats
<i className="fa fa-meh-o" />
</span>
)}
>
<ol>
<li>Swat Cats</li>
<li>Thunder Cats</li>
<li>Heathcliff</li>
<li>Garfield</li>
</ol>
</ContentWrapper>
```
---