Skip to content

开源白板工具(SaaS),一体化白板,包含思维导图、流程图、自由画等。All in one open-source whiteboard tool with mind, flowchart, freehand and etc.

feat(i18n): added i18n tool for multi-Language support (#232)

vishwak80a65ac46969
diff --git a/apps/web-e2e/playwright.config.ts b/apps/web-e2e/playwright.config.ts
index 51e1060..62213de 100644
--- a/apps/web-e2e/playwright.config.ts
+++ b/apps/web-e2e/playwright.config.ts
@@ -64,6 +64,6 @@ export default defineConfig({
{
name: 'Google Chrome',
use: { ...devices['Desktop Chrome'], channel: 'chrome' },
- } */
+ }, */
],
-});
+});
\ No newline at end of file
diff --git a/apps/web/index.html b/apps/web/index.html
index 21e9bf4..eb00136 100644
--- a/apps/web/index.html
+++ b/apps/web/index.html
@@ -36,32 +36,25 @@
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"name": "Drawnix",
+ "alternateName": ["开源白板工具", "Open Source Whiteboard Tool"],
"description": {
- "@language": "zh-CN",
- "@value": "开源白板工具,包含思维导图、流程图等功能。基于 Plait 框架开发,支持插件扩展机制。"
+ "zh-CN": "Drawnix 是一款强大的开源白板工具,集成思维导图、流程图等功能。基于 Plait 框架开发,支持插件扩展,提供自动保存、无限画布等特性。",
+ "en": "Drawnix is a powerful open-source whiteboard tool featuring mind mapping and flowchart capabilities. Built on the Plait framework, it offers plugin extensibility, auto-save, infinite canvas, and more."
},
- "alternateName": {
- "@language": "en",
- "@value": "Open Source Whiteboard Tool with Mind Mapping and Flowchart capabilities"
- },
- "applicationCategory": "BusinessApplication",
- "operatingSystem": "Web",
+ "url": "https://drawnix.com",
+ "applicationCategory": "DesignApplication",
+ "operatingSystem": "Any",
"offers": {
"@type": "Offer",
"price": "0",
"priceCurrency": "USD"
},
- "featureList": [
- {
- "@language": "zh-CN",
- "@value": ["思维导图", "流程图", "插件机制", "自动保存", "无限画布", "多种格式导出"]
- },
- {
- "@language": "en",
- "@value": ["Mind Mapping", "Flowchart", "Plugin System", "Auto Save", "Infinite Canvas", "Multiple Export Formats"]
- }
- ],
- "softwareVersion": "0.1",
+ "creator": {
+ "@type": "Organization",
+ "name": "Drawnix Team"
+ },
+ "keywords": ["whiteboard", "mind mapping", "flowchart", "open source", "思维导图", "流程图", "白板"],
+ "inLanguage": ["zh-CN", "en"],
"license": "https://github.com/plait-board/drawnix/blob/master/LICENSE"
}
</script>
@@ -75,4 +68,4 @@
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
-</html>
+</html>
\ No newline at end of file
diff --git a/apps/web/src/app/app.tsx b/apps/web/src/app/app.tsx
index 662bc74..d36b715 100644
--- a/apps/web/src/app/app.tsx
+++ b/apps/web/src/app/app.tsx
@@ -48,6 +48,7 @@ export function App() {
theme={value.theme}
onChange={(value) => {
localforage.setItem(MAIN_BOARD_CONTENT_KEY, value);
+ setValue(value);
}}
afterInit={(board) => {
console.log('board initialized');
diff --git a/packages/drawnix/src/components/toolbar/app-toolbar/app-menu-items.tsx b/packages/drawnix/src/components/toolbar/app-toolbar/app-menu-items.tsx
index ccdcb6e..213bb8b 100644
--- a/packages/drawnix/src/components/toolbar/app-toolbar/app-menu-items.tsx
+++ b/packages/drawnix/src/components/toolbar/app-toolbar/app-menu-items.tsx
@@ -19,6 +19,7 @@ import MenuItem from '../../menu/menu-item';
import MenuItemLink from '../../menu/menu-item-link';
import { saveAsImage } from '../../../utils/image';
import { useDrawnix } from '../../../hooks/use-drawnix';
+import { useI18n } from '../../../i18n';
import Menu from '../../menu/menu';
import { useContext } from 'react';
import { MenuContentPropsContext } from '../../menu/common';
@@ -26,6 +27,7 @@ import { EVENT } from '../../../constants';
export const SaveToFile = () => {
const board = useBoard();
+ const { t } = useI18n();
return (
<MenuItem
data-testid="save-button"
@@ -33,9 +35,9 @@ export const SaveToFile = () => {
saveAsJSON(board);
}}
icon={SaveFileIcon}
- aria-label={`${`保存文件`}`}
+ aria-label={t('menu.saveFile')}
shortcut={`Cmd+S`}
- >{`保存文件`}</MenuItem>
+ >{t('menu.saveFile')}</MenuItem>
);
};
SaveToFile.displayName = 'SaveToFile';
@@ -43,6 +45,7 @@ SaveToFile.displayName = 'SaveToFile';
export const OpenFile = () => {
const board = useBoard();
const listRender = useListRender();
+ const { t } = useI18n();
const clearAndLoad = (
value: PlaitElement[],
viewport?: Viewport,
@@ -67,8 +70,8 @@ export const OpenFile = () => {
});
}}
icon={OpenFileIcon}
- aria-label={`${`打开`}`}
- >{`打开`}</MenuItem>
+ aria-label={t('menu.open')}
+ >{t('menu.open')}</MenuItem>
);
};
OpenFile.displayName = 'OpenFile';
@@ -76,6 +79,7 @@ OpenFile.displayName = 'OpenFile';
export const SaveAsImage = () => {
const board = useBoard();
const menuContentProps = useContext(MenuContentPropsContext);
+ const { t } = useI18n();
return (
<MenuItem
icon={ExportImageIcon}
@@ -95,24 +99,24 @@ export const SaveAsImage = () => {
onSelect={() => {
saveAsImage(board, true);
}}
- aria-label={'透明背景'}
+ aria-label={t('menu.exportImage.png')}
>
- PNG
+ {t('menu.exportImage.png')}
</MenuItem>
<MenuItem
onSelect={() => {
saveAsImage(board, false);
}}
- aria-label={'白色背景'}
+ aria-label={t('menu.exportImage.jpg')}
>
- JPG
+ {t('menu.exportImage.jpg')}
</MenuItem>
</Menu>
}
shortcut={`Cmd+Shift+E`}
- aria-label={''}
+ aria-label={t('menu.exportImage')}
>
- {'导出图片'}
+ {t('menu.exportImage')}
</MenuItem>
);
};
@@ -120,6 +124,7 @@ SaveAsImage.displayName = 'SaveAsImage';
export const CleanBoard = () => {
const { appState, setAppState } = useDrawnix();
+ const { t } = useI18n();
return (
<MenuItem
icon={TrashIcon}
@@ -131,9 +136,9 @@ export const CleanBoard = () => {
});
}}
shortcut={`Cmd+Backspace`}
- aria-label={'清除画布'}
+ aria-label={t('menu.cleanBoard')}
>
- {'清除画布'}
+ {t('menu.cleanBoard')}
</MenuItem>
);
};
diff --git a/packages/drawnix/src/components/toolbar/app-toolbar/app-toolbar.tsx b/packages/drawnix/src/components/toolbar/app-toolbar/app-toolbar.tsx
index 61e875e..b9a7a2b 100644
--- a/packages/drawnix/src/components/toolbar/app-toolbar/app-toolbar.tsx
+++ b/packages/drawnix/src/components/toolbar/app-toolbar/app-toolbar.tsx
@@ -20,11 +20,14 @@ import { Island } from '../../island';
import { Popover, PopoverContent, PopoverTrigger } from '../../popover/popover';
import { useState } from 'react';
import { CleanBoard, OpenFile, SaveAsImage, SaveToFile, Socials } from './app-menu-items';
+import { LanguageSwitcherMenu } from './language-switcher-menu';
import Menu from '../../menu/menu';
import MenuSeparator from '../../menu/menu-separator';
+import { useI18n } from '../../../i18n';
export const AppToolbar = () => {
const board = useBoard();
+ const { t } = useI18n();
const container = PlaitBoard.getBoardContainer(board);
const selectedElements = getSelectedElements(board);
const [appMenuOpen, setAppMenuOpen] = useState(false);
@@ -51,8 +54,8 @@ export const AppToolbar = () => {
visible={true}
selected={appMenuOpen}
icon={MenuIcon}
- title={`App Menu`}
- aria-label={`App Menu`}
+ title={t('general.menu')}
+ aria-label={t('general.menu')}
onPointerDown={() => {
setAppMenuOpen(!appMenuOpen);
}}
@@ -69,6 +72,7 @@ export const AppToolbar = () => {
<SaveAsImage></SaveAsImage>
<CleanBoard></CleanBoard>
<MenuSeparator />
+ <LanguageSwitcherMenu />
<Socials />
</Menu>
</PopoverContent>
@@ -78,8 +82,8 @@ export const AppToolbar = () => {
type="icon"
icon={UndoIcon}
visible={true}
- title={`Undo`}
- aria-label={`Undo`}
+ title={t('general.undo')}
+ aria-label={t('general.undo')}
onPointerUp={() => {
board.undo();
}}
@@ -90,8 +94,8 @@ export const AppToolbar = () => {
type="icon"
icon={RedoIcon}
visible={true}
- title={`Redo`}
- aria-label={`Redo`}
+ title={t('general.redo')}
+ aria-label={t('general.redo')}
onPointerUp={() => {
board.redo();
}}
@@ -104,8 +108,8 @@ export const AppToolbar = () => {
type="icon"
icon={DuplicateIcon}
visible={true}
- title={`Duplicate`}
- aria-label={`Duplicate`}
+ title={t('general.duplicate')}
+ aria-label={t('general.duplicate')}
onPointerUp={() => {
duplicateElements(board);
}}
@@ -118,8 +122,8 @@ export const AppToolbar = () => {
type="icon"
icon={TrashIcon}
visible={true}
- title={`Trash`}
- aria-label={`Trash`}
+ title={t('general.delete')}
+ aria-label={t('general.delete')}
onPointerUp={() => {
deleteFragment(board);
}}
diff --git a/packages/drawnix/src/components/toolbar/app-toolbar/language-switcher-menu.tsx b/packages/drawnix/src/components/toolbar/app-toolbar/language-switcher-menu.tsx
new file mode 100644
index 0000000..6358a3f
--- /dev/null
+++ b/packages/drawnix/src/components/toolbar/app-toolbar/language-switcher-menu.tsx
@@ -0,0 +1,55 @@
+import { useContext } from 'react';
+import { MenuIcon } from '../../icons';
+import { useI18n } from '../../../i18n';
+import Menu from '../../menu/menu';
+import MenuItem from '../../menu/menu-item';
+import { MenuContentPropsContext } from '../../menu/common';
+import { EVENT } from '../../../constants';
+
+export const LanguageSwitcherMenu = () => {
+ const { language, setLanguage, t } = useI18n();
+ const menuContentProps = useContext(MenuContentPropsContext);
+
+ return (
+ <MenuItem
+ icon={MenuIcon}
+ data-testid="language-switcher-button"
+ onSelect={() => {
+ // This will be handled by the submenu
+ }}
+ submenu={
+ <Menu onSelect={() => {
+ const itemSelectEvent = new CustomEvent(EVENT.MENU_ITEM_SELECT, {
+ bubbles: true,
+ cancelable: true,
+ });
+ menuContentProps.onSelect?.(itemSelectEvent);
+ }}>
+ <MenuItem
+ onSelect={() => {
+ setLanguage('zh');
+ }}
+ aria-label={t('language.chinese')}
+ selected={language === 'zh'}
+ >
+ {t('language.chinese')}
+ </MenuItem>
+ <MenuItem
+ onSelect={() => {
+ setLanguage('en');
+ }}
+ aria-label={t('language.english')}
+ selected={language === 'en'}
+ >
+ {t('language.english')}
+ </MenuItem>
+ </Menu>
+ }
+ aria-label={t('language.switcher')}
+ >
+ {t('language.switcher')}
+ </MenuItem>
+ );
+};
+
+LanguageSwitcherMenu.displayName = 'LanguageSwitcherMenu';
\ No newline at end of file
diff --git a/packages/drawnix/src/components/toolbar/creation-toolbar.tsx b/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
index 334c05b..c78d7a7 100644
--- a/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
+++ b/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
@@ -40,6 +40,7 @@ import {
} from '../../hooks/use-drawnix';
import { ExtraToolsButton } from './extra-tools/extra-tools-button';
import { addImage } from '../../utils/image';
+import { useI18n } from '../../i18n';
export enum PopupKey {
'shape' = 'shape',
@@ -47,7 +48,7 @@ export enum PopupKey {
}
type AppToolButtonProps = {
- title?: string;
+ titleKey?: keyof typeof import('../../i18n').Translations;
name?: string;
icon: React.ReactNode;
pointer?: DrawnixPointerType;
@@ -64,48 +65,48 @@ export const BUTTONS: AppToolButtonProps[] = [
{
icon: HandIcon,
pointer: PlaitPointerType.hand,
- title: 'Hand — H',
+ titleKey: 'toolbar.hand',
},
{
icon: SelectionIcon,
pointer: PlaitPointerType.selection,
- title: 'Selection — V',
+ titleKey: 'toolbar.selection',
},
{
icon: MindIcon,
pointer: MindPointerType.mind,
- title: 'Mind — M',
+ titleKey: 'toolbar.mind',
},
{
icon: TextIcon,
pointer: BasicShapes.text,
- title: 'Text — T',
+ titleKey: 'toolbar.text',
},
{
icon: FeltTipPenIcon,
pointer: FreehandShape.feltTipPen,
- title: 'Pen — P',
+ titleKey: 'toolbar.pen',
},
{
icon: StraightArrowLineIcon,
- title: 'Arrow — A',
+ titleKey: 'toolbar.arrow',
key: PopupKey.arrow,
pointer: ArrowLineShape.straight,
},
{
icon: ShapeIcon,
- title: 'Shape',
+ titleKey: 'toolbar.shape',
key: PopupKey.shape,
pointer: BasicShapes.rectangle,
},
{
icon: ImageIcon,
- title: 'Image — Cmd+U',
+ titleKey: 'toolbar.image',
key: 'image',
},
{
icon: ExtraToolsIcon,
- title: 'More Tools',
+ titleKey: 'toolbar.extraTools',
key: 'extra-tools',
},
];
@@ -125,6 +126,7 @@ export const isShapePointer = (board: PlaitBoard) => {
export const CreationToolbar = () => {
const board = useBoard();
const { appState } = useDrawnix();
+ const { t } = useI18n();
const setPointer = useSetPointer();
const container = PlaitBoard.getBoardContainer(board);
@@ -178,8 +180,8 @@ export const CreationToolbar = () => {
!PlaitBoard.isPointer(board, BasicShapes.text))
}
icon={button.icon}
- title={`Shape`}
- aria-label={`Shape`}
+ title={button.titleKey ? t(button.titleKey) : 'Shape'}
+ aria-label={button.titleKey ? t(button.titleKey) : 'Shape'}
onPointerDown={() => {
setShapeOpen(!shapeOpen);
}}
@@ -212,8 +214,8 @@ export const CreationToolbar = () => {
visible={true}
selected={arrowOpen || isArrowLinePointer(board)}
icon={button.icon}
- title={button.title!}
- aria-label={button.title!}
+ title={button.titleKey ? t(button.titleKey) : ''}
+ aria-label={button.titleKey ? t(button.titleKey) : ''}
onPointerDown={() => {
setArrowOpen(!shapeOpen);
}}
@@ -239,8 +241,8 @@ export const CreationToolbar = () => {
type="radio"
icon={button.icon}
checked={isChecked(button)}
- title={`${button.title}`}
- aria-label={`${button.title}`}
+ title={button.titleKey ? t(button.titleKey) : ''}
+ aria-label={button.titleKey ? t(button.titleKey) : ''}
onPointerDown={() => {
if (button.pointer && !isBasicPointer(button.pointer)) {
onPointerDown(button.pointer);
diff --git a/packages/drawnix/src/components/toolbar/extra-tools/extra-tools-button.tsx b/packages/drawnix/src/components/toolbar/extra-tools/extra-tools-button.tsx
index ae7cf2b..3e58b64 100644
--- a/packages/drawnix/src/components/toolbar/extra-tools/extra-tools-button.tsx
+++ b/packages/drawnix/src/components/toolbar/extra-tools/extra-tools-button.tsx
@@ -6,9 +6,11 @@ import { ToolButton } from "../../tool-button";
import { ExtraToolsIcon } from "../../icons";
import Menu from "../../menu/menu";
import { MarkdownToDrawnixItem, MermaidToDrawnixItem } from "./menu-items";
+import { useI18n } from "../../../i18n";
export const ExtraToolsButton = () => {
const board = useBoard();
+ const { t } = useI18n();
const container = PlaitBoard.getBoardContainer(board);
const [appMenuOpen, setAppMenuOpen] = useState(false);
return (
@@ -27,8 +29,8 @@ export const ExtraToolsButton = () => {
visible={true}
selected={appMenuOpen}
icon={ExtraToolsIcon}
- title={`Extra Tools`}
- aria-label={`Extra Tools`}
+ title={t('toolbar.extraTools')}
+ aria-label={t('toolbar.extraTools')}
onPointerDown={() => {
setAppMenuOpen(!appMenuOpen);
}}
diff --git a/packages/drawnix/src/components/toolbar/extra-tools/menu-items.tsx b/packages/drawnix/src/components/toolbar/extra-tools/menu-items.tsx
index 25dec74..337fdec 100644
--- a/packages/drawnix/src/components/toolbar/extra-tools/menu-items.tsx
+++ b/packages/drawnix/src/components/toolbar/extra-tools/menu-items.tsx
@@ -1,9 +1,11 @@
import MenuItem from '../../menu/menu-item';
import { MarkdownLogoIcon, MermaidLogoIcon } from '../../icons';
import { DialogType, useDrawnix } from '../../../hooks/use-drawnix';
+import { useI18n } from '../../../i18n';
export const MermaidToDrawnixItem = () => {
const { appState, setAppState } = useDrawnix();
+ const { t } = useI18n();
return (
<MenuItem
data-testid="marmaid-to-drawnix-button"
@@ -14,8 +16,10 @@ export const MermaidToDrawnixItem = () => {
});
}}
icon={MermaidLogoIcon}
- aria-label={`${`Mermaid 到 Drawnix`}`}
- >{`Mermaid 到 Drawnix`}</MenuItem>
+ aria-label={t('extraTools.mermaidToDrawnix')}
+ >
+ {t('extraTools.mermaidToDrawnix')}
+ </MenuItem>
);
};
@@ -23,6 +27,7 @@ MermaidToDrawnixItem.displayName = 'MermaidToDrawnix';
export const MarkdownToDrawnixItem = () => {
const { appState, setAppState } = useDrawnix();
+ const { t } = useI18n();
return (
<MenuItem
data-testid="markdown-to-drawnix-button"
@@ -33,9 +38,11 @@ export const MarkdownToDrawnixItem = () => {
});
}}
icon={MarkdownLogoIcon}
- aria-label={`${`Markdown 到 Drawnix`}`}
- >{`Markdown 到 Drawnix`}</MenuItem>
+ aria-label={t('extraTools.markdownToDrawnix')}
+ >
+ {t('extraTools.markdownToDrawnix')}
+ </MenuItem>
);
};
-MermaidToDrawnixItem.displayName = 'MarkdownToDrawnix';
+MarkdownToDrawnixItem.displayName = 'MarkdownToDrawnix';
diff --git a/packages/drawnix/src/components/toolbar/theme-toolbar.tsx b/packages/drawnix/src/components/toolbar/theme-toolbar.tsx
index 5389d32..1adef44 100644
--- a/packages/drawnix/src/components/toolbar/theme-toolbar.tsx
+++ b/packages/drawnix/src/components/toolbar/theme-toolbar.tsx
@@ -6,9 +6,11 @@ import {
ThemeColorMode,
} from '@plait/core';
import { Island } from '../island';
+import { useI18n } from '../../i18n';
export const ThemeToolbar = () => {
const board = useBoard();
+ const { t } = useI18n();
const theme = board.theme;
return (
<Island
@@ -22,12 +24,12 @@ export const ThemeToolbar = () => {
}}
value={theme.themeColorMode}
>
- <option value="default">默认</option>
- <option value="colorful">缤纷</option>
- <option value="soft">柔和</option>
- <option value="retro">复古</option>
- <option value="dark">暗夜</option>
- <option value="starry">星空</option>
+ <option value="default">{t('theme.default')}</option>
+ <option value="colorful">{t('theme.colorful')}</option>
+ <option value="soft">{t('theme.soft')}</option>
+ <option value="retro">{t('theme.retro')}</option>
+ <option value="dark">{t('theme.dark')}</option>
+ <option value="starry">{t('theme.starry')}</option>
</select>
</Island>
);
diff --git a/packages/drawnix/src/components/toolbar/zoom-toolbar.tsx b/packages/drawnix/src/components/toolbar/zoom-toolbar.tsx
index 09cf0ac..612ed23 100644
--- a/packages/drawnix/src/components/toolbar/zoom-toolbar.tsx
+++ b/packages/drawnix/src/components/toolbar/zoom-toolbar.tsx
@@ -13,9 +13,11 @@ import { Popover, PopoverContent, PopoverTrigger } from '../popover/popover';
import { useState } from 'react';
import Menu from '../menu/menu';
import MenuItem from '../menu/menu-item';
+import { useI18n } from '../../i18n';
export const ZoomToolbar = () => {
const board = useBoard();
+ const { t } = useI18n();
const container = PlaitBoard.getBoardContainer(board);
const [zoomMenuOpen, setZoomMenuOpen] = useState(false);
return (
@@ -29,8 +31,8 @@ export const ZoomToolbar = () => {
type="button"
icon={ZoomOutIcon}
visible={true}
- title={`缩小 — Cmd+-`}
- aria-label={`缩小 — Cmd+-`}
+ title={t('zoom.out')}
+ aria-label={t('zoom.out')}
onPointerUp={() => {
BoardTransforms.updateZoom(board, board.viewport.zoom - 0.1);
}}
@@ -47,8 +49,8 @@ export const ZoomToolbar = () => {
<PopoverTrigger asChild>
<div
key={1}
- title={`自适应`}
- aria-label={`自适应`}
+ title={t('zoom.fit')}
+ aria-label={t('zoom.fit')}
className={classNames('zoom-menu-trigger', {
active: zoomMenuOpen,
})}
@@ -70,17 +72,17 @@ export const ZoomToolbar = () => {
onSelect={() => {
BoardTransforms.fitViewport(board);
}}
- aria-label={`${`自适应缩放`}`}
+ aria-label={t('zoom.fit')}
shortcut={`Cmd+Shift+=`}
- >{`自适应缩放`}</MenuItem>
+ >{t('zoom.fit')}</MenuItem>
<MenuItem
data-testid="open-button"
onSelect={() => {
BoardTransforms.updateZoom(board, 1);
}}
- aria-label={`${`缩放至 100%`}`}
+ aria-label={t('zoom.100')}
shortcut={`Cmd+0`}
- >{`缩放至 100%`}</MenuItem>
+ >{t('zoom.100')}</MenuItem>
</Menu>
</PopoverContent>
</Popover>
@@ -89,8 +91,8 @@ export const ZoomToolbar = () => {
type="button"
icon={ZoomInIcon}
visible={true}
- title={`放大 — Cmd++`}
- aria-label={`放大 — Cmd++`}
+ title={t('zoom.in')}
+ aria-label={t('zoom.in')}
onPointerUp={() => {
BoardTransforms.updateZoom(board, board.viewport.zoom + 0.1);
}}
diff --git a/packages/drawnix/src/components/ttd-dialog/markdown-to-drawnix.tsx b/packages/drawnix/src/components/ttd-dialog/markdown-to-drawnix.tsx
index 96caec4..4025107 100644
--- a/packages/drawnix/src/components/ttd-dialog/markdown-to-drawnix.tsx
+++ b/packages/drawnix/src/components/ttd-dialog/markdown-to-drawnix.tsx
@@ -7,6 +7,7 @@ import { TTDDialogInput } from './ttd-dialog-input';
import { TTDDialogOutput } from './ttd-dialog-output';
import { TTDDialogSubmitShortcut } from './ttd-dialog-submit-shortcut';
import { useDrawnix } from '../../hooks/use-drawnix';
+import { useI18n } from '../../i18n';
import { useBoard } from '@plait-board/react-board';
import {
getViewportOrigination,
@@ -26,7 +27,9 @@ export interface MarkdownToDrawnixLibProps {
}>;
}
-const MARKDOWN_EXAMPLE = `# 我开始了
+const getMarkdownExample = (language: 'zh' | 'en') => {
+ if (language === 'zh') {
+ return `# 我开始了
- 让我看看是谁搞出了这个 bug 🕵️ ♂️ 🔍
- 😯 💣
@@ -45,9 +48,33 @@ const MARKDOWN_EXAMPLE = `# 我开始了
### Hello world 👋 🌍 ✨ 💻
#### 哇 是个程序员 🤯 ⌨️ 💡 👩 💻`;
+ } else {
+ return `# I have started
+
+- Let me see who made this bug 🕵️ ♂️ 🔍
+ - 😯 💣
+ - Turns out it was me 👈 🎯 💘
+
+- Unexpectedly, it cannot run; why is that 🚫 ⚙️ ❓
+ - Unexpectedly, it can run now; why is that? 🎢 ✨
+ - 🤯 ⚡ ➡️ 🎉
+
+- What can run 🐞 🚀
+ - then do not touch it 🛑 ✋
+ - 👾 💥 🏹 🎯
+
+## Boy or girl 👶 ❓ 🤷 ♂️ ♀️
+
+### Hello world 👋 🌍 ✨ 💻
+
+#### Wow, a programmer 🤯 ⌨️ 💡 👩 💻`;
+ }
+};
+
const MarkdownToDrawnix = () => {
const { appState, setAppState } = useDrawnix();
+ const { t, language } = useI18n();
const [markdownToDrawnixLib, setMarkdownToDrawnixLib] =
useState<MarkdownToDrawnixLibProps>({
loaded: false,
@@ -67,17 +94,22 @@ const MarkdownToDrawnix = () => {
});
} catch (err) {
console.error('Failed to load mermaid library:', err);
- setError(new Error('加载 Mermaid 库失败'));
+ setError(new Error(t('dialog.error.loadMermaid')));
}
};
loadLib();
}, []);
- const [text, setText] = useState(() => MARKDOWN_EXAMPLE);
+ const [text, setText] = useState(() => getMarkdownExample(language));
const [value, setValue] = useState<PlaitElement[]>(() => []);
const deferredText = useDeferredValue(text.trim());
const [error, setError] = useState<Error | null>(null);
const board = useBoard();
+ // Update markdown example when language changes
+ useEffect(() => {
+ setText(getMarkdownExample(language));
+ }, [language]);
+
useEffect(() => {
const convertMarkdown = async () => {
try {
@@ -129,24 +161,28 @@ const MarkdownToDrawnix = () => {
};
return (
- <TTDDialogPanels>
- <TTDDialogPanel label={'Markdown 语法'}>
+ <>
+ <div className="ttd-dialog-desc">
+ {t('dialog.markdown.description')}
+ </div>
+ <TTDDialogPanels>
+ <TTDDialogPanel label={t('dialog.markdown.syntax')}>
<TTDDialogInput
input={text}
- placeholder={'在此处编写 Markdown 文本定义...'}
+ placeholder={t('dialog.markdown.placeholder')}
onChange={(event) => setText(event.target.value)}
onKeyboardSubmit={() => {
- // insertToBoard();
+ insertToBoard();
}}
/>
</TTDDialogPanel>
<TTDDialogPanel
- label={'预览'}
+ label={t('dialog.markdown.preview')}
panelAction={{
action: () => {
insertToBoard();
},
- label: '插入',
+ label: t('dialog.markdown.insert'),
}}
renderSubmitShortcut={() => <TTDDialogSubmitShortcut />}
>
@@ -157,6 +193,7 @@ const MarkdownToDrawnix = () => {
/>
</TTDDialogPanel>
</TTDDialogPanels>
+ </>
);
};
export default MarkdownToDrawnix;
diff --git a/packages/drawnix/src/components/ttd-dialog/mermaid-to-drawnix.tsx b/packages/drawnix/src/components/ttd-dialog/mermaid-to-drawnix.tsx
index 0218124..b114bb5 100644
--- a/packages/drawnix/src/components/ttd-dialog/mermaid-to-drawnix.tsx
+++ b/packages/drawnix/src/components/ttd-dialog/mermaid-to-drawnix.tsx
@@ -7,6 +7,7 @@ import { TTDDialogInput } from './ttd-dialog-input';
import { TTDDialogOutput } from './ttd-dialog-output';
import { TTDDialogSubmitShortcut } from './ttd-dialog-submit-shortcut';
import { useDrawnix } from '../../hooks/use-drawnix';
+import { useI18n } from '../../i18n';
import { useBoard } from '@plait-board/react-board';
import {
getViewportOrigination,
@@ -35,6 +36,7 @@ const MERMAID_EXAMPLE =
const MermaidToDrawnix = () => {
const { appState, setAppState } = useDrawnix();
+ const { t, language } = useI18n();
const [mermaidToDrawnixLib, setMermaidToDrawnixLib] =
useState<MermaidToDrawnixLibProps>({
loaded: false,
@@ -53,7 +55,7 @@ const MermaidToDrawnix = () => {
});
} catch (err) {
console.error('Failed to load mermaid library:', err);
- setError(new Error('加载 Mermaid 库失败'));
+ setError(new Error(t('dialog.error.loadMermaid')));
}
};
loadLib();
@@ -125,37 +127,73 @@ const MermaidToDrawnix = () => {
return (
<>
<div className="ttd-dialog-desc">
- 目前仅支持
- <a
- href="https://mermaid.js.org/syntax/flowchart.html"
- target="_blank"
- rel="noreferrer"
- >
- 流程图
- </a>
- 、
- <a
- href="https://mermaid.js.org/syntax/sequenceDiagram.html"
- target="_blank"
- rel="noreferrer"
- >
- 序列图
- </a>
- 和
- <a
- href="https://mermaid.js.org/syntax/classDiagram.html"
- target="_blank"
- rel="noreferrer"
- >
- 类图
- </a>
- 。其他类型在 Drawnix 中将以图片呈现。
+ {language === 'zh' ? (
+ <>
+ {t('dialog.mermaid.description')}
+ {' '}
+ <a
+ href="https://mermaid.js.org/syntax/flowchart.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.flowchart')}
+ </a>
+ 、
+ <a
+ href="https://mermaid.js.org/syntax/sequenceDiagram.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.sequence')}
+ </a>
+ {' '}
+ 和
+ {' '}
+ <a
+ href="https://mermaid.js.org/syntax/classDiagram.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.class')}
+ </a>
+ {t('dialog.mermaid.otherTypes')}
+ </>
+ ) : (
+ <>
+ {t('dialog.mermaid.description')}
+ {' '}
+ <a
+ href="https://mermaid.js.org/syntax/flowchart.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.flowchart')}
+ </a>
+ ,{' '}
+ <a
+ href="https://mermaid.js.org/syntax/sequenceDiagram.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.sequence')}
+ </a>
+ ,{' '}
+ <a
+ href="https://mermaid.js.org/syntax/classDiagram.html"
+ target="_blank"
+ rel="noreferrer"
+ >
+ {t('dialog.mermaid.class')}
+ </a>
+ {t('dialog.mermaid.otherTypes')}
+ </>
+ )}
</div>
<TTDDialogPanels>
- <TTDDialogPanel label={'Mermaid 语法'}>
+ <TTDDialogPanel label={t('dialog.mermaid.syntax')}>
<TTDDialogInput
input={text}
- placeholder={'在此处编写 Mermaid 图表定义...'}
+ placeholder={t('dialog.mermaid.placeholder')}
onChange={(event) => setText(event.target.value)}
onKeyboardSubmit={() => {
insertToBoard();
@@ -163,12 +201,12 @@ const MermaidToDrawnix = () => {
/>
</TTDDialogPanel>
<TTDDialogPanel
- label={'预览'}
+ label={t('dialog.mermaid.preview')}
panelAction={{
action: () => {
insertToBoard();
},
- label: '插入',
+ label: t('dialog.mermaid.insert'),
}}
renderSubmitShortcut={() => <TTDDialogSubmitShortcut />}
>
diff --git a/packages/drawnix/src/drawnix.tsx b/packages/drawnix/src/drawnix.tsx
index cee3447..5ce83a8 100644
--- a/packages/drawnix/src/drawnix.tsx
+++ b/packages/drawnix/src/drawnix.tsx
@@ -37,6 +37,7 @@ import { TTDDialog } from './components/ttd-dialog/ttd-dialog';
import { CleanConfirm } from './components/clean-confirm/clean-confirm';
import { buildTextLinkPlugin } from './plugins/with-text-link';
import { LinkPopup } from './components/popup/link-popup/link-popup';
+import { useI18n, I18nProvider } from './i18n';
export type DrawnixProps = {
value: PlaitElement[];
@@ -108,44 +109,46 @@ export const Drawnix: React.FC<DrawnixProps> = ({
const containerRef = useRef<HTMLDivElement>(null);
return (
- <DrawnixContext.Provider value={{ appState, setAppState }}>
- <div
- className={classNames('drawnix', {
- 'drawnix--mobile': appState.isMobile,
- })}
- ref={containerRef}
- >
- <Wrapper
- value={value}
- viewport={viewport}
- theme={theme}
- options={options}
- plugins={plugins}
- onChange={(data: BoardChangeData) => {
- onChange && onChange(data);
- }}
- onSelectionChange={onSelectionChange}
- onViewportChange={onViewportChange}
- onThemeChange={onThemeChange}
- onValueChange={onValueChange}
+ <I18nProvider>
+ <DrawnixContext.Provider value={{ appState, setAppState }}>
+ <div
+ className={classNames('drawnix', {
+ 'drawnix--mobile': appState.isMobile,
+ })}
+ ref={containerRef}
>
- <Board
- afterInit={(board) => {
- setBoard(board as DrawnixBoard);
- afterInit && afterInit(board);
+ <Wrapper
+ value={value}
+ viewport={viewport}
+ theme={theme}
+ options={options}
+ plugins={plugins}
+ onChange={(data: BoardChangeData) => {
+ onChange && onChange(data);
}}
- ></Board>
- <AppToolbar></AppToolbar>
- <CreationToolbar></CreationToolbar>
- <ZoomToolbar></ZoomToolbar>
- <ThemeToolbar></ThemeToolbar>
- <PopupToolbar></PopupToolbar>
- <LinkPopup></LinkPopup>
- <ClosePencilToolbar></ClosePencilToolbar>
- <TTDDialog container={containerRef.current}></TTDDialog>
- <CleanConfirm container={containerRef.current}></CleanConfirm>
- </Wrapper>
- </div>
- </DrawnixContext.Provider>
+ onSelectionChange={onSelectionChange}
+ onViewportChange={onViewportChange}
+ onThemeChange={onThemeChange}
+ onValueChange={onValueChange}
+ >
+ <Board
+ afterInit={(board) => {
+ setBoard(board as DrawnixBoard);
+ afterInit && afterInit(board);
+ }}
+ ></Board>
+ <AppToolbar></AppToolbar>
+ <CreationToolbar></CreationToolbar>
+ <ZoomToolbar></ZoomToolbar>
+ <ThemeToolbar></ThemeToolbar>
+ <PopupToolbar></PopupToolbar>
+ <LinkPopup></LinkPopup>
+ <ClosePencilToolbar></ClosePencilToolbar>
+ <TTDDialog container={containerRef.current}></TTDDialog>
+ <CleanConfirm container={containerRef.current}></CleanConfirm>
+ </Wrapper>
+ </div>
+ </DrawnixContext.Provider>
+ </I18nProvider>
);
};
diff --git a/packages/drawnix/src/i18n.tsx b/packages/drawnix/src/i18n.tsx
new file mode 100644
index 0000000..24a31aa
--- /dev/null
+++ b/packages/drawnix/src/i18n.tsx
@@ -0,0 +1,271 @@
+import React, { createContext, useContext, useState, ReactNode, useMemo } from 'react';
+
+// Define supported languages
+export type Language = 'zh' | 'en';
+
+// Define translation keys and their corresponding values
+export interface Translations {
+ // Toolbar items
+ 'toolbar.hand': string;
+ 'toolbar.selection': string;
+ 'toolbar.mind': string;
+ 'toolbar.text': string;
+ 'toolbar.pen': string;
+ 'toolbar.arrow': string;
+ 'toolbar.shape': string;
+ 'toolbar.image': string;
+ 'toolbar.extraTools': string;
+
+ // Zoom controls
+ 'zoom.in': string;
+ 'zoom.out': string;
+ 'zoom.fit': string;
+ 'zoom.100': string;
+
+ // Themes
+ 'theme.default': string;
+ 'theme.colorful': string;
+ 'theme.soft': string;
+ 'theme.retro': string;
+ 'theme.dark': string;
+ 'theme.starry': string;
+
+ // General
+ 'general.undo': string;
+ 'general.redo': string;
+ 'general.menu': string;
+ 'general.duplicate': string;
+ 'general.delete': string;
+
+ // Language
+ 'language.switcher': string;
+ 'language.chinese': string;
+ 'language.english': string;
+
+ // Menu items
+ 'menu.open': string;
+ 'menu.saveFile': string;
+ 'menu.exportImage': string;
+ 'menu.exportImage.png': string;
+ 'menu.exportImage.jpg': string;
+ 'menu.cleanBoard': string;
+ 'menu.github': string;
+
+ // Dialog translations
+ 'dialog.mermaid.title': string;
+ 'dialog.mermaid.description': string;
+ 'dialog.mermaid.flowchart': string;
+ 'dialog.mermaid.sequence': string;
+ 'dialog.mermaid.class': string;
+ 'dialog.mermaid.otherTypes': string;
+ 'dialog.mermaid.syntax': string;
+ 'dialog.mermaid.placeholder': string;
+ 'dialog.mermaid.preview': string;
+ 'dialog.mermaid.insert': string;
+ 'dialog.markdown.description': string;
+ 'dialog.markdown.syntax': string;
+ 'dialog.markdown.placeholder': string;
+ 'dialog.markdown.preview': string;
+ 'dialog.markdown.insert': string;
+ 'dialog.error.loadMermaid': string;
+
+ // Extra tools menu items
+ 'extraTools.mermaidToDrawnix': string;
+ 'extraTools.markdownToDrawnix': string;
+}
+
+// Translation data
+const translations: Record<Language, Translations> = {
+ zh: {
+ // Toolbar items
+ 'toolbar.hand': '手形工具 — H',
+ 'toolbar.selection': '选择 — V',
+ 'toolbar.mind': '思维导图 — M',
+ 'toolbar.text': '文本 — T',
+ 'toolbar.pen': '画笔 — P',
+ 'toolbar.arrow': '箭头 — A',
+ 'toolbar.shape': '形状',
+ 'toolbar.image': '图片 — Cmd+U',
+ 'toolbar.extraTools': '更多工具',
+
+ // Zoom controls
+ 'zoom.in': '放大 — Cmd++',
+ 'zoom.out': '缩小 — Cmd+-',
+ 'zoom.fit': '自适应',
+ 'zoom.100': '缩放至 100%',
+
+ // Themes
+ 'theme.default': '默认',
+ 'theme.colorful': '缤纷',
+ 'theme.soft': '柔和',
+ 'theme.retro': '复古',
+ 'theme.dark': '暗夜',
+ 'theme.starry': '星空',
+
+ // General
+ 'general.undo': '撤销',
+ 'general.redo': '重做',
+ 'general.menu': '应用菜单',
+ 'general.duplicate': '复制',
+ 'general.delete': '删除',
+
+ // Language
+ 'language.switcher': '语言',
+ 'language.chinese': '中文',
+ 'language.english': 'English',
+
+ // Menu items
+ 'menu.open': '打开',
+ 'menu.saveFile': '保存文件',
+ 'menu.exportImage': '导出图片',
+ 'menu.exportImage.png': 'PNG',
+ 'menu.exportImage.jpg': 'JPG',
+ 'menu.cleanBoard': '清除画布',
+ 'menu.github': 'GitHub',
+
+ // Dialog translations
+ 'dialog.mermaid.title': 'Mermaid 转 Drawnix',
+ 'dialog.mermaid.description': '目前仅支持',
+ 'dialog.mermaid.flowchart': '流程图',
+ 'dialog.mermaid.sequence': '序列图',
+ 'dialog.mermaid.class': '类图',
+ 'dialog.mermaid.otherTypes': '。其他类型在 Drawnix 中将以图片呈现。',
+ 'dialog.mermaid.syntax': 'Mermaid 语法',
+ 'dialog.mermaid.placeholder': '在此处编写 Mermaid 图表定义...',
+ 'dialog.mermaid.preview': '预览',
+ 'dialog.mermaid.insert': '插入',
+ 'dialog.markdown.description': '支持 Markdown 语法自动转换为思维导图。',
+ 'dialog.markdown.syntax': 'Markdown 语法',
+ 'dialog.markdown.placeholder': '在此处编写 Markdown 文本定义...',
+ 'dialog.markdown.preview': '预览',
+ 'dialog.markdown.insert': '插入',
+ 'dialog.error.loadMermaid': '加载 Mermaid 库失败',
+
+ // Extra tools menu items
+ 'extraTools.mermaidToDrawnix': 'Mermaid 到 Drawnix',
+ 'extraTools.markdownToDrawnix': 'Markdown 到 Drawnix',
+ },
+ en: {
+ // Toolbar items
+ 'toolbar.hand': 'Hand — H',
+ 'toolbar.selection': 'Selection — V',
+ 'toolbar.mind': 'Mind — M',
+ 'toolbar.text': 'Text — T',
+ 'toolbar.pen': 'Pen — P',
+ 'toolbar.arrow': 'Arrow — A',
+ 'toolbar.shape': 'Shape',
+ 'toolbar.image': 'Image — Cmd+U',
+ 'toolbar.extraTools': 'Extra Tools',
+
+ // Zoom controls
+ 'zoom.in': 'Zoom In — Cmd++',
+ 'zoom.out': 'Zoom Out — Cmd+-',
+ 'zoom.fit': 'Fit to Screen',
+ 'zoom.100': 'Zoom to 100%',
+
+ // Themes
+ 'theme.default': 'Default',
+ 'theme.colorful': 'Colorful',
+ 'theme.soft': 'Soft',
+ 'theme.retro': 'Retro',
+ 'theme.dark': 'Dark',
+ 'theme.starry': 'Starry',
+
+ // General
+ 'general.undo': 'Undo',
+ 'general.redo': 'Redo',
+ 'general.menu': 'App Menu',
+ 'general.duplicate': 'Duplicate',
+ 'general.delete': 'Delete',
+
+ // Language
+ 'language.switcher': 'Language',
+ 'language.chinese': '中文',
+ 'language.english': 'English',
+
+ // Menu items
+ 'menu.open': 'Open',
+ 'menu.saveFile': 'Save File',
+ 'menu.exportImage': 'Export Image',
+ 'menu.exportImage.png': 'PNG',
+ 'menu.exportImage.jpg': 'JPG',
+ 'menu.cleanBoard': 'Clear Board',
+ 'menu.github': 'GitHub',
+
+ // Dialog translations
+ 'dialog.mermaid.title': 'Mermaid to Drawnix',
+ 'dialog.mermaid.description': 'Currently supports',
+ 'dialog.mermaid.flowchart': 'flowcharts',
+ 'dialog.mermaid.sequence': 'sequence diagrams',
+ 'dialog.mermaid.class': 'class diagrams',
+ 'dialog.mermaid.otherTypes': ', and other diagram types (rendered as images).',
+ 'dialog.mermaid.syntax': 'Mermaid Syntax',
+ 'dialog.mermaid.placeholder': 'Write your Mermaid chart definition here...',
+ 'dialog.mermaid.preview': 'Preview',
+ 'dialog.mermaid.insert': 'Insert',
+ 'dialog.markdown.description': 'Supports automatic conversion of Markdown syntax to mind map.',
+ 'dialog.markdown.syntax': 'Markdown Syntax',
+ 'dialog.markdown.placeholder': 'Write your Markdown text definition here...',
+ 'dialog.markdown.preview': 'Preview',
+ 'dialog.markdown.insert': 'Insert',
+ 'dialog.error.loadMermaid': 'Failed to load Mermaid library',
+
+ // Extra tools menu items
+ 'extraTools.mermaidToDrawnix': 'Mermaid to Drawnix',
+ 'extraTools.markdownToDrawnix': 'Markdown to Drawnix',
+ },
+};
+
+// I18n context interface
+interface I18nContextType {
+ language: Language;
+ setLanguage: (language: Language) => void;
+ t: (key: keyof Translations) => string;
+}
+
+// Create the context
+const I18nContext = createContext<I18nContextType | undefined>(undefined);
+
+// Provider props
+interface I18nProviderProps {
+ children: ReactNode;
+ defaultLanguage?: Language;
+}
+
+// I18nProvider component
+export const I18nProvider: React.FC<I18nProviderProps> = ({
+ children,
+ defaultLanguage = 'zh'
+}) => {
+ const [language, setLanguage] = useState<Language>(defaultLanguage);
+
+ const t = (key: keyof Translations): string => {
+ return translations[language][key] || key;
+ };
+
+ const value: I18nContextType = useMemo(() => ({
+ language,
+ setLanguage,
+ t,
+ }), [language]);
+
+ return (
+ <I18nContext.Provider value={value}>
+ {children}
+ </I18nContext.Provider>
+ );
+};
+
+// useI18n hook
+export const useI18n = (): I18nContextType => {
+ const context = useContext(I18nContext);
+
+ if (!context) {
+ throw new Error('useI18n must be used within I18nProvider');
+ }
+
+ return context;
+};
+
+// Export types for external use
+export type { I18nContextType };
\ No newline at end of file
diff --git a/packages/drawnix/src/index.ts b/packages/drawnix/src/index.ts
index 4305ee1..6d0d2be 100644
--- a/packages/drawnix/src/index.ts
+++ b/packages/drawnix/src/index.ts
@@ -1,2 +1,3 @@
export * from './drawnix';
export * from './utils';
+export * from './i18n';