Variable

翻訳コンテンツで使用する variables の型定義

概要

Variable は、翻訳内で動的コンテンツを差し込むためのプレースホルダーです。

type Variable = {
  k: string;
  i?: number;
  v?: VariableType;
};

プロパティ

プロパティ説明
kstringVariable のキー/名称
i?number内部識別子
v?VariableType形式設定タイプ

VariableType

type VariableType = 'v' | 'n' | 'd' | 'c';
説明
'v'プレーンテキストの置換
'n'数値のフォーマット
'd'日付のフォーマット
'c'通貨のフォーマット

基本的な使用方法

import { Variable } from 'generaltranslation';

// テキスト変数
const nameVariable: Variable = {
  k: 'userName'
};

// 数値変数
const countVariable: Variable = {
  k: 'itemCount',
  v: 'n'
};

// 通貨変数
const priceVariable: Variable = {
  k: 'price',
  v: 'c'
};

JSX 内で

const welcomeContent = [
  'おかえりなさい、',
  { k: 'userName' } as Variable,
  '!',
  { k: 'messageCount', v: 'n' } as Variable,
  '件のメッセージがあります。'
];

関連する型

このガイドはどうでしたか?

Variable