From 753f0befbce9c030ea94c527571dd130e2265424 Mon Sep 17 00:00:00 2001 From: Andrew Kingston Date: Fri, 14 May 2021 13:11:23 +0100 Subject: [PATCH] Add brief docs to Table component explaining the schema prop --- packages/bbui/src/Table/Table.svelte | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/packages/bbui/src/Table/Table.svelte b/packages/bbui/src/Table/Table.svelte index 4278751c5f..07ba7fa6e9 100644 --- a/packages/bbui/src/Table/Table.svelte +++ b/packages/bbui/src/Table/Table.svelte @@ -4,6 +4,16 @@ import CellRenderer from "./CellRenderer.svelte" import SelectEditRenderer from "./SelectEditRenderer.svelte" + /** + * The expected schema is our normal couch schemas for our tables. + * Each field schema can be enriched with a few extra properties to customise + * the behaviour. + * All of these are optional and do not need to be added. + * displayName: Overrides the field name displayed as the column title + * sortable: Set to false to disable sorting data by a certain column + * editable: Set to false to disable editing a certain column if the + * allowEditColumns prop is true + */ export let data = [] export let schema = {} export let showAutoColumns = false