main_and_subについてもドキュメントを追加

Author: ensan-hcl

json/howToMake.md

@@ -45,6 +45,7 @@
 ```json
 "design": {
   "label": {
+    "type": "text",
     "text": "@#/&_"
   },
   "color": "normal"
@@ -53,10 +54,11 @@
 
 `"label"`はキーに表示されるラベルです。ラベルに指定できる値は次の通りです。
 
-| 項目              | 説明                                                         |
+| type              | 説明                                                         |
 | ----------------- | ------------------------------------------------------------ |
-| text: str         | 指定した文字をラベルとして表示します。                       |
-| system_image: str | 指定した画像をラベルとして表示します。指定できる値は以下の通りです。<br />この画像はSFSymbolsから取得されます。 |
+| text              | `"text"`に指定した文字をラベルとして表示します。                       |
+| main_and_sub      | `"main"`に指定した1文字を1行目に大きめに、`"sub"`に指定した文字列を2行目に小さめに表示します。 |
+| system_image      | `"system_image"`に指定した画像をラベルとして表示します。指定できる値は以下の通りです。<br />この画像はSFSymbolsから取得されます。 |
 
 <img src="../resource/symbols.png" style="zoom:15%;" />
 

python/howToMake.md

@@ -46,6 +46,7 @@ design = KeyDesign(
 | オブジェクト     | 初期化の引数    | 説明                                                         |
 | ---------------- | --------------- | ------------------------------------------------------------ |
 | TextLabel        | text: str       | 指定した文字をラベルとして表示します。                       |
+| MainAndSubLabel | main: str, sub: str | `main`に指定した1文字を1行目に大きめに、`sub`に指定した文字を2行目に小さめに表示します。 |
 | SystemImageLabel | identifier: str | 指定した名前の画像をラベルとして表示します。指定できる値は以下の通りです。<br />この画像はSFSymbolsから取得されます。 |
 
 <img src="../resource/symbols.png" style="zoom:15%;" />

python/source/design.py

@@ -23,6 +23,12 @@ class SystemImageLabel(KeyLabel):
     def __init__(self, identifier: str):
         self.system_image = identifier
 
+class MainAndSubLabel(KeyLabel):
+    def __init__(self, main: str, sub: str):
+        self.type = "main_and_sub"
+        self.main = main
+        self.sub = sub
+
 
 class KeyDesign:
     def __init__(self, label: KeyLabel, color: KeyColor):

python/test/test_design.py

@@ -43,6 +43,17 @@ def test_SystemImageLabel(self):
         }
         self.assertEqual(expected_json, to_json(label))
 
+    def test_MainAndSubLabel(self):
+        """test method for SystemImageLabel
+        """
+        label = MainAndSubLabel(main="A", sub="BC")
+        expected_json = {
+            "type": "main_and_sub",
+            "main": "A",
+            "sub": "BC"
+        }
+        self.assertEqual(expected_json, to_json(label))
+
     def test_KeyDesign(self):
         """test method for KeyDesign
         """

swift/howToMake.md

@@ -38,6 +38,7 @@ design: .init(label: .text("@#/&_"), color: .normal)
 | 項目                 | 説明                                                         |
 | -------------------- | ------------------------------------------------------------ |
 | .text(String)        | 指定した文字をラベルとして表示します。                       |
+| .mainAndSub(String, String) | 1つ目に指定した1文字を1行目に大きめに、2つ目に指定した文字を2行目に小さめに表示します。 |
 | .systemImage(String) | 指定した名前の画像をラベルとして表示します。指定できる値は以下の通りです。<br />この画像はSFSymbolsから取得されます。 |
 
 <img src="../resource/symbols.png" style="zoom:15%;" />