Skip to content

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

feat(copy-clipboard): 新增复制到剪贴板功能(SVG / PNG) (#395)

Nightte6993b09a48c
diff --git a/packages/drawnix/src/components/toolbar/popup-toolbar/more-options-button.tsx b/packages/drawnix/src/components/toolbar/popup-toolbar/more-options-button.tsx
index fe4ac16..62c89aa 100644
--- a/packages/drawnix/src/components/toolbar/popup-toolbar/more-options-button.tsx
+++ b/packages/drawnix/src/components/toolbar/popup-toolbar/more-options-button.tsx
@@ -9,6 +9,11 @@ import Menu from '../../menu/menu';
import MenuItem from '../../menu/menu-item';
import { useState } from 'react';
import { getShortcutKey } from '../../../utils/common';
+import {
+ canCopySelectionAs,
+ copySelectionAsPng,
+ copySelectionAsSvg,
+} from '../../../utils/image';
export type MoreOptionsButtonProps = {
board: PlaitBoard;
@@ -20,6 +25,9 @@ export const MoreOptionsButton: React.FC<MoreOptionsButtonProps> = ({
const { t } = useI18n();
const container = PlaitBoard.getBoardContainer(board);
const [menuOpen, setMenuOpen] = useState(false);
+ const canCopySvg = canCopySelectionAs('svg');
+ const canCopyPng = canCopySelectionAs('png');
+ const canCopyAny = canCopySvg || canCopyPng;
return (
<Popover
@@ -71,6 +79,48 @@ export const MoreOptionsButton: React.FC<MoreOptionsButtonProps> = ({
>
{t('general.delete')}
</MenuItem>
+ <MenuItem
+ onSelect={() => undefined}
+ aria-label={t('general.copyToClipboard')}
+ disabled={!canCopyAny}
+ submenu={
+ <Menu
+ onSelect={() => {
+ setMenuOpen(false);
+ }}
+ >
+ <MenuItem
+ onSelect={() => {
+ void copySelectionAsSvg(board).catch(() => undefined);
+ }}
+ disabled={!canCopySvg}
+ aria-label={t('general.copyToClipboard.svg')}
+ >
+ {t('general.copyToClipboard.svg')}
+ </MenuItem>
+ <MenuItem
+ onSelect={() => {
+ void copySelectionAsPng(board).catch(() => undefined);
+ }}
+ disabled={!canCopyPng}
+ aria-label={t('general.copyToClipboard.pngWithoutBackground')}
+ >
+ {t('general.copyToClipboard.pngWithoutBackground')}
+ </MenuItem>
+ <MenuItem
+ onSelect={() => {
+ void copySelectionAsPng(board, true).catch(() => undefined);
+ }}
+ disabled={!canCopyPng}
+ aria-label={t('general.copyToClipboard.pngWithBackground')}
+ >
+ {t('general.copyToClipboard.pngWithBackground')}
+ </MenuItem>
+ </Menu>
+ }
+ >
+ {t('general.copyToClipboard')}
+ </MenuItem>
</Menu>
</PopoverContent>
</Popover>
diff --git a/packages/drawnix/src/i18n/translations/ar.ts b/packages/drawnix/src/i18n/translations/ar.ts
index ae4a09f..decdbca 100644
--- a/packages/drawnix/src/i18n/translations/ar.ts
+++ b/packages/drawnix/src/i18n/translations/ar.ts
@@ -68,6 +68,11 @@ const arTranslations: Translations = {
"general.duplicate": "تكرار",
"general.delete": "حذف",
+ "general.copyToClipboard": "نسخ إلى الحافظة",
+ "general.copyToClipboard.svg": "SVG",
+ "general.copyToClipboard.pngWithoutBackground": "PNG (بدون خلفية)",
+ "general.copyToClipboard.pngWithBackground": "PNG (مع خلفية)",
+
// Language
"language.switcher": "اللغة",
"language.chinese": "中文",
diff --git a/packages/drawnix/src/i18n/translations/en.ts b/packages/drawnix/src/i18n/translations/en.ts
index 32dd198..d5bd6c1 100644
--- a/packages/drawnix/src/i18n/translations/en.ts
+++ b/packages/drawnix/src/i18n/translations/en.ts
@@ -67,6 +67,10 @@ const enTranslations: Translations = {
'general.moreOptions': 'More Options',
'general.duplicate': 'Duplicate',
'general.delete': 'Delete',
+ 'general.copyToClipboard': 'Copy to Clipboard',
+ 'general.copyToClipboard.svg': 'SVG',
+ 'general.copyToClipboard.pngWithoutBackground': 'PNG (no background)',
+ 'general.copyToClipboard.pngWithBackground': 'PNG (with background)',
// Language
'language.switcher': 'Language',
diff --git a/packages/drawnix/src/i18n/translations/ru.ts b/packages/drawnix/src/i18n/translations/ru.ts
index 98f8b46..534f668 100644
--- a/packages/drawnix/src/i18n/translations/ru.ts
+++ b/packages/drawnix/src/i18n/translations/ru.ts
@@ -68,6 +68,11 @@ const ruTranslations: Translations = {
'general.duplicate': 'Дублировать',
'general.delete': 'Удалить',
+ 'general.copyToClipboard': 'Копировать в буфер обмена',
+ 'general.copyToClipboard.svg': 'SVG',
+ 'general.copyToClipboard.pngWithoutBackground': 'PNG (без фона)',
+ 'general.copyToClipboard.pngWithBackground': 'PNG (с фоном)',
+
// Language
'language.switcher': 'Language',
'language.chinese': '中文',
diff --git a/packages/drawnix/src/i18n/translations/vi.ts b/packages/drawnix/src/i18n/translations/vi.ts
index a33e6ba..158da35 100644
--- a/packages/drawnix/src/i18n/translations/vi.ts
+++ b/packages/drawnix/src/i18n/translations/vi.ts
@@ -68,6 +68,11 @@ const viTranslations: Translations = {
'general.duplicate': 'Nhân bản',
'general.delete': 'Xóa',
+ 'general.copyToClipboard': 'Sao chép vào bộ nhớ tạm',
+ 'general.copyToClipboard.svg': 'SVG',
+ 'general.copyToClipboard.pngWithoutBackground': 'PNG (không nền)',
+ 'general.copyToClipboard.pngWithBackground': 'PNG (có nền)',
+
// Language
'language.switcher': 'Ngôn ngữ',
'language.chinese': '中文',
diff --git a/packages/drawnix/src/i18n/translations/zh.ts b/packages/drawnix/src/i18n/translations/zh.ts
index 0ee6861..494957b 100644
--- a/packages/drawnix/src/i18n/translations/zh.ts
+++ b/packages/drawnix/src/i18n/translations/zh.ts
@@ -68,6 +68,11 @@ const zhTranslations: Translations = {
'general.duplicate': '复制',
'general.delete': '删除',
+ 'general.copyToClipboard': '复制到剪贴板',
+ 'general.copyToClipboard.svg': 'SVG',
+ 'general.copyToClipboard.pngWithoutBackground': 'PNG(无背景)',
+ 'general.copyToClipboard.pngWithBackground': 'PNG(含背景)',
+
// Language
'language.switcher': 'Language',
'language.chinese': '中文',
diff --git a/packages/drawnix/src/i18n/types.ts b/packages/drawnix/src/i18n/types.ts
index bd995b8..2e8d10e 100644
--- a/packages/drawnix/src/i18n/types.ts
+++ b/packages/drawnix/src/i18n/types.ts
@@ -71,6 +71,10 @@ export interface Translations {
'general.moreOptions': string;
'general.duplicate': string;
'general.delete': string;
+ 'general.copyToClipboard': string;
+ 'general.copyToClipboard.svg': string;
+ 'general.copyToClipboard.pngWithoutBackground': string;
+ 'general.copyToClipboard.pngWithBackground': string;
// Language
'language.switcher': string;
diff --git a/packages/drawnix/src/utils/image.ts b/packages/drawnix/src/utils/image.ts
index 8d4f27b..3c560b2 100644
--- a/packages/drawnix/src/utils/image.ts
+++ b/packages/drawnix/src/utils/image.ts
@@ -6,19 +6,88 @@ import { insertImage } from '../data/image';
import { getBackgroundColor, isWhite } from './color';
import { TRANSPARENT } from '../constants/color';
-export const saveAsSvg = (board: PlaitBoard) => {
- const selectedElements = getSelectedElements(board);
- const backgroundColor = getBackgroundColor(board);
+type ClipboardImageFormat = 'svg' | 'png';
+type ExportElements = ReturnType<typeof getSelectedElements>;
+
+const CLIPBOARD_MIME_TYPES: Record<ClipboardImageFormat, string> = {
+ svg: 'image/svg+xml',
+ png: 'image/png',
+};
+
+const hasClipboardWriteSupport = () => {
+ // Keep the ClipboardItem check local until the shared helper also covers it.
+ return (
+ typeof navigator !== 'undefined' &&
+ !!navigator.clipboard?.write &&
+ typeof ClipboardItem !== 'undefined'
+ );
+};
+
+const getClipboardItemSupports = () => {
+ const clipboardItemWithSupports = ClipboardItem as typeof ClipboardItem & {
+ supports?: (type: string) => boolean;
+ };
+ return clipboardItemWithSupports.supports;
+};
+
+export const canCopySelectionAs = (format: ClipboardImageFormat) => {
+ if (!hasClipboardWriteSupport()) {
+ return false;
+ }
+ const supports = getClipboardItemSupports();
+ if (typeof supports === 'function') {
+ return supports(CLIPBOARD_MIME_TYPES[format]);
+ }
+ return format === 'png';
+};
+
+const writeBlobToClipboard = async (
+ format: ClipboardImageFormat,
+ blob: Blob | null,
+ fallbackPngBlob?: Blob | null
+) => {
+ if (!blob || !hasClipboardWriteSupport()) {
+ return;
+ }
+ const item: Record<string, Blob> = { [CLIPBOARD_MIME_TYPES[format]]: blob };
+ if (fallbackPngBlob) {
+ item[CLIPBOARD_MIME_TYPES.png] = fallbackPngBlob;
+ }
+ await navigator.clipboard.write([new ClipboardItem(item)]);
+};
- return toSvgData(board, {
+const getSvgBlob = async (board: PlaitBoard, elements?: ExportElements) => {
+ const backgroundColor = getBackgroundColor(board);
+ const svgData = await toSvgData(board, {
fillStyle: isWhite(backgroundColor) ? TRANSPARENT : backgroundColor,
padding: 20,
ratio: 4,
- elements: selectedElements.length > 0 ? selectedElements : undefined,
+ elements,
inlineStyleClassNames: '.plait-text-container',
styleNames: ['position'],
- }).then((svgData) => {
- const blob = new Blob([svgData], { type: 'image/svg+xml' });
+ });
+ return new Blob([svgData], { type: CLIPBOARD_MIME_TYPES.svg });
+};
+
+const getImageBlob = async (
+ board: PlaitBoard,
+ isTransparent: boolean,
+ elements?: ExportElements
+) => {
+ const backgroundColor = getBackgroundColor(board) || 'white';
+ const imageDataUrl = await boardToImage(board, {
+ elements,
+ fillStyle: isTransparent ? 'transparent' : backgroundColor,
+ });
+ return imageDataUrl ? base64ToBlob(imageDataUrl) : null;
+};
+
+export const saveAsSvg = (board: PlaitBoard) => {
+ const selectedElements = getSelectedElements(board);
+ return getSvgBlob(
+ board,
+ selectedElements.length > 0 ? selectedElements : undefined
+ ).then((blob) => {
const imageName = `drawnix-${new Date().getTime()}.svg`;
download(blob, imageName);
});
@@ -26,20 +95,52 @@ export const saveAsSvg = (board: PlaitBoard) => {
export const saveAsImage = (board: PlaitBoard, isTransparent: boolean) => {
const selectedElements = getSelectedElements(board);
- const backgroundColor = getBackgroundColor(board) || 'white';
- boardToImage(board, {
- elements: selectedElements.length > 0 ? selectedElements : undefined,
- fillStyle: isTransparent ? 'transparent' : backgroundColor,
- }).then((image) => {
- if (image) {
+ getImageBlob(
+ board,
+ isTransparent,
+ selectedElements.length > 0 ? selectedElements : undefined
+ ).then((imageBlob) => {
+ if (imageBlob) {
const ext = isTransparent ? 'png' : 'jpg';
- const pngImage = base64ToBlob(image);
const imageName = `drawnix-${new Date().getTime()}.${ext}`;
- download(pngImage, imageName);
+ download(imageBlob, imageName);
}
});
};
+export const copySelectionAsSvg = async (board: PlaitBoard) => {
+ const selectedElements = getSelectedElements(board);
+ if (selectedElements.length === 0) {
+ return;
+ }
+ const [blob, pngBlob] = await Promise.all([
+ getSvgBlob(board, selectedElements),
+ getImageBlob(board, true, selectedElements),
+ ]);
+ await writeBlobToClipboard('svg', blob, pngBlob);
+};
+
+export const copySelectionAsPng = async (
+ board: PlaitBoard,
+ withBackground = false
+) => {
+ const selectedElements = getSelectedElements(board);
+ if (selectedElements.length === 0) {
+ return;
+ }
+ const imageBlob = await getImageBlob(
+ board,
+ !withBackground,
+ selectedElements
+ );
+ if (!imageBlob) {
+ return;
+ }
+ // The clipboard only gets image/png. The background choice is controlled by
+ // how the image is rendered before writing to the clipboard.
+ await writeBlobToClipboard('png', imageBlob);
+};
+
export const addImage = async (board: PlaitBoard) => {
const imageFile = await fileOpen({
description: 'Image',