Skip to content

Commit 0b19b2c

Browse files
committed
Update docs
1 parent 8fde524 commit 0b19b2c

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

packages/website/docs/configuration.md

+31-10
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The configuration options map closely to the plugin and widget `manifest.json` A
3838

3939
(*`boolean`*)
4040

41-
*Optional.* This field must be set to `true` for a FigJam widget. Defaults to `false`.
41+
*Optional.* This field must be set to `true` for a Figma/FigJam widget. Defaults to `false`.
4242

4343
### `id`
4444

@@ -101,13 +101,13 @@ Learn how to [add a UI to a plugin command](<%- query('page', 'ui').url %>).
101101

102102
(*`array`*)
103103

104-
*Optional.* Defines the list of [parameters](https://figma.com/plugin-docs/plugin-parameters/) that the plugin command accepts via the Quick Actions search bar. Each parameter is an object with the following keys:
104+
*Optional.* An array that specifies the [parameters](https://figma.com/plugin-docs/plugin-parameters/) that the plugin command accepts via Figma’s Quick Actions search bar. Each parameter is an object with the following keys:
105105

106106
- **`"key"`** (*`string`*) — *Required.* The unique key used to identify the parameter.
107107
- **`"name"`** (*`string`*) — *Optional.* The name of the parameter shown in the Quick Actions search bar. Defaults to the value of the sibling `"key"` key.
108108
- **`"description"`** (*`string`*) — *Optional.* The description for the parameter shown in the Quick Actions search bar.
109-
- **`"allowFreeform"`** (*`boolean`*) — *Optional.* Set to `true` to allow any value to be entered for the parameter, not just the values suggested by the plugin command.
110-
- **`"optional"`** (*`boolean`*) — *Optional.* Set to `true` to make the parameter optional. Optional parameters can only occur at the end of the list of parameters. There must be at least one non-optional parameter.
109+
- **`"allowFreeform"`** (*`boolean`*) — *Optional.* Set this to `true` to allow any value to be entered for the parameter, not just the values suggested by the plugin command.
110+
- **`"optional"`** (*`boolean`*) — *Optional.* Set this to `true` to make the parameter optional. Optional parameters can only occur at the end of the list of parameters. There must be at least one non-optional parameter.
111111

112112
Learn how to [accept parameters via the Quick Actions search bar in your plugin command](https://figma.com/plugin-docs/plugin-parameters/).
113113

@@ -210,41 +210,62 @@ See the [recipe for configuring relaunch buttons](<%- query('page', 'recipes').u
210210

211211
(*`Array<"codegen" | "inspect" | "textreview" | "vscode">`*)
212212

213-
*Optional.* For specifying the list of capabilities that the plugin needs access to. Possible capabilities are **`"codegen"`**, **`"inspect"`**, **`"textreview"`**, and **`"vscode"`**.
213+
*Optional.* For specifying the list of [capabilities](https://figma.com/plugin-docs/manifest/#capabilities) that the plugin needs access to. Possible capabilities are **`"codegen"`**, **`"inspect"`**, **`"textreview"`**, and **`"vscode"`**.
214214

215215
### `permissions`
216216

217217
(*`Array<"activeusers" | "currentuser" | "fileusers" | "payments" | "teamlibrary">`*)
218218

219-
*Optional.* For specifying the list of permissions that the plugin/widget needs access to. Possible permissions are **`"activeusers"`**, **`"currentuser"`**, **`"fileusers"`**, **`"payments"`** and **`"teamlibrary"`**.
219+
*Optional.* For specifying the list of [permissions](https://figma.com/plugin-docs/manifest/#permissions) that the plugin/widget needs access to. Possible permissions are **`"activeusers"`**, **`"currentuser"`**, **`"fileusers"`**, **`"payments"`** and **`"teamlibrary"`**.
220220

221221
### `documentAccess`
222222

223223
(*`"dynamic-page"`*)
224224

225-
*Optional.* For specifying whether the plugin is compatible with Figma’s dynamic page loading feature. If this field is omitted, running the plugin will trigger the loading of additional pages in a file with multiple pages.
225+
*Optional.* Set this to `"dynamic-page"` if your plugin is compatible with Figma’s [dynamic page loading feature](https://www.figma.com/plugin-docs/accessing-document/#loading-pages-and-nodes). If this is not set, running the plugin will trigger the loading of additional pages in a file with multiple pages.
226226

227227
### `networkAccess`
228228

229229
(*`object`*)
230230

231-
*Optional.* An object that specifies the [list of domains that your plugin/widget is permitted to access](https://figma.com/plugin-docs/manifest#networkaccess). Keys are:
231+
*Optional.* An object that specifies the [list of domains that your plugin/widget is permitted to access](https://figma.com/plugin-docs/manifest#networkaccess). The object has the following keys:
232232

233233
- **`"allowedDomains"`** (*`Array<string>`*) — *Required.* Match patterns for domains that your plugin/widget is permitted to access.
234234
- **`"reasoning"`** (*`string`*) — *Optional.* For specifying why your plugin/widgets needs to access the domains in **`"allowedDomains"`**.
235235
- **`"devAllowedDomains"`** (*`Array<string>`*) — *Optional.* Match patterns for domains that your plugin/widget is permitted to access during development.
236236

237+
### `codegenLanguages`
238+
239+
(*`Array<CodeLanguage>`*)
240+
241+
*Required for codegen plugins only.* An array of code languages that your codegen plugin supports. Each language is an object with the following keys:
242+
243+
- **`"label"`** (*`string`*) — *Required.* A label for the code language displayed in the Figma UI.
244+
- **`"value"`** (*`string`*) — *Required.* A specific code language.
245+
246+
### `codegenPreferences`
247+
248+
(*`Array<CodegenPreference>`*)
249+
250+
*Optional.* Preferences for your codegen plugin. See [the example](https://www.figma.com/plugin-docs/manifest/#codegenpreferences).
251+
237252
### `enablePrivatePluginApi`
238253

239254
(*`boolean`*)
240255

241-
*Optional.* Set to `true` to allow the use of plugin APIs that are only available to private plugins/widgets.
256+
*Optional.* Set this to `true` to allow the use of plugin APIs that are only available to private plugins/widgets.
242257

243258
### `enableProposedApi`
244259

245260
(*`boolean`*)
246261

247-
*Optional.* Set to `true` to allow the use of [Proposed APIs](https://figma.com/plugin-docs/proposed-api/) that are only available during development.
262+
*Optional.* Set this to `true` to allow the use of [Proposed APIs](https://figma.com/plugin-docs/proposed-api/) that are only available during development.
263+
264+
### `build`
265+
266+
(*`string`*)
267+
268+
*Optional.* A shell command that Figma will run before your plugin’s files are loaded.
248269

249270
## JSON schema
250271

0 commit comments

Comments
 (0)