ジャバスクリプト API

Magic Translate クライアントをスクリプトで直接使用して、文字列を翻訳したり言語を変更したりすることもできる。

インスタンスを取得する

スクリプトタグを使用すると、ページが読み込まれて window.magicTranslate として利用可能になるとインスタンスが作成される。準備ができたらすぐに使用するには、magictranslate:ready イベントを聞いて:

document.addEventListener('magictranslate:ready', (event) => {
  const magicTranslate = event.detail;
});

npmでは、createMagicTranslate はインスタンスを返す。

コードに翻訳する

文字列を翻訳するには、translate を呼び出して。それは約束を返すよ。

const message = await magicTranslate.translate('Your order has been placed');

// with options
const formal = await magicTranslate.translate('How are you?', {
  lang: 'fr',
  formality: 'formal'
});

lang オプションがないと、テキストは現在の言語に翻訳される。id を付ければ、このテキストの使用法を単独で編集できる。

翻訳してはいけない値は v に入り、$name と表記される。テキストは、値が何であれ、テンプレートとして一度翻訳されてキャッシュされる。

const message = await magicTranslate.translate('Your order $id has shipped', {
  v: { id: order.id }
});

現在の言語

magicTranslate.language で現在の言語を読んで。setLanguage を使って変更してページをもう一度翻訳するか、onLanguageChange を使って言語が変わるたびにコールバックを実行する。

magicTranslate.setLanguage('fr');

const unsubscribe = magicTranslate.onLanguageChange((language) => {
  document.documentElement.lang = language;
});

停止する

destroy がページの翻訳を停止する。すでに翻訳されたコンテンツは翻訳されたままになる。

magicTranslate.destroy();