@pmwcs/grid
v1.1.0
Published
PMWCS grid component
Downloads
8
Maintainers
Readme
Layout Grid
Material design’s responsive UI is based on a column-variate grid layout. It has 12 columns on desktop, 8 columns on tablet and 4 columns on phone.
- Module @pmwcs/grid
- Import styles:
- Using CSS Loader
- import '@pmwcs/grid/styles';
- Or include stylesheets
- '@material/layout-grid/dist/mdc.layout-grid.css'
- Using CSS Loader
- MDC Docs: https://material.io/develop/web/components/layout-grid/
<Grid>
<GridCell span={4}>1</GridCell>
<GridCell span={4}>2</GridCell>
<GridCell span={4}>3</GridCell>
</Grid>
<Grid>
{/* If you need additional control over height of your grid, or need to add SubGrids, you can add your own GridRow components. */}
<GridRow>
<GridCell span={6}>1</GridCell>
<GridCell span={6}>
<GridRow>
<GridCell span={6}>a</GridCell>
<GridCell span={6}>b</GridCell>
</GridRow>
</GridCell>
</GridRow>
</Grid>
Grid
A Grid component
Props
| Name | Type | Description |
|------|------|-------------|
| align
| "left" \| "right"
| Specifies the alignment of the whole grid. |
| children
| React.ReactNode
| Children for the Grid |
| fixedColumnWidth
| undefined \| false \| true
| Specifies the grid should have fixed column width. |
GridCell
A Grid cell
Props
| Name | Type | Description |
|------|------|-------------|
| align
| "top" \| "middle" \| "bottom"
| Specifies the alignment of cell |
| desktop
| undefined \| number
| Number of columns to span on a desktop. |
| order
| undefined \| number
| Specifies the order of the cell. |
| phone
| undefined \| number
| Number of columns to span on a phone. |
| span
| undefined \| number
| Default number of columns to span. |
| tablet
| undefined \| number
| Number of columns to span on a tablet. |
GridRow
By default, an inner grid component is included inside of . Use GridRow when doing nested Grids.