@k8ordo/ui

コンポーネントの文言

閉じるボタンのラベルや必須の印のように、コンポーネントが自分で表示する文言は、@k8ordo/i18nの現在のロケールに従います。ほかの言語の登録や一部の差し替えをして、自作の要素からも同じ文言を読めるようになります。

このページの内容

ロケールの決まり方

src/i18n.ts
import { defineLocales } from '@k8ordo/i18n';

export const locales = defineLocales({
  ja: { timeZone: 'Asia/Tokyo', dir: 'ltr' },
  en: { timeZone: 'UTC', dir: 'ltr' },
});

アプリがdefineLocalesでロケールの一覧を定義していれば、コンポーネントはアプリの文言と同じロケールで表示します。URLにロケールがあればそのロケールで、無ければ一覧の既定のロケールです。プロバイダも、渡す設定もありません。

警告

落とし穴

一覧を定義したモジュールは、ブラウザでも読み込まれている必要があります。ブラウザに一覧が無いとコンポーネントが英語で表示するので、ハイドレーションでサーバーのHTMLと食い違います。@k8ordo/frameworkは、何かを描く前にブラウザでsrc/i18n.tsを読み込みます。ほかのフレームワークでは、ルートが描くClient Componentからimportします。

一覧が無いアプリ

src/i18n.ts
import { defineLocales } from '@k8ordo/i18n';

export const locales = defineLocales({
  ja: { timeZone: 'Asia/Tokyo', dir: 'ltr' },
});

日本語だけのアプリは、このようにロケールが1つだけの一覧を定義します。

@k8ordo/i18nでロケールの一覧を定義していないアプリでは、コンポーネントは英語で表示します。Next.jsや素のViteのアプリなどがこれにあたります。URLが/ja/で始まっていても変わらないので、サーバーとブラウザは食い違いません。

ほかの言語の登録

src/messages/ui-fr.ts
import type { Messages } from '@k8ordo/ui/i18n';

export const fr: Messages = {
  close: 'Fermer',
  required: 'Requis',
  loading: 'Chargement',
  // ...
};

日本語と英語の辞書はライブラリが持ちます。ほかのロケールは、@k8ordo/ui/i18nのregisterMessagesで辞書を登録します。辞書にMessages型を付けると、キーの過不足が型エラーになります。ライブラリにキーが増えたときも型で気づけます。

src/i18n.ts
import { defineLocales } from '@k8ordo/i18n';
import { registerMessages } from '@k8ordo/ui/i18n';

import { fr } from './messages/ui-fr';

export const locales = defineLocales({
  ja: { timeZone: 'Asia/Tokyo', dir: 'ltr' },
  fr: { timeZone: 'Europe/Paris', dir: 'ltr' },
});

registerMessages('fr', fr);

registerMessagesは、ロケールの一覧を定義するモジュールで呼びます。

en-USのように地域の付いたタグは、そのタグの辞書が無ければ言語(en)の辞書を使います。登録も組み込みの辞書も無いロケールで表示しようとすると、エラーになります。エラー文はそのロケールを挙げて(no built-in text for "de")、registerMessagesでの登録を促します。

一部の差し替え

src/i18n.ts
import { en, ja, registerMessages } from '@k8ordo/ui/i18n';

registerMessages('ja', { ...ja, close: '閉じる (Esc)' });
registerMessages('en', { ...en, autocompleteEmpty: 'No matches' });

組み込みのjaやenを展開し、変えたいキーだけを重ねて登録します。

優先順位

1つの文言は、次の順に決まります。

  1. コンポーネントのprops:Spinnerのlabelのような、文言を受け取るprops
  2. 登録した辞書:registerMessagesで登録した辞書
  3. 組み込みの辞書:ライブラリが持つ日本語と英語の辞書

1か所だけ変えるときは、propsを使います。

自作の要素の文言

dismiss-button.tsx
import { getMessages } from '@k8ordo/ui/i18n';

export function DismissButton({ onDismiss }) {
  const { close } = getMessages();
  return (
    <button aria-label={close} onClick={onDismiss} type="button">
      ×
    </button>
  );
}

@k8ordo/ui/i18nのgetMessages()は、現在のロケールの文言を返します。フックではないので、Server ComponentからもClient Componentからも呼べます。

renderItemで返す要素や自作のコンポーネントでgetMessages()から読めば、言語も差し替えもコンポーネントとそろいます。

propsの文言

src/components/add-to-cart.tsx
import { Button } from '@k8ordo/ui';

import { add } from '../messages/cart';

export function AddToCart() {
  return <Button>{add()}</Button>;
}

@k8ordo/i18nのmessageで書いた文言は関数なので、呼んだ結果をpropsに渡します。書き方は文言を見てください。

キーの一覧

Messagesが持つすべてのキーです。値はライブラリの辞書から読み込んでいます。

close
使うコンポーネント:Alert / Dialog / Drawer / Response
ja:閉じる
en(一覧が無いとき):Close
required
使うコンポーネント:FormControl
ja:必須
en(一覧が無いとき):Required
loading
使うコンポーネント:Spinner / Progress / Combobox
ja:読み込み中
en(一覧が無いとき):Loading
avatar
使うコンポーネント:Avatar
ja:アバター
en(一覧が無いとき):Avatar
color
使うコンポーネント:Code
ja:色
en(一覧が無いとき):Color
alertSuccess
使うコンポーネント:Alert / Callout
ja:成功
en(一覧が無いとき):Success
alertInfo
使うコンポーネント:Alert / Callout
ja:情報
en(一覧が無いとき):Information
alertWarning
使うコンポーネント:Alert / Callout
ja:警告
en(一覧が無いとき):Warning
alertError
使うコンポーネント:Alert / Callout
ja:エラー
en(一覧が無いとき):Error
toastRegion
使うコンポーネント:ToastProvider
ja:通知
en(一覧が無いとき):Notifications
copy
使うコンポーネント:CopyButton / Message.Copy
ja:コピー
en(一覧が無いとき):Copy
copied
使うコンポーネント:CopyButton / CodeBlock / Message.Copy
ja:コピーしました
en(一覧が無いとき):Copied
copyFailed
使うコンポーネント:CopyButton / CodeBlock / Message.Copy
ja:コピーできませんでした
en(一覧が無いとき):Could not copy
autocompletePlaceholder
使うコンポーネント:Autocomplete
ja:入力して絞り込めます
en(一覧が無いとき):Type to filter
autocompleteRemoveTag
使うコンポーネント:Autocomplete
ja:タグを削除
en(一覧が無いとき):Remove tag
autocompleteClear
使うコンポーネント:Autocomplete
ja:すべて削除
en(一覧が無いとき):Clear all
autocompleteEmpty
使うコンポーネント:Autocomplete
ja:該当なし
en(一覧が無いとき):No results
comboboxToggle
使うコンポーネント:Combobox
ja:候補を開く
en(一覧が無いとき):Show options
comboboxEmpty
使うコンポーネント:Combobox
ja:該当なし
en(一覧が無いとき):No results
comboboxFailed
使うコンポーネント:Combobox
ja:候補を読み込めませんでした
en(一覧が無いとき):Could not load options
fileFieldRemove
使うコンポーネント:FileField
ja:ファイルを削除
en(一覧が無いとき):Remove file
fileFieldTrigger
使うコンポーネント:FileField.Dropzone / FileField (generative UI)
ja:ファイルを選択
en(一覧が無いとき):Select files
fileFieldDrop
使うコンポーネント:FileField.Dropzone / FileField (generative UI)
ja:ここにファイルをドロップ
en(一覧が無いとき):Drop files here
numberFieldIncrement
使うコンポーネント:NumberField
ja:増やす
en(一覧が無いとき):Increase
numberFieldDecrement
使うコンポーネント:NumberField
ja:減らす
en(一覧が無いとき):Decrease
numberFieldRangeUnderflow
使うコンポーネント:NumberField
ja:{min} 以上で入力してください
en(一覧が無いとき):Enter {min} or more
numberFieldRangeOverflow
使うコンポーネント:NumberField
ja:{max} 以下で入力してください
en(一覧が無いとき):Enter {max} or less
rangeSliderStart
使うコンポーネント:RangeSlider
ja:最小
en(一覧が無いとき):minimum
rangeSliderEnd
使うコンポーネント:RangeSlider
ja:最大
en(一覧が無いとき):maximum
calendarPreviousMonth
使うコンポーネント:Calendar / DatePicker
ja:前の月
en(一覧が無いとき):Previous month
calendarNextMonth
使うコンポーネント:Calendar / DatePicker
ja:次の月
en(一覧が無いとき):Next month
datePickerOpen
使うコンポーネント:DatePicker
ja:カレンダーから選ぶ
en(一覧が無いとき):Choose from calendar
datePickerDialog
使うコンポーネント:DatePicker
ja:日付を選ぶ
en(一覧が無いとき):Choose a date
colorPickerHue
使うコンポーネント:ColorPicker
ja:色相
en(一覧が無いとき):Hue
colorPickerSaturation
使うコンポーネント:ColorPicker
ja:彩度
en(一覧が無いとき):Saturation
colorPickerLightness
使うコンポーネント:ColorPicker
ja:明度
en(一覧が無いとき):Lightness
colorPickerSwatches
使うコンポーネント:ColorPicker
ja:色の見本
en(一覧が無いとき):Swatches
colorPickerOpen
使うコンポーネント:ColorPicker
ja:パレットから選ぶ
en(一覧が無いとき):Choose from palette
passwordShow
使うコンポーネント:PasswordInput
ja:パスワードを表示
en(一覧が無いとき):Show password
passwordHide
使うコンポーネント:PasswordInput
ja:パスワードを非表示
en(一覧が無いとき):Hide password
listBoxPlaceholder
使うコンポーネント:ListBox
ja:選択してください
en(一覧が無いとき):Select an option
breadcrumb
使うコンポーネント:Breadcrumb
ja:パンくずリスト
en(一覧が無いとき):Breadcrumb
tabList
使うコンポーネント:Tabs (generative UI)
ja:タブ
en(一覧が無いとき):Tabs
paginationLabel
使うコンポーネント:Pagination
ja:ページネーション
en(一覧が無いとき):Pagination
paginationPrevious
使うコンポーネント:Pagination
ja:前へ
en(一覧が無いとき):Previous
paginationNext
使うコンポーネント:Pagination
ja:次へ
en(一覧が無いとき):Next
stepperComplete
使うコンポーネント:Stepper
ja:完了
en(一覧が無いとき):completed
dataTableColumns
使うコンポーネント:DataTable
ja:表示する列
en(一覧が無いとき):Columns
dataTableSelectAll
使うコンポーネント:DataTable
ja:すべての行を選択
en(一覧が無いとき):Select all rows
dataTableSelectRow
使うコンポーネント:DataTable
ja:行を選択
en(一覧が無いとき):Select row
codeBlockCopy
使うコンポーネント:CodeBlock
ja:コードをコピー
en(一覧が無いとき):Copy code
carousel
使うコンポーネント:Carousel
ja:カルーセル
en(一覧が無いとき):Carousel
carouselSlide
使うコンポーネント:Carousel.Slide
ja:スライド
en(一覧が無いとき):Slide
carouselPrevious
使うコンポーネント:Carousel
ja:前のスライド
en(一覧が無いとき):Previous slide
carouselNext
使うコンポーネント:Carousel
ja:次のスライド
en(一覧が無いとき):Next slide
resizablePanelsHandle
使うコンポーネント:ResizablePanels.Handle
ja:パネルの大きさ
en(一覧が無いとき):Panel size
tableOfContents
使うコンポーネント:TableOfContents
ja:目次
en(一覧が無いとき):Contents
commandPalette
使うコンポーネント:CommandPalette
ja:コマンド
en(一覧が無いとき):Commands
commandPaletteSearch
使うコンポーネント:CommandPalette
ja:コマンドを検索
en(一覧が無いとき):Search commands
commandPaletteEmpty
使うコンポーネント:CommandPalette
ja:一致するコマンドはありません
en(一覧が無いとき):No matching commands
chat
使うコンポーネント:Conversation.Messages
ja:チャット
en(一覧が無いとき):Chat
scrollToLatest
使うコンポーネント:Conversation.ScrollButton
ja:最新のメッセージへ移動
en(一覧が無いとき):Scroll to latest message
reasoning
使うコンポーネント:Reasoning
ja:思考の過程
en(一覧が無いとき):Reasoning
reasoningStreaming
使うコンポーネント:Reasoning
ja:思考中…
en(一覧が無いとき):Thinking…
suggestions
使うコンポーネント:Suggestion.List
ja:候補
en(一覧が無いとき):Suggestions
send
使うコンポーネント:PromptInput
ja:送信
en(一覧が無いとき):Send
stop
使うコンポーネント:PromptInput
ja:停止
en(一覧が無いとき):Stop
attach
使うコンポーネント:PromptInput.Attach
ja:ファイルを添付
en(一覧が無いとき):Attach files
attachments
使うコンポーネント:Attachment.List / PromptInput.Attachments
ja:添付ファイル
en(一覧が無いとき):Attachments
attachmentRemove
使うコンポーネント:PromptInput.Attachments
ja:添付を外す
en(一覧が無いとき):Remove attachment
attachmentImage
使うコンポーネント:Attachment.Item / PromptInput.Attachments
ja:添付画像
en(一覧が無いとき):Attached image
sources
使うコンポーネント:Source.List
ja:出典
en(一覧が無いとき):Sources
messageActions
使うコンポーネント:Message.Actions
ja:メッセージの操作
en(一覧が無いとき):Message actions
regenerate
使うコンポーネント:Message.Regenerate
ja:再生成
en(一覧が無いとき):Regenerate
feedbackPositive
使うコンポーネント:Message.Feedback
ja:良い回答
en(一覧が無いとき):Good response
feedbackNegative
使うコンポーネント:Message.Feedback
ja:良くない回答
en(一覧が無いとき):Bad response
toolInput
使うコンポーネント:ToolInvocation
ja:入力
en(一覧が無いとき):Input
toolOutput
使うコンポーネント:ToolInvocation
ja:出力
en(一覧が無いとき):Output
toolError
使うコンポーネント:ToolInvocation
ja:ツールの実行でエラーが発生しました。
en(一覧が無いとき):The tool failed to run.
toolDenied
使うコンポーネント:ToolInvocation
ja:ツールの実行は許可されませんでした。
en(一覧が無いとき):The tool run was not approved.
toolApprovalRequest
使うコンポーネント:ToolInvocation
ja:このツールの実行を許可しますか?
en(一覧が無いとき):Allow this tool to run?
toolApprove
使うコンポーネント:ToolInvocation
ja:許可
en(一覧が無いとき):Allow
toolDeny
使うコンポーネント:ToolInvocation
ja:拒否
en(一覧が無いとき):Deny
responseCopied
使うコンポーネント:Response
ja:コピーしました
en(一覧が無いとき):Copied
responseCopyCode
使うコンポーネント:Response
ja:コードをコピー
en(一覧が無いとき):Copy code
responseCopyLink
使うコンポーネント:Response
ja:リンクをコピー
en(一覧が無いとき):Copy link
responseCopyTable
使うコンポーネント:Response
ja:表をコピー
en(一覧が無いとき):Copy table
responseCopyTableAsCsv
使うコンポーネント:Response
ja:表を CSV でコピー
en(一覧が無いとき):Copy table as CSV
responseCopyTableAsMarkdown
使うコンポーネント:Response
ja:表を Markdown でコピー
en(一覧が無いとき):Copy table as Markdown
responseCopyTableAsTsv
使うコンポーネント:Response
ja:表を TSV でコピー
en(一覧が無いとき):Copy table as TSV
responseDownloadDiagram
使うコンポーネント:Response
ja:図をダウンロード
en(一覧が無いとき):Download diagram
responseDownloadDiagramAsMmd
使うコンポーネント:Response
ja:図を MMD でダウンロード
en(一覧が無いとき):Download diagram as MMD
responseDownloadDiagramAsPng
使うコンポーネント:Response
ja:図を PNG でダウンロード
en(一覧が無いとき):Download diagram as PNG
responseDownloadDiagramAsSvg
使うコンポーネント:Response
ja:図を SVG でダウンロード
en(一覧が無いとき):Download diagram as SVG
responseDownloadFile
使うコンポーネント:Response
ja:ファイルをダウンロード
en(一覧が無いとき):Download file
responseDownloadImage
使うコンポーネント:Response
ja:画像をダウンロード
en(一覧が無いとき):Download image
responseDownloadTable
使うコンポーネント:Response
ja:表をダウンロード
en(一覧が無いとき):Download table
responseDownloadTableAsCsv
使うコンポーネント:Response
ja:表を CSV でダウンロード
en(一覧が無いとき):Download table as CSV
responseDownloadTableAsMarkdown
使うコンポーネント:Response
ja:表を Markdown でダウンロード
en(一覧が無いとき):Download table as Markdown
responseExitFullscreen
使うコンポーネント:Response
ja:全画面表示を終了
en(一覧が無いとき):Exit fullscreen
responseViewFullscreen
使うコンポーネント:Response
ja:全画面表示
en(一覧が無いとき):View fullscreen
responseImageNotAvailable
使うコンポーネント:Response
ja:画像を表示できません
en(一覧が無いとき):Image not available
responseOpenExternalLink
使うコンポーネント:Response
ja:外部リンクを開きますか?
en(一覧が無いとき):Open external link?
responseExternalLinkWarning
使うコンポーネント:Response
ja:外部サイトに移動しようとしています。
en(一覧が無いとき):You're about to visit an external website.
responseOpenLink
使うコンポーネント:Response
ja:リンクを開く
en(一覧が無いとき):Open link
キー使うコンポーネントjaen(一覧が無いとき)
closeAlert / Dialog / Drawer / Response閉じるClose
requiredFormControl必須Required
loadingSpinner / Progress / Combobox読み込み中Loading
avatarAvatarアバターAvatar
colorCode色Color
alertSuccessAlert / Callout成功Success
alertInfoAlert / Callout情報Information
alertWarningAlert / Callout警告Warning
alertErrorAlert / CalloutエラーError
toastRegionToastProvider通知Notifications
copyCopyButton / Message.CopyコピーCopy
copiedCopyButton / CodeBlock / Message.CopyコピーしましたCopied
copyFailedCopyButton / CodeBlock / Message.CopyコピーできませんでしたCould not copy
autocompletePlaceholderAutocomplete入力して絞り込めますType to filter
autocompleteRemoveTagAutocompleteタグを削除Remove tag
autocompleteClearAutocompleteすべて削除Clear all
autocompleteEmptyAutocomplete該当なしNo results
comboboxToggleCombobox候補を開くShow options
comboboxEmptyCombobox該当なしNo results
comboboxFailedCombobox候補を読み込めませんでしたCould not load options
fileFieldRemoveFileFieldファイルを削除Remove file
fileFieldTriggerFileField.Dropzone / FileField (generative UI)ファイルを選択Select files
fileFieldDropFileField.Dropzone / FileField (generative UI)ここにファイルをドロップDrop files here
numberFieldIncrementNumberField増やすIncrease
numberFieldDecrementNumberField減らすDecrease
numberFieldRangeUnderflowNumberField{min} 以上で入力してくださいEnter {min} or more
numberFieldRangeOverflowNumberField{max} 以下で入力してくださいEnter {max} or less
rangeSliderStartRangeSlider最小minimum
rangeSliderEndRangeSlider最大maximum
calendarPreviousMonthCalendar / DatePicker前の月Previous month
calendarNextMonthCalendar / DatePicker次の月Next month
datePickerOpenDatePickerカレンダーから選ぶChoose from calendar
datePickerDialogDatePicker日付を選ぶChoose a date
colorPickerHueColorPicker色相Hue
colorPickerSaturationColorPicker彩度Saturation
colorPickerLightnessColorPicker明度Lightness
colorPickerSwatchesColorPicker色の見本Swatches
colorPickerOpenColorPickerパレットから選ぶChoose from palette
passwordShowPasswordInputパスワードを表示Show password
passwordHidePasswordInputパスワードを非表示Hide password
listBoxPlaceholderListBox選択してくださいSelect an option
breadcrumbBreadcrumbパンくずリストBreadcrumb
tabListTabs (generative UI)タブTabs
paginationLabelPaginationページネーションPagination
paginationPreviousPagination前へPrevious
paginationNextPagination次へNext
stepperCompleteStepper完了completed
dataTableColumnsDataTable表示する列Columns
dataTableSelectAllDataTableすべての行を選択Select all rows
dataTableSelectRowDataTable行を選択Select row
codeBlockCopyCodeBlockコードをコピーCopy code
carouselCarouselカルーセルCarousel
carouselSlideCarousel.SlideスライドSlide
carouselPreviousCarousel前のスライドPrevious slide
carouselNextCarousel次のスライドNext slide
resizablePanelsHandleResizablePanels.Handleパネルの大きさPanel size
tableOfContentsTableOfContents目次Contents
commandPaletteCommandPaletteコマンドCommands
commandPaletteSearchCommandPaletteコマンドを検索Search commands
commandPaletteEmptyCommandPalette一致するコマンドはありませんNo matching commands
chatConversation.MessagesチャットChat
scrollToLatestConversation.ScrollButton最新のメッセージへ移動Scroll to latest message
reasoningReasoning思考の過程Reasoning
reasoningStreamingReasoning思考中…Thinking…
suggestionsSuggestion.List候補Suggestions
sendPromptInput送信Send
stopPromptInput停止Stop
attachPromptInput.Attachファイルを添付Attach files
attachmentsAttachment.List / PromptInput.Attachments添付ファイルAttachments
attachmentRemovePromptInput.Attachments添付を外すRemove attachment
attachmentImageAttachment.Item / PromptInput.Attachments添付画像Attached image
sourcesSource.List出典Sources
messageActionsMessage.Actionsメッセージの操作Message actions
regenerateMessage.Regenerate再生成Regenerate
feedbackPositiveMessage.Feedback良い回答Good response
feedbackNegativeMessage.Feedback良くない回答Bad response
toolInputToolInvocation入力Input
toolOutputToolInvocation出力Output
toolErrorToolInvocationツールの実行でエラーが発生しました。The tool failed to run.
toolDeniedToolInvocationツールの実行は許可されませんでした。The tool run was not approved.
toolApprovalRequestToolInvocationこのツールの実行を許可しますか?Allow this tool to run?
toolApproveToolInvocation許可Allow
toolDenyToolInvocation拒否Deny
responseCopiedResponseコピーしましたCopied
responseCopyCodeResponseコードをコピーCopy code
responseCopyLinkResponseリンクをコピーCopy link
responseCopyTableResponse表をコピーCopy table
responseCopyTableAsCsvResponse表を CSV でコピーCopy table as CSV
responseCopyTableAsMarkdownResponse表を Markdown でコピーCopy table as Markdown
responseCopyTableAsTsvResponse表を TSV でコピーCopy table as TSV
responseDownloadDiagramResponse図をダウンロードDownload diagram
responseDownloadDiagramAsMmdResponse図を MMD でダウンロードDownload diagram as MMD
responseDownloadDiagramAsPngResponse図を PNG でダウンロードDownload diagram as PNG
responseDownloadDiagramAsSvgResponse図を SVG でダウンロードDownload diagram as SVG
responseDownloadFileResponseファイルをダウンロードDownload file
responseDownloadImageResponse画像をダウンロードDownload image
responseDownloadTableResponse表をダウンロードDownload table
responseDownloadTableAsCsvResponse表を CSV でダウンロードDownload table as CSV
responseDownloadTableAsMarkdownResponse表を Markdown でダウンロードDownload table as Markdown
responseExitFullscreenResponse全画面表示を終了Exit fullscreen
responseViewFullscreenResponse全画面表示View fullscreen
responseImageNotAvailableResponse画像を表示できませんImage not available
responseOpenExternalLinkResponse外部リンクを開きますか?Open external link?
responseExternalLinkWarningResponse外部サイトに移動しようとしています。You're about to visit an external website.
responseOpenLinkResponseリンクを開くOpen link
k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。