From d05a99ff431c03c508882188bc1bde717e466e1d Mon Sep 17 00:00:00 2001 From: Kyle Gach Date: Wed, 29 Nov 2023 14:02:28 -0700 Subject: [PATCH] Add missing API details - `control: false` - `table.disable` --- docs/api/arg-types.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/api/arg-types.md b/docs/api/arg-types.md index e70678c9877e..555462c1354f 100644 --- a/docs/api/arg-types.md +++ b/docs/api/arg-types.md @@ -82,7 +82,7 @@ Type: ```ts { [key: string]: { - control?: ControlType | { type: ControlType; /* See below for more */ }; + control?: ControlType | { type: ControlType; /* See below for more */ } | false; description?: string; if?: Conditional; mapping?: { [key: string]: { [option: string]: any } }; @@ -91,6 +91,7 @@ Type: table?: { category?: string; defaultValue?: { summary: string; detail?: string }; + disable?: boolean; subcategory?: string; type?: { summary?: string; detail?: string }; }, @@ -116,6 +117,7 @@ Type: presetColors?: string[]; step?: number; } +| false ``` Default: @@ -124,7 +126,7 @@ Default: 2. Else, inferred from [`type`](#type) 3. Else, `'object'` -Specify the behavior of the [controls addon](../essentials/controls.md) for the arg. If you specify a string, it's used as the [`type`](#controltype) of the control. If you specify an object, you can provide additional configuration. +Specify the behavior of the [controls addon](../essentials/controls.md) for the arg. If you specify a string, it's used as the [`type`](#controltype) of the control. If you specify an object, you can provide additional configuration. Specifying `false` will prevent the control from rendering. @@ -345,6 +347,7 @@ Type: detail?: string; summary: string; }; + disable?: boolean; subcategory?: string; type?: { detail?: string; @@ -387,6 +390,12 @@ Default: [Inferred](#automatic-argtype-inference) The documented default value of the argType. `summary` is typically used for the value itself, while `detail` is used for additional information. +#### `table.disable` + +Type: `boolean` + +Set to `true` to remove the argType's row from the table. + #### `table.subcategory` Type: `string`