mirror of
https://github.com/excalidraw/excalidraw.git
synced 2025-11-04 12:54:23 +01:00
d6cd8b78f1
* feat: decouple package deps and introduce yarn workspaces * update root directory * fix * fix scripts * fix lint * update path in scripts * remove yarn.lock files from packages * ignore workspace * dummy * dummy * remove comment check * revert workflow changes * ignore ws when installing gh actions * remove log * update path * fix * fix typo
100 lines
2.3 KiB
Markdown
100 lines
2.3 KiB
Markdown
# @excalidraw/utils
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @excalidraw/utils
|
|
```
|
|
|
|
If you prefer Yarn over npm, use this command to install the Excalidraw utils package:
|
|
|
|
```bash
|
|
yarn add @excalidraw/utils
|
|
```
|
|
|
|
## API
|
|
|
|
### `serializeAsJSON`
|
|
|
|
See [`serializeAsJSON`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#serializeAsJSON) for API and description.
|
|
|
|
### `exportToBlob` (async)
|
|
|
|
Export an Excalidraw diagram to a [Blob](https://developer.mozilla.org/en-US/docs/Web/API/Blob).
|
|
|
|
### `exportToSvg`
|
|
|
|
Export an Excalidraw diagram to a [SVGElement](https://developer.mozilla.org/en-US/docs/Web/API/SVGElement).
|
|
|
|
## Usage
|
|
|
|
Excalidraw utils is published as a UMD (Universal Module Definition). If you are using a module bundler (for instance, Webpack), you can import it as an ES6 module:
|
|
|
|
```js
|
|
import { exportToSvg, exportToBlob } from "@excalidraw/utils";
|
|
```
|
|
|
|
To use it in a browser directly:
|
|
|
|
```html
|
|
<script src="https://unpkg.com/@excalidraw/utils@0.1.0/dist/excalidraw-utils.min.js"></script>
|
|
<script>
|
|
// ExcalidrawUtils is a global variable defined by excalidraw.min.js
|
|
const { exportToSvg, exportToBlob } = ExcalidrawUtils;
|
|
</script>
|
|
```
|
|
|
|
Here's the `exportToBlob` and `exportToSvg` functions in action:
|
|
|
|
```js
|
|
const excalidrawDiagram = {
|
|
type: "excalidraw",
|
|
version: 2,
|
|
source: "https://excalidraw.com",
|
|
elements: [
|
|
{
|
|
id: "vWrqOAfkind2qcm7LDAGZ",
|
|
type: "ellipse",
|
|
x: 414,
|
|
y: 237,
|
|
width: 214,
|
|
height: 214,
|
|
angle: 0,
|
|
strokeColor: "#000000",
|
|
backgroundColor: "#15aabf",
|
|
fillStyle: "hachure",
|
|
strokeWidth: 1,
|
|
strokeStyle: "solid",
|
|
roughness: 1,
|
|
opacity: 100,
|
|
groupIds: [],
|
|
roundness: null,
|
|
seed: 1041657908,
|
|
version: 120,
|
|
versionNonce: 1188004276,
|
|
isDeleted: false,
|
|
boundElementIds: null,
|
|
},
|
|
],
|
|
appState: {
|
|
viewBackgroundColor: "#ffffff",
|
|
gridSize: null,
|
|
},
|
|
};
|
|
|
|
// Export the Excalidraw diagram as SVG string
|
|
const svg = exportToSvg(excalidrawDiagram);
|
|
console.log(svg.outerHTML);
|
|
|
|
// Export the Excalidraw diagram as PNG Blob URL
|
|
(async () => {
|
|
const blob = await exportToBlob({
|
|
...excalidrawDiagram,
|
|
mimeType: "image/png",
|
|
});
|
|
|
|
const urlCreator = window.URL || window.webkitURL;
|
|
console.log(urlCreator.createObjectURL(blob));
|
|
})();
|
|
```
|