Stay organized with collections
Save and categorize content based on your preferences.
blockly > BlocklyOptions
BlocklyOptions interface
Blockly options.
Signature:
export interface BlocklyOptions
Properties
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eBlocklyOptions\u003c/code\u003e interface defines configuration options for a Blockly workspace.\u003c/p\u003e\n"],["\u003cp\u003eThese options control various aspects of the workspace, such as appearance, behavior, and limits.\u003c/p\u003e\n"],["\u003cp\u003eAll properties within \u003ccode\u003eBlocklyOptions\u003c/code\u003e are optional, allowing for customization based on specific needs.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use these options to tailor the Blockly workspace to their desired functionality and user experience.\u003c/p\u003e\n"]]],["The `BlocklyOptions` interface defines customizable settings for a Blockly workspace. Key options include: enabling/disabling features like `collapse`, `comments`, `css`, and `disable`; setting limits with `maxBlocks`, `maxInstances`, and `maxTrashcanContents`; configuring the `grid`, `move`, `scrollbars`, `toolbox`, and `zoom`; defining `renderer` and `theme` settings; specifying `plugins`; establishing `parentWorkspace`; managing `media` and `sounds`; managing `horizontalLayout`, `modalInputs`, `oneBasedIndex`, `readOnly`, `rendererOverrides`, `rtl`, and `trashcan` properties.\n"],null,["[blockly](./blockly.md) \\\u003e [BlocklyOptions](./blockly.blocklyoptions_interface.md)\n\nBlocklyOptions interface\n------------------------\n\nBlockly options.\n\n**Signature:** \n\n export interface BlocklyOptions \n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|-----------------------------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------|--------------|\n| [collapse?](./blockly.blocklyoptions_interface.collapse_propertysignature.md) | | boolean | *(Optional)* |\n| [comments?](./blockly.blocklyoptions_interface.comments_propertysignature.md) | | boolean | *(Optional)* |\n| [css?](./blockly.blocklyoptions_interface.css_propertysignature.md) | | boolean | *(Optional)* |\n| [disable?](./blockly.blocklyoptions_interface.disable_propertysignature.md) | | boolean | *(Optional)* |\n| [grid?](./blockly.blocklyoptions_interface.grid_propertysignature.md) | | GridOptions | *(Optional)* |\n| [horizontalLayout?](./blockly.blocklyoptions_interface.horizontallayout_propertysignature.md) | | boolean | *(Optional)* |\n| [maxBlocks?](./blockly.blocklyoptions_interface.maxblocks_propertysignature.md) | | number | *(Optional)* |\n| [maxInstances?](./blockly.blocklyoptions_interface.maxinstances_propertysignature.md) | | { \\[blockType: string\\]: number; } | *(Optional)* |\n| [maxTrashcanContents?](./blockly.blocklyoptions_interface.maxtrashcancontents_propertysignature.md) | | number | *(Optional)* |\n| [media?](./blockly.blocklyoptions_interface.media_propertysignature.md) | | string | *(Optional)* |\n| [modalInputs?](./blockly.blocklyoptions_interface.modalinputs_propertysignature.md) | | boolean | *(Optional)* |\n| [move?](./blockly.blocklyoptions_interface.move_propertysignature.md) | | MoveOptions | *(Optional)* |\n| [oneBasedIndex?](./blockly.blocklyoptions_interface.onebasedindex_propertysignature.md) | | boolean | *(Optional)* |\n| [parentWorkspace?](./blockly.blocklyoptions_interface.parentworkspace_propertysignature.md) | | [WorkspaceSvg](./blockly.workspacesvg_class.md) | *(Optional)* |\n| [plugins?](./blockly.blocklyoptions_interface.plugins_propertysignature.md) | | { \\[key: string\\]: (new (...p1: any\\[\\]) =\\\u003e any) \\| string; } | *(Optional)* |\n| [readOnly?](./blockly.blocklyoptions_interface.readonly_propertysignature.md) | | boolean | *(Optional)* |\n| [renderer?](./blockly.blocklyoptions_interface.renderer_propertysignature.md) | | string | *(Optional)* |\n| [rendererOverrides?](./blockly.blocklyoptions_interface.rendereroverrides_propertysignature.md) | | { \\[rendererConstant: string\\]: any; } | *(Optional)* |\n| [rtl?](./blockly.blocklyoptions_interface.rtl_propertysignature.md) | | boolean | *(Optional)* |\n| [scrollbars?](./blockly.blocklyoptions_interface.scrollbars_propertysignature.md) | | ScrollbarOptions \\| boolean | *(Optional)* |\n| [sounds?](./blockly.blocklyoptions_interface.sounds_propertysignature.md) | | boolean | *(Optional)* |\n| [theme?](./blockly.blocklyoptions_interface.theme_propertysignature.md) | | [Theme](./blockly.theme_class.md) \\| string \\| ITheme | *(Optional)* |\n| [toolbox?](./blockly.blocklyoptions_interface.toolbox_propertysignature.md) | | string \\| [ToolboxDefinition](./blockly.utils_namespace.toolbox_namespace.toolboxdefinition_typealias.md) \\| Element | *(Optional)* |\n| [toolboxPosition?](./blockly.blocklyoptions_interface.toolboxposition_propertysignature.md) | | string | *(Optional)* |\n| [trashcan?](./blockly.blocklyoptions_interface.trashcan_propertysignature.md) | | boolean | *(Optional)* |\n| [zoom?](./blockly.blocklyoptions_interface.zoom_propertysignature.md) | | ZoomOptions | *(Optional)* |"]]
