テーマは、Blockly のデザインをカスタマイズする方法です。ブロックの色、カテゴリの色、特定のコンポーネントは、Themes
クラスを使用してカスタマイズできます。追加のコンポーネントをカスタマイズする場合は、インジェクション div のクラスとしてテーマ名を指定します。これにより、サポートされていないコンポーネントの外観を CSS で変更できます。テーマを作成する主な目的は、デベロッパーがさらにアクセスしやすい Blockly のエクスペリエンスを開発できるようにすることです。
テーマのプロパティ
テーマは、拡張元のベーステーマ、ブロック、カテゴリ、コンポーネント、フォントのスタイル オブジェクト、スタート ブロックに帽子を使用するかどうか、という複数のプロパティを持つオブジェクトです。
ブロックのスタイル
ブロック スタイルは、次の 4 つのフィールドで構成されます。
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'
}
}
カテゴリのスタイル
カテゴリ スタイルには色のプロパティのみが格納されます。
- Colour(必須) - ツールボックスのカテゴリの色。通常、これらの色は、カテゴリ内の大半のブロックの
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
}
スタート帽子
テーマ オブジェクトで startHats: true
を直接設定すると、以前の接続や出力の接続がないすべてのブロックに帽子が追加されます。どのブロックが帽子になるかを厳密に制御する場合は、代わりに block style のプロパティを使用します。
カスタムテーマ
Blockly アプリにテーマを追加する手順は次のとおりです。
- テーマを作成する
- スタイル名を追加する
- ワークスペースにテーマを設定する
テーマを作成する
テーマは、コンストラクタを使用するか、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
の使用例をご覧ください。
スタイル名を追加
これでテーマが作成されたので、スタイルの名前をブロックとカテゴリの定義に追加する必要があります。
Categories
ツールボックスの定義方法によって、スタイル名の追加方法が決まります。詳しくは、ツールボックスのページをご覧ください。
ブロック
ブロックの定義方法によって、スタイル名の追加方法が決まります。ブロックの定義の詳細については、カスタム ブロックのページをご覧ください。テーマの blockStyles
プロパティで定義したブロック スタイルのいずれかをブロックに割り当てます。
JSON
"style":"logic_blocks"
JavaScript
this.setStyle('logic_blocks');
テーマを設定する
使用するテーマを Blockly に指示する必要もあります。同じブロック スタイルとカテゴリ名を使用する複数のテーマを定義することで、ユーザーは自分に最適なテーマを選択でき、ブロックの定義を自身で変更しなくても動的に変更できます。
最初のテーマ
初期テーマを設定するおすすめの方法は、挿入呼び出しに options.theme
を含めることです。テーマは JSON または JavaScript で指定できます。
JSON
{
theme: {
"blockStyles" : {
"list_blocks": {
"colourPrimary": "#4a148c",
"colourSecondary":"#AD7BE9",
"colourTertiary":"#CDB6E9"
}
},
"categoryStyles" : {
"list_category": {
"colour": "#4a148c"
}
},
"componentStyles" : {
"workspaceBackgroundColour": "#1e1e1e"
}
}
}
JavaScript
{
theme: Blockly.Theme.defineTheme('themeName', {
'blockStyles': blockStyles,
'categoryStyles': categoryStyles,
'componentStyles': componentStyles
})
}
オプションの詳細については、構成ページをご覧ください。テーマが指定されていない場合、デフォルトでクラシック テーマが使用されます。
ダイナミック テーマ
テーマを動的に変更する(たとえば、ユーザーがプルダウン メニューからテーマを選択できるようにする)場合は、yourWorkspace.setTheme(theme)
を呼び出します。
ブロック スタイル作成スクリプト
Blockly は色相または 16 進値のマップを受け取り、それらの第 2 色と第 3 色を計算するスクリプトを提供します。スクリプトは、scripts/themes フォルダにあります。
組み込みのテーマ
Blockly にはユーザー補助のテーマが数多く用意されており、特に特定の種類の色覚障がいがあります。
その他: