diff --git a/packages/grafana-ui/src/components/Table/Table.mdx b/packages/grafana-ui/src/components/Table/Table.mdx index 78d862448a7..37a91691f43 100644 --- a/packages/grafana-ui/src/components/Table/Table.mdx +++ b/packages/grafana-ui/src/components/Table/Table.mdx @@ -26,6 +26,49 @@ Each dataframe also supports using the following custom property under `datafram - @deprecated use `FieldType.nestedFrames` instead - **parentRowIndex**: number - The index of the parent row in the main dataframe (under the `data` prop of the Table component). +## Table rendering + +Table component only works in conjunction with the applyFieldOverrides function from the @grafana/data package otherwise data will not render. + +```javascript +import { DataFrame, applyFieldOverrides, GrafanaTheme2 } from '@grafana/data'; +import { Table, useTheme2 } from '@grafana/ui'; + +const TableComponent = (dataFrame: DataFrame) => { + const theme = useTheme2(); + const displayData = applyFieldOverrides({ + data: dataFrame, + fieldConfig: { + defaults: { + custom: { + align: 'auto', + cellOptions: { + type: 'gauge', + mode: 'gradient', + }, + inspect: false, + }, + mappings: [], + unit: 'locale', + }, + overrides: [], + }, + theme, + replaceVariables: (value) => value, + }); + + return ( +