@workday/canvas-kit-react
Version:
The parent module that contains all Workday Canvas Kit React components
204 lines (196 loc) • 13.8 kB
TypeScript
import { BoxProps } from '@workday/canvas-kit-react/layout';
export interface BaseTableProps extends Omit<BoxProps, 'ref'> {
}
export declare const baseTableStencil: import("@workday/canvas-kit-styling").Stencil<import("@workday/canvas-kit-styling").StencilModifierConfig<{}, {}, never>, {}, {}, never, never>;
/**
* `BaseTable` is a simple styled compound component that renders a [table](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/table) element.
* It is used to present information in a two-dimensional table comprised of rows and columns of cells containing data.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Caption>Table Caption</BaseTable.Caption>
<BaseTable.Head>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Header>Table Header</BaseTable.Header>
</BaseTable.Row>
</BaseTable.Head>
<BaseTable.Body>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Header>Table Header</BaseTable.Header>
</BaseTable.Row>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Data Cell</BaseTable.Cell>
</BaseTable.Row>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Data Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Body>
<BaseTable.Footer>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Data Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Footer>
</BaseTable>
);
}
```
*/
export declare const BaseTable: import("@workday/canvas-kit-react/common").ElementComponent<"table", BaseTableProps> & {
/**
* `BaseTable.Caption` renders a [caption](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/caption) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Caption>Table Caption</BaseTable.Caption>
<BaseTable.Body>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Body>
</BaseTable>
);
}
```
*/
Caption: import("@workday/canvas-kit-react/common").ElementComponent<"caption", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Head` renders a [thead](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/thead) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Head>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Head>
</BaseTable>
);
}
```
*/
Head: import("@workday/canvas-kit-react/common").ElementComponent<"thead", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Body` renders a [tbody](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tbody) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Body>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Body>
</BaseTable>
);
}
```
*/
Body: import("@workday/canvas-kit-react/common").ElementComponent<"tbody", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Row` renders a [tr](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tr) element.
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Head>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Head>
</BaseTable>
);
}
```
*/
Row: import("@workday/canvas-kit-react/common").ElementComponent<"tr", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Header` renders a [th](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/th) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Head>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Head>
</BaseTable>
);
}
```
*/
Header: import("@workday/canvas-kit-react/common").ElementComponent<"th", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Cell` renders a [td](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/td) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Body>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Body>
</BaseTable>
);
}
```
*/
Cell: import("@workday/canvas-kit-react/common").ElementComponent<"td", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
/**
* `BaseTable.Footer` renders a [tfoot](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/tfoot) element.
*
*
* ```tsx
import {BaseTable} from '@workday/canvas-kit-react/table';
export default function App() {
return (
<BaseTable>
<BaseTable.Footer>
<BaseTable.Row>
<BaseTable.Header>Table Header</BaseTable.Header>
<BaseTable.Cell>Table Cell</BaseTable.Cell>
</BaseTable.Row>
</BaseTable.Footer>
</BaseTable>
);
}
```
*/
Footer: import("@workday/canvas-kit-react/common").ElementComponent<"tfoot", import("@workday/canvas-kit-react/layout").BackgroundStyleProps & import("../../layout/lib/utils/border/color").BorderColorStyleProps & import("../../layout/lib/utils/border/lineStyle").BorderLineStyleProps & import("../../layout/lib/utils/border/radius").BorderRadiusStyleProps & import("../../layout/lib/utils/border/shorthand").BorderShorthandStyleProps & import("../../layout/lib/utils/border/width").BorderWidthStyleProps & import("@workday/canvas-kit-react/layout").ColorStyleProps & import("@workday/canvas-kit-react/layout").DepthStyleProps & import("@workday/canvas-kit-react/layout").FlexItemStyleProps & import("@workday/canvas-kit-react/layout").GridItemStyleProps & import("@workday/canvas-kit-react/layout").LayoutStyleProps & import("@workday/canvas-kit-react/layout").OtherStyleProps & import("@workday/canvas-kit-react/layout").PositionStyleProps & import("@workday/canvas-kit-react/layout").SpaceStyleProps & import("@workday/canvas-kit-react/layout").TextStyleProps & import("@workday/canvas-kit-styling").CSProps>;
};
//# sourceMappingURL=BaseTable.d.ts.map