Skip to content

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

feat(menu): support load file action

pubuzhixing8758aa6d03c83
diff --git a/packages/drawnix/src/components/icons.tsx b/packages/drawnix/src/components/icons.tsx
index 1692c73..d1c45f1 100644
--- a/packages/drawnix/src/components/icons.tsx
+++ b/packages/drawnix/src/components/icons.tsx
@@ -210,9 +210,23 @@ export const ZoomInIcon = createIcon(
);
export const SaveFileIcon = createIcon(
- <svg viewBox="0 0 18 18" version="1.1" xmlns="http://www.w3.org/2000/svg">
+ <svg viewBox="0 0 18 18" version="1.1" xmlns="http://www.w3.org/2000/svg">
<g id="save-file" stroke="none" fill="currentColor">
- <path fillRule="nonzero" d="M11.064 9.1l2.645 2.595.03-.029.848.849-3.523 3.323-.848-.848 1.994-1.883H7.5v-1.2h4.712l-1.996-1.958.848-.849zM9.356.3L13.7 3.71V7.9h-1.2l-.001-2.633H8.5V1.5L3.1 1.5a.4.4 0 0 0-.392.32L2.7 1.9v12a.4.4 0 0 0 .32.392l.08.008h3.418v1.2H3.1a1.6 1.6 0 0 1-1.593-1.454L1.5 13.9v-12A1.6 1.6 0 0 1 2.954.307L3.1.3h6.256zM9.7 2.095v1.973l2.51-.001L9.7 2.095z"></path>
+ <path
+ fillRule="nonzero"
+ d="M11.064 9.1l2.645 2.595.03-.029.848.849-3.523 3.323-.848-.848 1.994-1.883H7.5v-1.2h4.712l-1.996-1.958.848-.849zM9.356.3L13.7 3.71V7.9h-1.2l-.001-2.633H8.5V1.5L3.1 1.5a.4.4 0 0 0-.392.32L2.7 1.9v12a.4.4 0 0 0 .32.392l.08.008h3.418v1.2H3.1a1.6 1.6 0 0 1-1.593-1.454L1.5 13.9v-12A1.6 1.6 0 0 1 2.954.307L3.1.3h6.256zM9.7 2.095v1.973l2.51-.001L9.7 2.095z"
+ ></path>
+ </g>
+ </svg>
+);
+
+export const OpenFileIcon = createIcon(
+ <svg viewBox="0 0 18 18" version="1.1" xmlns="http://www.w3.org/2000/svg">
+ <g id="save-file" stroke="currentColor" fill="none">
+ <path
+ d="m9.257 6.351.183.183H15.819c.34 0 .727.182 1.051.506.323.323.505.708.505 1.05v5.819c0 .316-.183.7-.52 1.035-.337.338-.723.522-1.037.522H4.182c-.352 0-.74-.181-1.058-.5-.318-.318-.499-.705-.499-1.057V5.182c0-.351.181-.736.5-1.054.32-.321.71-.503 1.057-.503H6.53l2.726 2.726Z"
+ strokeWidth="1.25"
+ />
</g>
</svg>
);
diff --git a/packages/drawnix/src/components/main-menu/default-items.tsx b/packages/drawnix/src/components/main-menu/default-items.tsx
index 17ac912..5aa7203 100644
--- a/packages/drawnix/src/components/main-menu/default-items.tsx
+++ b/packages/drawnix/src/components/main-menu/default-items.tsx
@@ -1,12 +1,28 @@
-import { ExportImageIcon, GithubIcon, SaveFileIcon } from '../icons';
+import {
+ ExportImageIcon,
+ GithubIcon,
+ OpenFileIcon,
+ SaveFileIcon,
+} from '../icons';
import DropdownMenuItem from '../dropdown-menu/DropdownMenuItem';
import DropdownMenuItemLink from '../dropdown-menu/DropdownMenuItemLink';
import './default-items.scss';
-import { useBoard } from '@plait/react-board';
-import { getSelectedElements } from '@plait/core';
+import { useBoard, useListRender } from '@plait/react-board';
+import {
+ BoardTransforms,
+ getSelectedElements,
+ initializeViewBox,
+ initializeViewportContainer,
+ PlaitBoard,
+ PlaitElement,
+ PlaitTheme,
+ ThemeColorMode,
+ updateViewportOffset,
+ Viewport,
+} from '@plait/core';
import { base64ToBlob, boardToImage, download } from '../../utils';
-import { saveAsJSON } from '../../data/json';
+import { loadFromJSON, saveAsJSON } from '../../data/json';
export const SaveToFile = () => {
const board = useBoard();
@@ -23,6 +39,39 @@ export const SaveToFile = () => {
};
SaveToFile.displayName = 'SaveToFile';
+export const OpenFile = () => {
+ const board = useBoard();
+ const listRender = useListRender();
+ const clearAndLoad = (
+ value: PlaitElement[],
+ viewport?: Viewport,
+ theme?: PlaitTheme
+ ) => {
+ board.children = value;
+ board.viewport = viewport || { zoom: 1 };
+ board.theme = theme || { themeColorMode: ThemeColorMode.default };
+ listRender.update(board.children, {
+ board: board,
+ parent: board,
+ parentG: PlaitBoard.getElementHost(board),
+ });
+ BoardTransforms.fitViewport(board);
+ };
+ return (
+ <DropdownMenuItem
+ data-testid="open-button"
+ onSelect={() => {
+ loadFromJSON(board).then((data) => {
+ clearAndLoad(data.elements, data.viewport);
+ });
+ }}
+ icon={OpenFileIcon}
+ aria-label={`${`打开`}`}
+ >{`打开`}</DropdownMenuItem>
+ );
+};
+OpenFile.displayName = 'OpenFile';
+
export const SaveAsImage = () => {
const board = useBoard();
return (
diff --git a/packages/drawnix/src/components/main-menu/main-menu.tsx b/packages/drawnix/src/components/main-menu/main-menu.tsx
index d1d3836..3e6eba7 100644
--- a/packages/drawnix/src/components/main-menu/main-menu.tsx
+++ b/packages/drawnix/src/components/main-menu/main-menu.tsx
@@ -4,7 +4,7 @@ import { ATTACHED_ELEMENT_CLASS_NAME } from '@plait/core';
import DropdownMenu from '../dropdown-menu/DropdownMenu';
import { MenuIcon } from '../icons';
import { composeEventHandlers } from '../../utils';
-import { SaveAsImage, SaveToFile, Socials } from './default-items';
+import { OpenFile, SaveAsImage, SaveToFile, Socials } from './default-items';
type MainMenuProps = {
children?: React.ReactNode;
@@ -36,6 +36,7 @@ export const MainMenu: React.FC<MainMenuProps> = ({ onSelect, children }) => {
setMainMenuOpen(false);
})}
>
+ <OpenFile></OpenFile>
<SaveToFile></SaveToFile>
<SaveAsImage></SaveAsImage>
<DropdownMenu.Separator />
diff --git a/packages/drawnix/src/data/blob.ts b/packages/drawnix/src/data/blob.ts
new file mode 100644
index 0000000..d9c5ca5
--- /dev/null
+++ b/packages/drawnix/src/data/blob.ts
@@ -0,0 +1,80 @@
+import { PlaitBoard } from '@plait/core';
+import { isValidDrawnixData } from './json';
+import { MIME_TYPES } from '../constants';
+import { ValueOf } from '../utility-types';
+
+export const loadFromBlob = async (board: PlaitBoard, blob: Blob | File) => {
+ const contents = await parseFileContents(blob);
+ let data;
+ try {
+ try {
+ data = JSON.parse(contents);
+ } catch (error: any) {
+ throw error;
+ }
+ if (isValidDrawnixData(data)) {
+ return data;
+ }
+ throw new Error('Error: invalid file');
+ } catch (error: any) {
+ throw new Error('Error: invalid file');
+ }
+};
+
+export const createFile = (
+ blob: File | Blob | ArrayBuffer,
+ mimeType: ValueOf<typeof MIME_TYPES>,
+ name: string | undefined
+) => {
+ return new File([blob], name || '', {
+ type: mimeType,
+ });
+};
+
+export const blobToArrayBuffer = (blob: Blob): Promise<ArrayBuffer> => {
+ if ('arrayBuffer' in blob) {
+ return blob.arrayBuffer();
+ }
+ // Safari
+ return new Promise((resolve, reject) => {
+ const reader = new FileReader();
+ reader.onload = (event) => {
+ if (!event.target?.result) {
+ return reject(new Error("Couldn't convert blob to ArrayBuffer"));
+ }
+ resolve(event.target.result as ArrayBuffer);
+ };
+ reader.readAsArrayBuffer(blob);
+ });
+};
+
+export const normalizeFile = async (file: File) => {
+ if (!file.type) {
+ if (file?.name?.endsWith('.drawnix')) {
+ file = createFile(
+ await blobToArrayBuffer(file),
+ MIME_TYPES.drawnix,
+ file.name
+ );
+ }
+ }
+ return file;
+};
+
+export const parseFileContents = async (blob: Blob | File) => {
+ let contents: string;
+ if ('text' in Blob) {
+ contents = await blob.text();
+ } else {
+ contents = await new Promise((resolve) => {
+ const reader = new FileReader();
+ reader.readAsText(blob, 'utf8');
+ reader.onloadend = () => {
+ if (reader.readyState === FileReader.DONE) {
+ resolve(reader.result as string);
+ }
+ };
+ });
+ }
+ return contents;
+};
diff --git a/packages/drawnix/src/data/json.ts b/packages/drawnix/src/data/json.ts
index 9e50d16..2787012 100644
--- a/packages/drawnix/src/data/json.ts
+++ b/packages/drawnix/src/data/json.ts
@@ -1,6 +1,8 @@
-import { PlaitBoard } from '@plait/core';
+import { PlaitBoard, PlaitElement } from '@plait/core';
import { MIME_TYPES, VERSIONS } from '../constants';
-import { fileSave } from './filesystem';
+import { fileOpen, fileSave } from './filesystem';
+import { DrawnixExportedData, DrawnixExportedType } from './types';
+import { loadFromBlob, normalizeFile } from './blob';
export const getDefaultName = () => {
const time = new Date().getTime();
@@ -24,9 +26,28 @@ export const saveAsJSON = async (
return { fileHandle };
};
+export const loadFromJSON = async (board: PlaitBoard) => {
+ const file = await fileOpen({
+ description: 'Drawnix files',
+ // ToDo: Be over-permissive until https://bugs.webkit.org/show_bug.cgi?id=34442
+ // gets resolved. Else, iOS users cannot open `.drawnix` files.
+ // extensions: ["json", "drawnix", "png", "svg"],
+ });
+ return loadFromBlob(board, await normalizeFile(file));
+};
+
+export const isValidDrawnixData = (data?: any): data is DrawnixExportedData => {
+ return (
+ data &&
+ data.type === DrawnixExportedType.drawnix &&
+ Array.isArray(data.elements) &&
+ typeof data.viewport === 'object'
+ );
+};
+
export const serializeAsJSON = (board: PlaitBoard): string => {
const data = {
- type: 'drawnix',
+ type: DrawnixExportedType.drawnix,
version: VERSIONS.drawnix,
source: 'web',
elements: board.children,
diff --git a/packages/drawnix/src/data/types.ts b/packages/drawnix/src/data/types.ts
new file mode 100644
index 0000000..2eb6220
--- /dev/null
+++ b/packages/drawnix/src/data/types.ts
@@ -0,0 +1,13 @@
+import { PlaitElement, Viewport } from '@plait/core';
+
+export interface DrawnixExportedData {
+ type: DrawnixExportedType.drawnix;
+ version: number;
+ source: 'web';
+ elements: PlaitElement[];
+ viewport: Viewport;
+}
+
+export enum DrawnixExportedType {
+ drawnix = 'drawnix'
+}
\ No newline at end of file
diff --git a/packages/drawnix/src/utility-types.ts b/packages/drawnix/src/utility-types.ts
index e6d5e99..d50dde1 100644
--- a/packages/drawnix/src/utility-types.ts
+++ b/packages/drawnix/src/utility-types.ts
@@ -3,3 +3,5 @@ export type ResolutionType<T extends (...args: any) => any> = T extends (
) => Promise<infer R>
? R
: any;
+
+export type ValueOf<T> = T[keyof T];
diff --git a/packages/react-board/src/hooks/use-board.tsx b/packages/react-board/src/hooks/use-board.tsx
index 5cc1847..9485630 100644
--- a/packages/react-board/src/hooks/use-board.tsx
+++ b/packages/react-board/src/hooks/use-board.tsx
@@ -3,7 +3,13 @@
* context whenever changes occur.
*/
-import { ListRender, PlaitBoard } from '@plait/core';
+import {
+ ListRender,
+ PlaitBoard,
+ PlaitElement,
+ PlaitTheme,
+ Viewport,
+} from '@plait/core';
import { createContext, useContext } from 'react';
export interface BoardContextValue {