Skip to main content

IBuilderTier interface

📖 Description​

Interface for declaring a builder tier.

tip

See this guide for more information about using tiers.

📃 Type declaration​

interface IBuilderTier {
  name: string;
  blocks: string[];
  mode?: "enabled" | "disabled" | "hidden";Optional
  message?: (orchestrator: EditorOrchestrator) => void;FunctionOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ blocks​

Specifies the block identifiers included in the tier.

Type​

string[]

🏷ī¸ mode​

Optional mode for the tier. It can be one of the following values:

  • enabled: The blocks in the tier are enabled, and the name of the tier is shown in the blocks list (this is the default mode);
  • disabled: The blocks in the tier are disabled;
  • hidden: The blocks in the tier are hidden and cannot be selected.

Type​

"enabled" | "disabled" | "hidden"

🏷ī¸ name​

Specifies a name for the tier.

Type​

string

â–ļī¸ Functions​

🔧 message​

Optional message that renders when a block from the tier is selected, but the tier is disabled.

Signature​

(orchestrator: EditorOrchestrator) => void

Parameters​

NameTypeOptionalDescription
orchestratorEditorOrchestratorNoReference to the editor orchestrator instance that is used to define editor controls.