Reference
biticaret.extension.toml keys
The keys in biticaret.extension.toml for each extension type, their types and descriptions.
This page is generated from the source code. a.b denotes key b in table [a], and a[].b denotes key b in each item of the [[a]] array of tables. For how these files work, see App configuration files.
type = "theme"
type
Extension type: theme.
- Type
- string
Example
type = "…"name
Display name of the theme extension. Blocks, snippets and assets live in blocks/, snippets/ and assets/ alongside this file; each block declares its name, target and settings in its {% schema %} tag.
- Type
- string
Example
name = "…"type = "function"
type
Extension type: function.
- Type
- string
Example
type = "…"handle
Function identifier (function_id): lowercase letters, digits, - and _, at most 50 characters.
- Type
- string
Example
handle = "…"function_type
Function type. See the Checkout functions page.
- Type
- string
Example
function_type = "…"title
Display name of the function in the admin, at most 100 characters.
- Type
- string
Example
title = "…"input_metafields
Metafields passed into the function: customer <namespace>.<key> fields (for cart_transform, the line variant's metafields, restricted to the app's own namespaces) and shop.<namespace>.<key> fields (restricted to the app's own namespaces).
- Type
- string array
Example
input_metafields = ["…"]build.command
Shell command executed by app build inside the function folder (via sh -c).
- Type
- string
Example
[build]
command = "…"build.path
Path to the compiled .wasm binary relative to the extension folder; packaged as functions/<folder>.wasm.
- Type
- string
Example
[build]
path = "…"type = "ui_extension"
type
Extension type: ui_extension.
- Type
- string
Example
type = "…"handle
Extension identifier (extension_id): lowercase letters, digits, - and _, at most 50 characters.
- Type
- string
Example
handle = "…"name
Display name of the extension in the admin, at most 100 characters.
- Type
- string
Example
name = "…"target
Default target slot where the extension renders. See the UI extension targets page.
- Type
- string
Example
target = "…"targets
Targets between which the store can move the extension; must include target and stay on the same surface (checkout.* or admin.*). If empty, only target is permitted.
- Type
- string array
Example
targets = ["…"]module
Path to the extension's .js module relative to the extension folder; packaged as extensions/<folder>.js.
- Type
- string
Example
module = "…"capabilities.network_access
Allows the extension to issue fetch requests to the app's own backend.
- Type
- boolean
Example
[capabilities]
network_access = truemetafields
Metafields exposed to the extension; supported on checkout.* targets only.
- Type
- string array
Example
metafields = ["…"]settings.fields[].key
Unique key of the setting field.
- Type
- string
Example
[[settings.fields]]
key = "…"settings.fields[].type
Field type: single_line_text_field, multi_line_text_field, boolean, number_integer or number_decimal.
- Type
- string
Example
[[settings.fields]]
type = "…"settings.fields[].name
Field label shown to the store.
- Type
- string
Example
[[settings.fields]]
name = "…"settings.fields[].description
Field help text shown to the store.
- Type
- string
Example
[[settings.fields]]
description = "…"settings.fields[].choices
Allowed options for a single-choice setting (2 to 20 items); valid for single_line_text_field only.
- Type
- string array
Example
[[settings.fields]]
choices = ["…"]settings.fields[].default
Default value matching the setting field's type.
- Type
- a value of the setting's type
type = "web_pixel"
type
Extension type: web_pixel.
- Type
- string
Example
type = "…"handle
Pixel identifier (pixel_id): lowercase letters, digits, - and _, at most 50 characters.
- Type
- string
Example
handle = "…"name
Display name of the pixel in the admin.
- Type
- string
Example
name = "…"module
Path to the pixel's .js module relative to the extension folder; packaged as extensions/<folder>.js.
- Type
- string
Example
module = "…"consent
Required visitor cookie consent category: analytics or marketing. Events are delivered only when granted.
- Type
- string
Example
consent = "…"settings.fields[].key
Setting key: starts with a lowercase letter; lowercase letters, digits and _, at most 40 characters. Read in the pixel under init.data.settings.
- Type
- string
Example
[[settings.fields]]
key = "…"settings.fields[].type
Field type: string (at most 500 characters) or string_list (array of strings). Settings are written via the API using write_pixels.
- Type
- string
Example
[[settings.fields]]
type = "…"settings.fields[].required
When true, the setting is required; while any required setting is empty the pixel does not run and Customer events shows it as not configured.
- Type
- boolean
Example
[[settings.fields]]
required = true