From b39c242667a2451e6ceb2faad3b7e1ee204779f1 Mon Sep 17 00:00:00 2001 From: Boris Bera Date: Sun, 5 Nov 2023 06:19:07 -0500 Subject: [PATCH] Document `options.titleFormat` Signed-off-by: Boris Bera --- .../StructuredMetadataTable/StructuredMetadataTable.tsx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/packages/core-components/src/components/StructuredMetadataTable/StructuredMetadataTable.tsx b/packages/core-components/src/components/StructuredMetadataTable/StructuredMetadataTable.tsx index 108ddbe926..08c00da772 100644 --- a/packages/core-components/src/components/StructuredMetadataTable/StructuredMetadataTable.tsx +++ b/packages/core-components/src/components/StructuredMetadataTable/StructuredMetadataTable.tsx @@ -157,6 +157,13 @@ function mapToItems(info: { [key: string]: string }, options: Options) { } interface Options { + /** + * Function to format the keys from the `metadata` object. Defaults to + * startCase from the lodash library. + * @param key A key within the `metadata` + * @returns Formatted key + * @see {@link startCase} + */ titleFormat?: (key: string) => string; }