主题

主题是自定义 Blockly 外观和风格的一种方式。您可以通过 Themes 类自定义分块颜色、类别颜色和某些组件。如果您想自定义其他组件，我们会将主题名称作为注入 div 上的类提供。这样，用户就可以通过 CSS 更改任何不受支持的组件的外观。我们创建主题的主要目标是让开发者能够打造更易于访问的 Blockly 体验。

主题属性

主题是一个具有多个属性的对象：要扩展的基准主题、用于块、类别、组件和字体的样式对象，以及是否为起始块使用帽子。

屏蔽样式

分块样式由四个字段组成：

  • colourPrimary（必需）- 块的背景颜色。
  • colourSecondary（可选）- 如果块是阴影块，则为背景颜色。
  • colourTertiary（可选）- 代码块的边框或突出显示颜色。
  • hat（可选）- 如果值设置为 cap，则向方块添加帽子。 详细了解帽子。

箭头指向主色、辅色和第三色的方块

const listBlocks = {
   'colourPrimary': '#4a148c',
   'colourSecondary':'#AD7BE9',
   'colourTertiary':'#CDB6E9',
   'hat': 'cap'
}

主题将包含将块样式名称映射到块样式对象的映射：

const blockStyles = {
   'list_blocks': {
      'colourPrimary': '#4a148c',
      'colourSecondary':'#AD7BE9',
      'colourTertiary':'#CDB6E9'
   },
   'logic_blocks': {
      'colourPrimary': '#01579b',
      'colourSecondary':'#64C7FF',
      'colourTertiary':'#C5EAFF'
   }
}

类别样式

类别样式仅包含颜色属性。

  • 颜色（必需）- 工具箱中相应类别的颜色。通常，这些颜色应与该类别中大多数块的 colourPrimary 相同。这样，用户就可以轻松分辨哪些代码块属于给定类别。

显示不同类别颜色的工具箱的屏幕截图

const mathCategory = {
   'colour':'290'
}

主题将包含类别名称与类别样式对象的映射：

const categoryStyles = {
   'list_category': {
      'colour': '#4a148c'
   },
   'logic_category': {
      'colour': '#01579b',
   }
}

组件样式

主题可以设置以下组件的颜色或值：

  • workspaceBackgroundColour：工作区的背景颜色
  • toolboxBackgroundColour：工具箱背景颜色
  • toolboxForegroundColour：工具箱类别文本颜色
  • flyoutBackgroundColour：展开式菜单的背景颜色
  • flyoutForegroundColour：弹出式标签文本颜色
  • flyoutOpacity：弹出式菜单的不透明度
  • scrollbarColour：滚动条颜色
  • scrollbarOpacity：滚动条不透明度
  • insertionMarkerColour：插入标记的颜色（不接受颜色名称）
  • insertionMarkerOpacity：插入标记的不透明度
  • markerColour：键盘导航模式下显示的标记的颜色
  • cursorColour：键盘导航模式下显示的光标的颜色

您可以通过在 CSS 中使用主题名称来更改大多数其他组件。不过，如果您想更改的组件不在此列表中，并且无法使用 CSS 进行更改，请提交问题并提供更多信息。

const componentStyle = {
   'workspaceBackgroundColour': '#1e1e1e',
   'toolboxBackgroundColour': '#333'
}

字体样式

字体样式是一种对象，用于存储字体的系列、粗细和大小。

const fontStyle = {
   'family': 'Georgia, serif',
   'weight': 'bold',
   'size': 12
}

Start Hats

如果您直接在主题对象中设置 startHats: true，系统会向所有没有前置连接或输出连接的块添加帽子。如果您想更好地控制具体哪些块会获得帽子，可以改用块样式属性。

自定义主题

如需向 Blockly 应用添加主题，您需要执行以下操作：

  1. 创建主题
  2. 添加样式名称
  3. 在工作区中设置主题

创建主题

您可以使用构造函数或 defineTheme 创建主题。使用 defineTheme 可轻松扩展现有主题，并使用单个对象设置所有值。主题具有名称，是一个包含块样式、类别样式和其他属性（如上所述）的对象。

主题还可以有一个基准主题，该主题将为自定义主题中未指定的任何值提供默认值。

const theme = Blockly.Theme.defineTheme('themeName', {
   'base': Blockly.Themes.Classic,
   'blockStyles': {
      'logic_blocks': {
         'colourPrimary': '#4a148c'
      },
      'math_blocks': {...}
   },
   'categoryStyles': {...},
   'componentStyles': {...},
   'fontStyle': {...},
   'startHats': true
});

以下是使用 defineTheme 的示例。

添加样式名称

现在，我们已经创建了一个主题，接下来需要将样式的名称添加到块和类别定义中。

类别

如需使用主题的 categoryStyles 中定义的某种类别样式，请将其添加到类别定义中：

JSON

{
  "kind": "category",
  "name": "Logic",
  "categorystyle": "logic_category"
}

XML

<category name="Logic" categorystyle="logic_category"></category>

区块

如需使用主题的 blockStyles 中定义的某种块样式，请将其添加到块定义中：

JSON

"style":"logic_blocks"

JavaScript

this.setStyle('logic_blocks');

设置主题

您还需要告知 Blockly 要使用哪个主题。通过定义使用相同的版块样式和类别名称的多个主题，您可以允许用户选择最适合他们的主题，并动态更改该主题，而无需更改版块定义本身。

初始主题

设置初始主题的最佳方式是在调用 Blockly.inject 时添加 theme 配置选项。您可以使用 JSON 或 JavaScript 提供主题。

JSON

Blockly.inject('blocklyDiv', {
   theme: {
      "blockStyles" : {
         "list_blocks": {
            "colourPrimary": "#4a148c",
            "colourSecondary":"#AD7BE9",
            "colourTertiary":"#CDB6E9"
         }
      },
      "categoryStyles" : {
         "list_category": {
            "colour": "#4a148c"
         }
      },
      "componentStyles" : {
         "workspaceBackgroundColour": "#1e1e1e"
      }
   },
   ...
});

JavaScript

Blockly.inject('blocklyDiv', {
   theme: Blockly.Theme.defineTheme('themeName', {
      'blockStyles': blockStyles,
      'categoryStyles': categoryStyles,
      'componentStyles': componentStyles
   }),
   ...
});

如果未提供任何主题，则默认使用传统主题。

动态主题

如果您想动态更改主题（例如，允许用户从下拉菜单中选择主题），则可以调用 yourWorkspace.setTheme(theme)。

创建用于设置版块样式的脚本

Blockly 提供了一个脚本，该脚本会接受色相或十六进制值的映射，并为它们计算次要颜色和第三色。该脚本位于 scripts/themes 文件夹中。

内置主题背景

Blockly 提供了多种主题，以便用户使用，尤其是某些类型的色觉缺陷用户：

我们还提供：