@dotconnor/grommet
Version:
focus on the essential experience
180 lines (147 loc) • 2.51 kB
Markdown
## Table
A table of data organized in cells.
[](https://storybook.grommet.io/?selectedKind=Visualizations-Table&full=0&stories=1&panelRight=0) [](https://codesandbox.io/s/github/grommet/grommet-sandbox?initialpath=/table&module=%2Fsrc%2FTable.js)
## Usage
```javascript
import { Table, TableHeader, TableFooter, TableBody, TableRow } from 'grommet';
<Table />
```
## Properties
**a11yTitle**
Custom label to be used by screen readers. When provided, an aria-label will
be added to the element.
```
string
```
**alignSelf**
How to align along the cross axis when contained in
a Box or along the column axis when contained in a Grid.
```
start
center
end
stretch
```
**gridArea**
The name of the area to place
this inside a parent Grid.
```
string
```
**margin**
The amount of margin around the component. An object can
be specified to distinguish horizontal margin, vertical margin, and
margin on a particular side.
```
none
xxsmall
xsmall
small
medium
large
xlarge
{
bottom:
xxsmall
xsmall
small
medium
large
xlarge
string,
end:
xxsmall
xsmall
small
medium
large
xlarge
string,
horizontal:
xxsmall
xsmall
small
medium
large
xlarge
string,
left:
xxsmall
xsmall
small
medium
large
xlarge
string,
right:
xxsmall
xsmall
small
medium
large
xlarge
string,
start:
xxsmall
xsmall
small
medium
large
xlarge
string,
top:
xxsmall
xsmall
small
medium
large
xlarge
string,
vertical:
xxsmall
xsmall
small
medium
large
xlarge
string
}
string
```
**caption**
One line description.
```
string
```
## Intrinsic element
```
table
```
## Theme
**global.edgeSize.responsiveBreakpoint**
The actual breakpoint to trigger changes in Table. Expects `string`.
Defaults to
```
small
```
**global.size**
The size that impacts max-width and width. Expects `undefined`.
Defaults to
```
{
xxsmall: '48px',
xsmall: '96px',
small: '192px',
medium: '384px',
large: '768px',
xlarge: '1152px',
xxlarge: '1536px',
full: '100%',
}
```
**table.extend**
Any additional style for Table. Expects `string | (props) => {}`.
Defaults to
```
undefined
```