@sigma-studio/editor 0.306.2 → 0.402.1

package/README.md

@@ -167,6 +167,8 @@ interface SigmaDocEditorProps {
   className?: string;
   style?: React.CSSProperties;
   editorRef?: { current: SigmaDocEditorHandle | null };
+  /** UI表示言語。省略時はブラウザ/OSロケールを検出し、判定できなければ日本語。 */
+  locale?: "ja" | "en";
 }
 
 interface SigmaDocEditorHandle {
@@ -176,6 +178,16 @@ interface SigmaDocEditorHandle {
 }
 ```
 
+## 表示言語
+
+`locale`に`"ja"`か`"en"`を渡すとEditorのUI言語が切り替わります。省略した場合は「以前この端末で選ばれた言語 → ブラウザ/OSのロケール → 日本語」の順で決まります。
+
+言語を渡すと、その選択はホストページの`localStorage`(`sigma-studio:ui-locale`)に残ります。したがって**一度`locale="en"`を渡した後にpropを外しても英語のまま**です。ホスト側が言語を所有している場合は、propを外さずに現在の言語を渡し続けてください。
+
+ホストページの`<html lang>`は変更しません(ページ全体の言語指定はホストのものだからです)。読み上げやハイフネーションを表示言語に合わせたい場合は、ホスト側で`document.documentElement.lang`を設定してください。
+
+言語設定はモジュールグローバルです。**1つのページに2つの`SigmaDocEditor`を別々の言語で置くことはできません** (後からmountした方の`locale`が両方に効きます)。インスタンスごとに言語を分ける必要が出た場合は、i18nextインスタンスを分ける対応が必要です。
+
 ## 互換性
 
 - React / React DOM: `>=18.2.0 <20`

package/dist/SigmaDocEditor.d.ts

@@ -20,9 +20,23 @@ export interface SigmaDocEditorProps {
     editorRef?: {
         current: SigmaDocEditorHandle | null;
     };
+    /**
+     * UI 表示言語。
+     *
+     * 省略時は「以前この端末で選ばれた言語 → ブラウザ / OS ロケール → 日本語」の順で
+     * 決まる。一度渡した `locale` はホストページの `localStorage`
+     * (`sigma-studio:ui-locale`) に残るため、後から prop を外しても直前の言語のままになる。
+     *
+     * ホストページの `<html lang>` は変更しない。ページ全体の言語指定はホストのもの
+     * なので、読み上げ等を合わせたい場合はホスト側で設定すること。
+     *
+     * ロケールはモジュールグローバルなので、1 ページに 2 つの `SigmaDocEditor` を
+     * 別々の言語で置くことはできない。
+     */
+    locale?: "ja" | "en";
 }
 /**
  * Sigma Studio desktop の EditorShell をそのまま組み込み、SigmaDoc の
  * 入出力だけをホストへ委譲する薄いアダプター。
  */
-export declare function SigmaDocEditor({ document, onChange, onSave, className, style, editorRef, }: SigmaDocEditorProps): import("react/jsx-runtime").JSX.Element;
+export declare function SigmaDocEditor({ document, onChange, onSave, className, style, editorRef, locale, }: SigmaDocEditorProps): import("react/jsx-runtime").JSX.Element;