@fringeworks/react-icon-material-symbols 0.0.0-stage → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. package/LICENSE +21 -0
  2. package/MaterialSymbolOutlined/MaterialSymbolOutlined.cjs +16 -0
  3. package/MaterialSymbolOutlined/MaterialSymbolOutlined.d.cts +13 -0
  4. package/MaterialSymbolOutlined/MaterialSymbolOutlined.d.mts +13 -0
  5. package/MaterialSymbolOutlined/MaterialSymbolOutlined.mjs +15 -0
  6. package/MaterialSymbolOutlined/index.cjs +5 -0
  7. package/MaterialSymbolOutlined/index.d.cts +2 -0
  8. package/MaterialSymbolOutlined/index.d.mts +2 -0
  9. package/MaterialSymbolOutlined/index.mjs +3 -0
  10. package/MaterialSymbolRounded/MaterialSymbolRounded.cjs +16 -0
  11. package/MaterialSymbolRounded/MaterialSymbolRounded.d.cts +13 -0
  12. package/MaterialSymbolRounded/MaterialSymbolRounded.d.mts +13 -0
  13. package/MaterialSymbolRounded/MaterialSymbolRounded.mjs +15 -0
  14. package/MaterialSymbolRounded/index.cjs +5 -0
  15. package/MaterialSymbolRounded/index.d.cts +2 -0
  16. package/MaterialSymbolRounded/index.d.mts +2 -0
  17. package/MaterialSymbolRounded/index.mjs +3 -0
  18. package/MaterialSymbolSharp/MaterialSymbolSharp.cjs +16 -0
  19. package/MaterialSymbolSharp/MaterialSymbolSharp.d.cts +13 -0
  20. package/MaterialSymbolSharp/MaterialSymbolSharp.d.mts +13 -0
  21. package/MaterialSymbolSharp/MaterialSymbolSharp.mjs +15 -0
  22. package/MaterialSymbolSharp/index.cjs +5 -0
  23. package/MaterialSymbolSharp/index.d.cts +2 -0
  24. package/MaterialSymbolSharp/index.d.mts +2 -0
  25. package/MaterialSymbolSharp/index.mjs +3 -0
  26. package/README.ja.md +282 -0
  27. package/README.md +281 -2
  28. package/_internal/_createMaterialSymbol.cjs +59 -0
  29. package/_internal/_createMaterialSymbol.d.cts +14 -0
  30. package/_internal/_createMaterialSymbol.d.mts +14 -0
  31. package/_internal/_createMaterialSymbol.mjs +58 -0
  32. package/_internal/_materialSymbolValue.cjs +1 -0
  33. package/_internal/_materialSymbolValue.d.cts +8 -0
  34. package/_internal/_materialSymbolValue.d.mts +8 -0
  35. package/_internal/_materialSymbolValue.mjs +1 -0
  36. package/_styles.scss.cjs +5 -0
  37. package/_styles.scss.d.cts +1 -0
  38. package/_styles.scss.d.mts +1 -0
  39. package/_styles.scss.mjs +6 -0
  40. package/constants.cjs +17 -0
  41. package/constants.d.cts +15 -0
  42. package/constants.d.mts +15 -0
  43. package/constants.mjs +16 -0
  44. package/font-outlined.css +1 -0
  45. package/font-rounded.css +1 -0
  46. package/font-sharp.css +1 -0
  47. package/index.cjs +13 -0
  48. package/index.d.cts +10 -0
  49. package/index.d.mts +10 -0
  50. package/index.mjs +9 -0
  51. package/package.json +78 -4
  52. package/styles.css +44 -0
  53. package/types.cjs +1 -0
  54. package/types.d.cts +53 -0
  55. package/types.d.mts +53 -0
  56. package/types.mjs +1 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Mitsuhiro Seino
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,16 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require__internal__createMaterialSymbol = require("../_internal/_createMaterialSymbol.cjs");
3
+
4
+ // src/MaterialSymbolOutlined/MaterialSymbolOutlined.ts
5
+ /**
6
+ * Material Symbols の Outlined のアイコン(フォントファミリーは `Material Symbols Outlined`)
7
+ *
8
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
9
+ *
10
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
11
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
12
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
13
+ */
14
+ const MaterialSymbolOutlined = require__internal__createMaterialSymbol.default("Outlined");
15
+
16
+ exports.default = MaterialSymbolOutlined;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.cjs";
2
+ import "../index.cjs";
3
+ /**
4
+ * Material Symbols の Outlined のアイコン(フォントファミリーは `Material Symbols Outlined`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolOutlined: MaterialSymbolComponent;
13
+ export = MaterialSymbolOutlined;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.mjs";
2
+ import "../index.mjs";
3
+ /**
4
+ * Material Symbols の Outlined のアイコン(フォントファミリーは `Material Symbols Outlined`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolOutlined: MaterialSymbolComponent;
13
+ export { MaterialSymbolOutlined as default };
@@ -0,0 +1,15 @@
1
+ import createMaterialSymbol from "../_internal/_createMaterialSymbol.mjs";
2
+
3
+ // src/MaterialSymbolOutlined/MaterialSymbolOutlined.ts
4
+ /**
5
+ * Material Symbols の Outlined のアイコン(フォントファミリーは `Material Symbols Outlined`)
6
+ *
7
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
8
+ *
9
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
10
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
11
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
12
+ */
13
+ const MaterialSymbolOutlined = createMaterialSymbol("Outlined");
14
+
15
+ export { MaterialSymbolOutlined as default };
@@ -0,0 +1,5 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require_MaterialSymbolOutlined_MaterialSymbolOutlined = require("./MaterialSymbolOutlined.cjs");
3
+
4
+ exports.MaterialSymbolOutlined = require_MaterialSymbolOutlined_MaterialSymbolOutlined.default;
5
+ exports.default = require_MaterialSymbolOutlined_MaterialSymbolOutlined.default;
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolOutlined from "./MaterialSymbolOutlined.cjs";
2
+ export { MaterialSymbolOutlined, MaterialSymbolOutlined as default };
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolOutlined from "./MaterialSymbolOutlined.mjs";
2
+ export { MaterialSymbolOutlined, MaterialSymbolOutlined as default };
@@ -0,0 +1,3 @@
1
+ import MaterialSymbolOutlined from "./MaterialSymbolOutlined.mjs";
2
+
3
+ export { MaterialSymbolOutlined, MaterialSymbolOutlined as default };
@@ -0,0 +1,16 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require__internal__createMaterialSymbol = require("../_internal/_createMaterialSymbol.cjs");
3
+
4
+ // src/MaterialSymbolRounded/MaterialSymbolRounded.ts
5
+ /**
6
+ * Material Symbols の Rounded のアイコン(フォントファミリーは `Material Symbols Rounded`)
7
+ *
8
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
9
+ *
10
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
11
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
12
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
13
+ */
14
+ const MaterialSymbolRounded = require__internal__createMaterialSymbol.default("Rounded");
15
+
16
+ exports.default = MaterialSymbolRounded;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.cjs";
2
+ import "../index.cjs";
3
+ /**
4
+ * Material Symbols の Rounded のアイコン(フォントファミリーは `Material Symbols Rounded`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolRounded: MaterialSymbolComponent;
13
+ export = MaterialSymbolRounded;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.mjs";
2
+ import "../index.mjs";
3
+ /**
4
+ * Material Symbols の Rounded のアイコン(フォントファミリーは `Material Symbols Rounded`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolRounded: MaterialSymbolComponent;
13
+ export { MaterialSymbolRounded as default };
@@ -0,0 +1,15 @@
1
+ import createMaterialSymbol from "../_internal/_createMaterialSymbol.mjs";
2
+
3
+ // src/MaterialSymbolRounded/MaterialSymbolRounded.ts
4
+ /**
5
+ * Material Symbols の Rounded のアイコン(フォントファミリーは `Material Symbols Rounded`)
6
+ *
7
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
8
+ *
9
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
10
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
11
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
12
+ */
13
+ const MaterialSymbolRounded = createMaterialSymbol("Rounded");
14
+
15
+ export { MaterialSymbolRounded as default };
@@ -0,0 +1,5 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require_MaterialSymbolRounded_MaterialSymbolRounded = require("./MaterialSymbolRounded.cjs");
3
+
4
+ exports.MaterialSymbolRounded = require_MaterialSymbolRounded_MaterialSymbolRounded.default;
5
+ exports.default = require_MaterialSymbolRounded_MaterialSymbolRounded.default;
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolRounded from "./MaterialSymbolRounded.cjs";
2
+ export { MaterialSymbolRounded, MaterialSymbolRounded as default };
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolRounded from "./MaterialSymbolRounded.mjs";
2
+ export { MaterialSymbolRounded, MaterialSymbolRounded as default };
@@ -0,0 +1,3 @@
1
+ import MaterialSymbolRounded from "./MaterialSymbolRounded.mjs";
2
+
3
+ export { MaterialSymbolRounded, MaterialSymbolRounded as default };
@@ -0,0 +1,16 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require__internal__createMaterialSymbol = require("../_internal/_createMaterialSymbol.cjs");
3
+
4
+ // src/MaterialSymbolSharp/MaterialSymbolSharp.ts
5
+ /**
6
+ * Material Symbols の Sharp のアイコン(フォントファミリーは `Material Symbols Sharp`)
7
+ *
8
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
9
+ *
10
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
11
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
12
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
13
+ */
14
+ const MaterialSymbolSharp = require__internal__createMaterialSymbol.default("Sharp");
15
+
16
+ exports.default = MaterialSymbolSharp;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.cjs";
2
+ import "../index.cjs";
3
+ /**
4
+ * Material Symbols の Sharp のアイコン(フォントファミリーは `Material Symbols Sharp`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolSharp: MaterialSymbolComponent;
13
+ export = MaterialSymbolSharp;
@@ -0,0 +1,13 @@
1
+ import { MaterialSymbolComponent } from "../types.mjs";
2
+ import "../index.mjs";
3
+ /**
4
+ * Material Symbols の Sharp のアイコン(フォントファミリーは `Material Symbols Sharp`)
5
+ *
6
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
7
+ *
8
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
9
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
10
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
11
+ */
12
+ declare const MaterialSymbolSharp: MaterialSymbolComponent;
13
+ export { MaterialSymbolSharp as default };
@@ -0,0 +1,15 @@
1
+ import createMaterialSymbol from "../_internal/_createMaterialSymbol.mjs";
2
+
3
+ // src/MaterialSymbolSharp/MaterialSymbolSharp.ts
4
+ /**
5
+ * Material Symbols の Sharp のアイコン(フォントファミリーは `Material Symbols Sharp`)
6
+ *
7
+ * `value` でアイコンの名前を受け取り、`<span>` に描く。そのほかの props は `<span>` に渡す(`ref` も `<span>` を指す)。
8
+ *
9
+ * - `weight`・`filled`・`grade`・`opticalSize` と `design` で、可変フォントの軸を変えられる
10
+ * - `aria-label`・`aria-labelledby` が無ければ飾りとして `aria-hidden` を付け、あれば `role="img"` を付ける
11
+ * - 見た目には `@fringeworks/react-icon-material-symbols/styles.css` と、フォントの `@font-face` が要る
12
+ */
13
+ const MaterialSymbolSharp = createMaterialSymbol("Sharp");
14
+
15
+ export { MaterialSymbolSharp as default };
@@ -0,0 +1,5 @@
1
+ Object.defineProperties(exports, { __esModule: { value: true }, [Symbol.toStringTag]: { value: 'Module' } });
2
+ const require_MaterialSymbolSharp_MaterialSymbolSharp = require("./MaterialSymbolSharp.cjs");
3
+
4
+ exports.MaterialSymbolSharp = require_MaterialSymbolSharp_MaterialSymbolSharp.default;
5
+ exports.default = require_MaterialSymbolSharp_MaterialSymbolSharp.default;
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolSharp from "./MaterialSymbolSharp.cjs";
2
+ export { MaterialSymbolSharp, MaterialSymbolSharp as default };
@@ -0,0 +1,2 @@
1
+ import MaterialSymbolSharp from "./MaterialSymbolSharp.mjs";
2
+ export { MaterialSymbolSharp, MaterialSymbolSharp as default };
@@ -0,0 +1,3 @@
1
+ import MaterialSymbolSharp from "./MaterialSymbolSharp.mjs";
2
+
3
+ export { MaterialSymbolSharp, MaterialSymbolSharp as default };
package/README.ja.md ADDED
@@ -0,0 +1,282 @@
1
+ # @fringeworks/react-icon-material-symbols
2
+
3
+ `@fringeworks/react-icon-material-symbols` は、Google の [Material Symbols](https://fonts.google.com/icons) を、アイコン名の型と可変フォントの軸付きで React の部品として使う、誰かにとっては便利なライブラリです。
4
+
5
+ **[English README is available here](./README.md)**
6
+
7
+ [`@fringeworks/react-icon`](https://www.npmjs.com/package/@fringeworks/react-icon) のアダプターです。react-icon の部品と同じく `<Icon value="home" />` の形で描け、react-icon の `createPrefixedIcon` などと組み合わせられます。react-icon はこのパッケージと一緒に入るので、別に入れる必要はありません。
8
+
9
+ ## インストール
10
+
11
+ ```bash
12
+ npm install @fringeworks/react-icon-material-symbols
13
+ ```
14
+
15
+ React 18 と 19 に対応しています。
16
+
17
+ ## 使い方
18
+
19
+ 1. このパッケージの CSS を、アプリで1回読み込みます。アイコンの箱の CSS(react-icon のもの)も含んでいます。
20
+ 2. 使う種類のフォントを読み込みます。このパッケージの `font-<種類>.css` を読み込むのがいちばん簡単です(ほかの方法は下の「フォントの読み込み」)。
21
+ 3. 部品の `value` にアイコンの名前を渡します。
22
+
23
+ ```tsx
24
+ import { MaterialSymbolOutlined } from '@fringeworks/react-icon-material-symbols';
25
+ import '@fringeworks/react-icon-material-symbols/styles.css';
26
+ import '@fringeworks/react-icon-material-symbols/font-outlined.css';
27
+
28
+ <MaterialSymbolOutlined value="home" />;
29
+ ```
30
+
31
+ `value` の型は Material Symbols のアイコンの名前(`MaterialSymbolValue`)なので、補完が効き、書き間違いは型エラーになります。
32
+
33
+ ### 3つの種類
34
+
35
+ Material Symbols の種類ごとに部品が分かれています。アプリでは種類を1つにそろえることが多いので、短い名前は import の別名で付けてください。
36
+
37
+ | 部品 | フォントファミリー |
38
+ | ------------------------ | --------------------------- |
39
+ | `MaterialSymbolOutlined` | `Material Symbols Outlined` |
40
+ | `MaterialSymbolRounded` | `Material Symbols Rounded` |
41
+ | `MaterialSymbolSharp` | `Material Symbols Sharp` |
42
+
43
+ ```tsx
44
+ import { MaterialSymbolRounded as Icon } from '@fringeworks/react-icon-material-symbols';
45
+ ```
46
+
47
+ ### フォントの読み込み
48
+
49
+ フォントの読み込みは、アイコンの見た目(`styles.css`)とは別の入口にしています。次のどれかで、使う種類のフォントを読み込みます。どれも `@font-face` だけを使い、フォントに付いているクラス(`.material-symbols-outlined` など)は使いません。
50
+
51
+ **このパッケージの入口から読み込む**
52
+
53
+ ```ts
54
+ import '@fringeworks/react-icon-material-symbols/font-outlined.css';
55
+ ```
56
+
57
+ | 入口 | 読み込むフォント |
58
+ | ------------------- | --------------------------- |
59
+ | `font-outlined.css` | `Material Symbols Outlined` |
60
+ | `font-rounded.css` | `Material Symbols Rounded` |
61
+ | `font-sharp.css` | `Material Symbols Sharp` |
62
+
63
+ 中身は、このパッケージと一緒に入る npm の [`material-symbols`](https://www.npmjs.com/package/material-symbols) の CSS を読み込む `@import` です。フォントのファイルは、アプリのバンドラー(Vite・webpack・Next.js など)が `material-symbols` から取り込みます。フォントは全アイコン入りで、1種類 3.5〜5.4MB あります。
64
+
65
+ **Google Fonts から読み込む**
66
+
67
+ ```html
68
+ <link
69
+ rel="stylesheet"
70
+ href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-25..200&display=block"
71
+ />
72
+ ```
73
+
74
+ 可変フォントの軸を使うには、URL に軸の範囲(`opsz,wght,FILL,GRAD@20..48,100..700,0..1,-25..200`)を書きます。`&icon_names=home,search` を足すと、使うアイコンだけのフォントになり、ファイルが小さくなります。
75
+
76
+ **自分で配る**
77
+
78
+ 外部のサーバーにアクセスしない構成で、使うアイコンだけにサブセット化したフォントを配るときなどは、`@font-face` を自分で書きます。フォントファミリーの名前は、上の表のものにします。
79
+
80
+ このパッケージの入口を読み込まなければ、`material-symbols` のフォントはアプリに入りません(インストールはされます)。
81
+
82
+ 自分で配るときも `font-display: block` にしてください。フォントが届くまで(最大で約3秒)アイコンを描かず、アイコンの名前の文字が見えずに済みます(このパッケージの入口と、上の Google Fonts の URL は `block` です)。その間にスケルトンを出す方法は、下の「フォントの読み込み中にスケルトンを出す」にあります。
83
+
84
+ ### 大きさと色
85
+
86
+ アイコンは `1em` の正方形の箱に描き、大きさは親の `font-size` を、色は `color` を受け継ぎます。文やボタンの中では、周りの文字と同じ大きさ・色になります。Material Symbols の付属のクラスのように 24px に固定しないので、24px にしたいときは `font-size` を指定します。
87
+
88
+ ```tsx
89
+ <MaterialSymbolOutlined
90
+ value="home"
91
+ style={{ fontSize: 24, color: 'tomato' }}
92
+ />
93
+ ```
94
+
95
+ ### 可変フォントの軸
96
+
97
+ Material Symbols の4つの軸を、プロパティで変えられます。
98
+
99
+ ```tsx
100
+ <MaterialSymbolOutlined value="favorite" filled />
101
+ <MaterialSymbolOutlined value="settings" weight={300} grade={-25} />
102
+ <MaterialSymbolOutlined value="search" opticalSize={20} />
103
+ ```
104
+
105
+ | プロパティ | 軸 | 説明 |
106
+ | -------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
107
+ | `weight?` | `wght` | 太さ(100〜700)。CSS の `font-weight` で描く |
108
+ | `filled?` | `FILL` | 塗りつぶした形にする。既定は `false` |
109
+ | `grade?` | `GRAD` | グレード(-25〜200)。太さ(アイコンの大きさ)を変えずに、線の濃さを変える |
110
+ | `opticalSize?` | `opsz` | 光学サイズ(20〜48)。指定しなければ、ブラウザーが文字の大きさに合わせて決める(`font-optical-sizing: auto`) |
111
+
112
+ 軸の値は CSS 変数(`--frg-materialsymbol-filled` など。下の「デザインの値」の表)から組み立てるので、CSS でも軸ごとに変えられます。
113
+
114
+ ### アイコンに乗ったときに変える
115
+
116
+ `design` で、アイコンに乗ったとき(`:hover`)の値を軸ごとに指定できます。
117
+
118
+ ```tsx
119
+ <MaterialSymbolOutlined
120
+ value="favorite"
121
+ design={{ filled: { hover: 1 }, fontWeight: { hover: 600 } }}
122
+ />
123
+ ```
124
+
125
+ ボタンなど、親の要素に乗ったときに変えるには、CSS で変数を設定します。
126
+
127
+ ```css
128
+ .favorite-button:hover {
129
+ --frg-materialsymbol-filled: 1;
130
+ }
131
+ ```
132
+
133
+ `filled` などのプロパティを指定すると、要素に変数を書くので、親から受け継いだ値より優先されます。親の CSS で変えるアイコンには、そのプロパティを指定しないでください。
134
+
135
+ アプリで共通のデザインは、[`@fringeworks/react-contract`](https://www.npmjs.com/package/@fringeworks/react-contract) の `withDesign` で決められます。部品は、静的なプロパティ `designDefinition` にデザインの定義を持っています。
136
+
137
+ ```tsx
138
+ import { withDesign } from '@fringeworks/react-contract';
139
+
140
+ const Icon = withDesign(MaterialSymbolOutlined, { filled: { hover: 1 } });
141
+ ```
142
+
143
+ ### 読み上げ
144
+
145
+ `aria-label`・`aria-labelledby` を渡すと、画像(`role="img"`)として読み上げられます。渡さなければ、飾りとして `aria-hidden` が付きます。
146
+
147
+ ```tsx
148
+ <button type="button">
149
+ <MaterialSymbolOutlined value="search" /> 検索 {/* 飾り */}
150
+ </button>
151
+ <button type="button">
152
+ <MaterialSymbolOutlined value="search" aria-label="検索" /> {/* アイコンだけのボタン */}
153
+ </button>
154
+ ```
155
+
156
+ ### フォントの読み込み中にスケルトンを出す
157
+
158
+ 部品は、描くのに要る Web フォントを `webFonts` に持っています。[`@fringeworks/react-defer-rendering`](https://www.npmjs.com/package/@fringeworks/react-defer-rendering) の `useDeferUntilWebFontReady` にそのまま渡せます。
159
+
160
+ ```tsx
161
+ import { useDeferUntilWebFontReady } from '@fringeworks/react-defer-rendering';
162
+
163
+ function Toolbar() {
164
+ const { node } = useDeferUntilWebFontReady(
165
+ <MaterialSymbolOutlined value="home" />,
166
+ MaterialSymbolOutlined.webFonts,
167
+ { pending: <Skeleton /> },
168
+ );
169
+ return node;
170
+ }
171
+ ```
172
+
173
+ ### 型に無い名前を使う
174
+
175
+ `MaterialSymbolValue` は、このパッケージと一緒に入る npm の `material-symbols` の型で、入っているフォントの名前とそろいます。新しく増えたアイコンなど、型に無い名前を使いたいときは、react-icon の `createFontIcon` で名前の型を広げた部品を作れます(可変フォントの軸のプロパティと `design` は持ちません)。
176
+
177
+ ```tsx
178
+ import { createFontIcon } from '@fringeworks/react-icon';
179
+ import type { MaterialSymbolValue } from '@fringeworks/react-icon-material-symbols';
180
+
181
+ const Icon = createFontIcon<MaterialSymbolValue | 'new_icon'>({
182
+ fontFamily: 'Material Symbols Outlined',
183
+ });
184
+ ```
185
+
186
+ ## API
187
+
188
+ | 部品 | 説明 |
189
+ | ------------------------ | --------------------------------------- |
190
+ | `MaterialSymbolOutlined` | Material Symbols の Outlined のアイコン |
191
+ | `MaterialSymbolRounded` | Material Symbols の Rounded のアイコン |
192
+ | `MaterialSymbolSharp` | Material Symbols の Sharp のアイコン |
193
+
194
+ ### `MaterialSymbolOutlined`・`MaterialSymbolRounded`・`MaterialSymbolSharp`
195
+
196
+ ```ts
197
+ MaterialSymbolOutlined(props: MaterialSymbolProps): ReactElement
198
+ MaterialSymbolRounded(props: MaterialSymbolProps): ReactElement
199
+ MaterialSymbolSharp(props: MaterialSymbolProps): ReactElement
200
+ ```
201
+
202
+ `value` のアイコンを、`<span>` に合字の文字として描きます。そのほかの props は `<span>` に渡し(`ref` も `<span>` を指します)、`className`・`style` は合成して、同じプロパティは受け取った値を優先します。
203
+
204
+ | プロパティ | 型 | 説明 |
205
+ | -------------- | ---------------------- | -------------------------------------------------------------------------------------------- |
206
+ | `value` | `MaterialSymbolValue` | アイコンの名前 |
207
+ | `weight?` | `number` | 太さ(`wght`。100〜700) |
208
+ | `filled?` | `boolean` | 塗りつぶした形にする(`FILL`)。既定は `false` |
209
+ | `grade?` | `number` | グレード(`GRAD`。-25〜200) |
210
+ | `opticalSize?` | `number` | 光学サイズ(`opsz`。20〜48)。指定しなければ文字の大きさに合わせて決まる |
211
+ | `design?` | `MaterialSymbolDesign` | デザインの値(下の表)。同じ軸のプロパティを指定したら、状態なしの値はプロパティで上書きする |
212
+
213
+ 部品の静的なプロパティ:
214
+
215
+ | プロパティ | 型 | 説明 |
216
+ | ------------------ | --------------------------------------- | ----------------------------------------------------------------------------- |
217
+ | `webFonts` | `readonly FontIconWebFont[]` | 描くのに要る Web フォント(`[{ family: 'Material Symbols Outlined' }]` など) |
218
+ | `designDefinition` | `typeof materialSymbolDesignDefinition` | デザインの定義(react-contract の `withDesign` が読む) |
219
+ | `displayName` | `string` | `MaterialSymbolOutlined` など |
220
+
221
+ #### デザインの値
222
+
223
+ `design` で渡せるデザインの値です(CSS 変数は `--frg-materialsymbol-` の後にキーを `-` でつないだもの。例: `filled.hover` → `--frg-materialsymbol-filled-hover`)。`hover` の値を指定しなければ、乗ったときも状態なしの値のままです。
224
+
225
+ | キー | 既定値 | 説明 |
226
+ | ------------------ | ------ | ---------------------------------------------------------- |
227
+ | `fontWeight` | `400` | 太さ(`wght`) |
228
+ | `fontWeight.hover` | — | 乗ったときの太さ |
229
+ | `filled` | `0` | 塗り(`FILL`。0〜1。途中の値は、アニメーションの途中の形) |
230
+ | `filled.hover` | — | 乗ったときの塗り |
231
+ | `grade` | `0` | グレード(`GRAD`) |
232
+ | `grade.hover` | — | 乗ったときのグレード |
233
+ | `opticalSize` | — | 光学サイズ(`opsz`)。指定したときだけ固定する |
234
+
235
+ `design` の値は、[`@fringeworks/react-contract`](https://www.npmjs.com/package/@fringeworks/react-contract) の `createDesignStyle` の規則で書きます。`filled`・`grade`・`opticalSize` は、CSS のプロパティが無い可変フォントの軸のための名前です。
236
+
237
+ `opticalSize` を CSS 変数で指定するときは、要素に `frg-materialsymbol-opticalSize` のクラスも付けてください。`font-variation-settings` に `opsz` を書くと、文字の大きさに合わせた自動の光学サイズが効かなくなるので、このクラスがあるときだけ `opsz` を書いています(部品の `opticalSize` か `design.opticalSize` を指定すると、部品が付けます)。
238
+
239
+ ### CSS の入口
240
+
241
+ | 入口 | 説明 |
242
+ | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
243
+ | `styles.css` | アイコンの見た目(react-icon の箱の CSS を含む)。フォントは含まない |
244
+ | `font-outlined.css`・`font-rounded.css`・`font-sharp.css` | 種類ごとのフォントの読み込み(npm の `material-symbols` の `@font-face`)。Google Fonts や自分で配るフォントを使うときは読み込まない |
245
+
246
+ ### CSS のクラス
247
+
248
+ | クラス | 説明 |
249
+ | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
250
+ | `frg-icon`・`frg-fonticon` | react-icon のクラス(`1em` の正方形の箱と、アイコンフォントの指定) |
251
+ | `frg-materialsymbol` | Material Symbols のすべてのアイコン。可変フォントの軸を CSS 変数から組み立てる |
252
+ | `frg-materialsymboloutlined`・`frg-materialsymbolrounded`・`frg-materialsymbolsharp` | 種類ごとのクラス。種類を選ぶためのもので、CSS の規則は持たない(フォントファミリーは部品が `style` で指定する) |
253
+ | `frg-materialsymbol-opticalSize` | 光学サイズを固定するときに付く |
254
+
255
+ クラスの規則は詳細度が 0(`:where()`)なので、利用者の CSS でそのまま上書きできます。
256
+
257
+ ### 定数
258
+
259
+ | 定数 | 説明 |
260
+ | -------------------------------- | ------------------------------------------ |
261
+ | `materialSymbolDesignDefinition` | 部品のデザインの定義(`designDefinition`) |
262
+
263
+ ### 型
264
+
265
+ | 型 | 説明 |
266
+ | ------------------------- | --------------------------------------------------------------------------------------------------- |
267
+ | `MaterialSymbolValue` | Material Symbols のアイコンの名前(npm の `material-symbols` の型) |
268
+ | `MaterialSymbolProps` | 部品のプロパティ |
269
+ | `MaterialSymbolDesign` | 部品の `design` の値 |
270
+ | `MaterialSymbolComponent` | 部品の型(静的なプロパティを含む) |
271
+ | `FontIconWebFont` | `webFonts` の要素(`@fringeworks/react-icon` の型) |
272
+ | `DesignDefinition` | 部品のデザインの定義(`materialSymbolDesignDefinition` の型)(`@fringeworks/react-contract` の型) |
273
+ | `DesignPartDefinition` | ルートまたは部分の、受け付けるプロパティと効く状態(`@fringeworks/react-contract` の型) |
274
+ | `DesignPropertyValues` | デザインのプロパティの名前と値の型(`@fringeworks/react-contract` の型) |
275
+ | `DesignState` | デザインの値を分ける状態(`@fringeworks/react-contract` の型) |
276
+ | `DesignValue<T, S>` | 1つの値か、状態ごとのオブジェクト(`@fringeworks/react-contract` の型) |
277
+
278
+ ## ライセンス
279
+
280
+ MIT
281
+
282
+ アイコンの名前の型(`MaterialSymbolValue`)とフォントは、npm の [`material-symbols`](https://github.com/marella/material-symbols) のものを使っています。Material Symbols は Google のもので、どちらも [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) で配布されています。