Skip to content

Vizel API / core/src / VizelLocale

Interface: VizelLocale

Defined in: packages/core/src/i18n/types.ts:8

Locale definition for all Vizel UI strings.

Provide a custom locale object to translate the editor interface. All properties are required — use createVizelLocale() to merge partial translations with the default English locale.

Properties

blockMenu

ts
blockMenu: object;

Defined in: packages/core/src/i18n/types.ts:49

Block context menu

copy

ts
copy: string;

cut

ts
cut: string;

delete

ts
delete: string;

duplicate

ts
duplicate: string;

label

ts
label: string;

Menu aria-label

turnInto

ts
turnInto: string;

bubbleMenu

ts
bubbleMenu: object;

Defined in: packages/core/src/i18n/types.ts:198

Bubble menu labels

ariaLabel

ts
ariaLabel: string;

Aria label for the bubble menu container

bold

ts
bold: string;

Tooltip for bold button

code

ts
code: string;

Tooltip for code button

italic

ts
italic: string;

Tooltip for italic button

ts
link: string;

Tooltip for link button

strikethrough

ts
strikethrough: string;

Tooltip for strikethrough button

subscript

ts
subscript: string;

Tooltip for subscript button

superscript

ts
superscript: string;

Tooltip for superscript button

underline

ts
underline: string;

Tooltip for underline button


codeBlock

ts
codeBlock: object;

Defined in: packages/core/src/i18n/types.ts:144

Code block UI

copied

ts
copied: string;

copyCode

ts
copyCode: string;

hideLineNumbers

ts
hideLineNumbers: string;

languagePlaceholder

ts
languagePlaceholder: string;

showLineNumbers

ts
showLineNumbers: string;

colorPicker

ts
colorPicker: object;

Defined in: packages/core/src/i18n/types.ts:220

Color picker labels used in bubble menu and standalone color picker

apply

ts
apply: string;

Apply button title

applyAriaLabel

ts
applyAriaLabel: string;

Apply button aria label

hexPlaceholder

ts
hexPlaceholder: string;

Hex input placeholder

highlight

ts
highlight: string;

Title for highlight button

highlightPalette

ts
highlightPalette: string;

Aria label for highlight palette

recent

ts
recent: string;

"Recent" colors section label

textColor

ts
textColor: string;

Title for text color button

textColorPalette

ts
textColorPalette: string;

Aria label for text color palette


commands

ts
commands: object;

Defined in: packages/core/src/i18n/types.ts:268

Strings for the block operation VizelCommand registry.

Each entry carries a title (used by the block menu and slash menu) and a description (used by the slash menu's secondary line).

block

ts
block: object;
block.demote
ts
demote: SlashItemText;
block.duplicate
ts
duplicate: SlashItemText;
block.mergePrevious
ts
mergePrevious: SlashItemText;
block.moveDown
ts
moveDown: SlashItemText;
block.moveUp
ts
moveUp: SlashItemText;
block.promote
ts
promote: SlashItemText;
block.split
ts
split: SlashItemText;

dragHandle

ts
dragHandle: object;

Defined in: packages/core/src/i18n/types.ts:153

Drag handle

ariaLabel

ts
ariaLabel: string;

findReplace

ts
findReplace: object;

Defined in: packages/core/src/i18n/types.ts:122

Find and replace panel

caseSensitive

ts
caseSensitive: string;

closeAriaLabel

ts
closeAriaLabel: string;

closeTitle

ts
closeTitle: string;

findNextAriaLabel

ts
findNextAriaLabel: string;

findNextTitle

ts
findNextTitle: string;

findPlaceholder

ts
findPlaceholder: string;

findPreviousAriaLabel

ts
findPreviousAriaLabel: string;

findPreviousTitle

ts
findPreviousTitle: string;

findTextAriaLabel

ts
findTextAriaLabel: string;

label

ts
label: string;

Panel aria-label

noResults

ts
noResults: string;

replaceAllAriaLabel

ts
replaceAllAriaLabel: string;

replaceAllTitle

ts
replaceAllTitle: string;

replaceAriaLabel

ts
replaceAriaLabel: string;

replacePlaceholder

ts
replacePlaceholder: string;

replaceTextAriaLabel

ts
replaceTextAriaLabel: string;

replaceTitle

ts
replaceTitle: string;

linkEditor

ts
linkEditor: object;

Defined in: packages/core/src/i18n/types.ts:240

Link editor popup labels

apply

ts
apply: string;

Apply link button title

applyAriaLabel

ts
applyAriaLabel: string;

Apply link button aria label

embedAsRichContent

ts
embedAsRichContent: string;

Embed toggle label

openInNewTab

ts
openInNewTab: string;

Open in new tab label

ts
removeLink: string;

Remove link button title

removeLinkAriaLabel

ts
removeLinkAriaLabel: string;

Remove link button aria label

urlPlaceholder

ts
urlPlaceholder: string;

URL input placeholder

visit

ts
visit: string;

Visit link label

visitTitle

ts
visitTitle: string;

Visit link tooltip


mentionMenu

ts
mentionMenu: object;

Defined in: packages/core/src/i18n/types.ts:114

Mention autocomplete menu

ariaLabel

ts
ariaLabel: string;

Menu container aria-label

noResults

ts
noResults: string;

Message shown when no mention candidates match the query


nodeSelector

ts
nodeSelector: object;

Defined in: packages/core/src/i18n/types.ts:166

Node selector (block type dropdown)

blockTypes

ts
blockTypes: string;

Dropdown aria-label

changeBlockType

ts
changeBlockType: string;

Trigger button title

currentBlockType

ts
currentBlockType: string;

Template for trigger aria-label. Use {type} for the current type name.


nodeTypes

ts
nodeTypes: object;

Defined in: packages/core/src/i18n/types.ts:33

Node type selector labels

bulletList

ts
bulletList: string;

code

ts
code: string;

heading1

ts
heading1: string;

heading2

ts
heading2: string;

heading3

ts
heading3: string;

heading4

ts
heading4: string;

heading5

ts
heading5: string;

heading6

ts
heading6: string;

numberedList

ts
numberedList: string;

quote

ts
quote: string;

taskList

ts
taskList: string;

text

ts
text: string;

outline

ts
outline: object;

Defined in: packages/core/src/i18n/types.ts:176

Outline (document heading navigation)

ariaLabel

ts
ariaLabel: string;

Aria label for the outline tree container


relativeTime

ts
relativeTime: object;

Defined in: packages/core/src/i18n/types.ts:185

Relative time strings. Use {n} as placeholder for the numeric value.

daysAgo

ts
daysAgo: string;

e.g. "{n}d ago"

hoursAgo

ts
hoursAgo: string;

e.g. "{n}h ago"

justNow

ts
justNow: string;

minutesAgo

ts
minutesAgo: string;

e.g. "{n}m ago"

secondsAgo

ts
secondsAgo: string;

e.g. "{n}s ago"


saveIndicator

ts
saveIndicator: object;

Defined in: packages/core/src/i18n/types.ts:158

Save indicator

error

ts
error: string;

saved

ts
saved: string;

saving

ts
saving: string;

unsaved

ts
unsaved: string;

slashMenu

ts
slashMenu: object;

Defined in: packages/core/src/i18n/types.ts:60

Slash command menu

enterEmbedUrl

ts
enterEmbedUrl: string;

Prompt for embed URL input

enterImageUrl

ts
enterImageUrl: string;

Prompt for image URL input

enterUrl

ts
enterUrl: string;

Prompt for generic URL input

groups

ts
groups: object;

Group labels.

The six built-in groups are required so the bundled commands always have a label. Additional string keys are accepted to label user-defined groups.

Index Signature
ts
[customGroupName: string]: string
groups.advanced
ts
advanced: string;
groups.blocks
ts
blocks: string;
groups.lists
ts
lists: string;
groups.media
ts
media: string;
groups.navigation
ts
navigation: string;
groups.text
ts
text: string;

items

ts
items: object;

Item titles and descriptions

items.bulletList
ts
bulletList: SlashItemText;
items.callout
ts
callout: SlashItemText;
items.codeBlock
ts
codeBlock: SlashItemText;
items.details
ts
details: SlashItemText;
items.divider
ts
divider: SlashItemText;
items.embed
ts
embed: SlashItemText;
items.graphvizDiagram
ts
graphvizDiagram: SlashItemText;
items.heading1
ts
heading1: SlashItemText;
items.heading2
ts
heading2: SlashItemText;
items.heading3
ts
heading3: SlashItemText;
items.heading4
ts
heading4: SlashItemText;
items.heading5
ts
heading5: SlashItemText;
items.heading6
ts
heading6: SlashItemText;
items.image
ts
image: SlashItemText;
items.inlineMath
ts
inlineMath: SlashItemText;
items.mathEquation
ts
mathEquation: SlashItemText;
items.mermaidDiagram
ts
mermaidDiagram: SlashItemText;
items.numberedList
ts
numberedList: SlashItemText;
items.quote
ts
quote: SlashItemText;
items.table
ts
table: SlashItemText;
items.tableOfContents
ts
tableOfContents: SlashItemText;
items.taskList
ts
taskList: SlashItemText;
items.uploadImage
ts
uploadImage: SlashItemText;

noResults

ts
noResults: string;

No results message


toolbar

ts
toolbar: object;

Defined in: packages/core/src/i18n/types.ts:10

Toolbar button labels

ariaLabel

ts
ariaLabel: string;

Aria label for the toolbar container

bold

ts
bold: string;

bulletList

ts
bulletList: string;

code

ts
code: string;

codeBlock

ts
codeBlock: string;

heading1

ts
heading1: string;

heading2

ts
heading2: string;

heading3

ts
heading3: string;

horizontalRule

ts
horizontalRule: string;

italic

ts
italic: string;

moreActions

ts
moreActions: string;

numberedList

ts
numberedList: string;

quote

ts
quote: string;

redo

ts
redo: string;

strikethrough

ts
strikethrough: string;

taskList

ts
taskList: string;

underline

ts
underline: string;

undo

ts
undo: string;

Released under the MIT License.