Compare commits

..

14 Commits

Author SHA1 Message Date
zsviczian
225c6305d1 added SVG import 2022-10-30 15:44:14 +01:00
zsviczian
ba9ab61cc9 override zoomToFit for large drawings 2022-10-29 19:54:06 +02:00
zsviczian
0940a8628a 1.7.26 2022-10-29 14:36:17 +02:00
zsviczian
46ee9e9524 disable autosave 2022-10-29 12:25:15 +02:00
zsviczian
c044278a4a bumpt excalidraw version 2022-10-29 09:42:59 +02:00
Zsolt Viczian
aa9118cdae force embed image to 100% scale 2022-10-25 21:24:15 +02:00
Zsolt Viczian
d19b32d0c4 changed getTransclusion to properly return nested bullet list 2022-10-24 21:20:21 +02:00
zsviczian
dd7f0750fd Merge pull request #852 from 7flash/patch-3
Update attributes_functions_overview.md
2022-10-23 22:04:35 +02:00
Igor Berlenko
e1330cd8bb Update attributes_functions_overview.md
Fixed comment to be consistent with implementation, it's actually expecting to return "true" to prevent handling and otherwise "false" will proceed with default handler.

04367bd3cd/src/ExcalidrawView.ts (L2879)
2022-10-20 19:58:32 +08:00
Zsolt Viczian
04367bd3cd 1.7.25 2022-10-16 20:22:20 +02:00
zsviczian
7d139462bf Update README.md 2022-10-15 15:20:27 +02:00
zsviczian
d8e429d815 1.7.24 2022-10-10 11:55:22 +02:00
zsviczian
4685a6f014 1.7.24 2022-10-10 11:31:21 +02:00
zsviczian
03b389a2b5 Update README.md 2022-10-09 20:31:34 +02:00
38 changed files with 2160 additions and 96 deletions

3
.gitignore vendored
View File

@@ -15,4 +15,5 @@ data.json
lib
#VSCode
.vscode
.vscode
yarn.lock

View File

@@ -17,7 +17,10 @@ Please upgrade to Obsidian v0.12.19 or higher to get the latest release.
|[![fourtfont](https://user-images.githubusercontent.com/14358394/149659524-2a4e0a24-40c9-4e66-a6b1-c92f3b88ecd5.jpg)](https://youtu.be/eKFmrSQhFA4)|[![thumbnail](https://user-images.githubusercontent.com/14358394/151705333-54e9ffd2-0bd7-4d02-b99e-0bd4e4708d4d.jpg)](https://youtu.be/qbPIAZguJeo)|[![Thumbnail](https://user-images.githubusercontent.com/14358394/152585752-7eb0371f-0bab-40f6-a194-3b48e5811735.jpg)](https://youtu.be/2Y8OhkGiTHg)|
|[![Thumbnail](https://user-images.githubusercontent.com/14358394/153676009-6f86b2d7-c248-49a2-b802-be21c6999e4f.jpg)](https://youtu.be/2v9TZmQNO8c)|[![Thumbnail](https://user-images.githubusercontent.com/14358394/154821232-a404b6cf-72fb-4ce4-9d53-619132dce491.jpg)](https://youtu.be/xHPGWR3m0c8)|[![Thumbnail](https://user-images.githubusercontent.com/14358394/156931428-b2269fd9-87bd-43ab-8558-5572f40dff93.jpg)](https://youtu.be/gMIKXyhS-dM)|
|[![thumbnail](https://user-images.githubusercontent.com/14358394/156931461-0979b821-315a-41dd-86f1-31d169b7c127.jpg)](https://youtu.be/Etskjw7a5zo)|[![Thumbnail](https://user-images.githubusercontent.com/14358394/158008902-12c6a851-237e-4edd-a631-d48e81c904b2.jpg)](https://youtu.be/4N6efq1DtH0)|[![thumbnail](https://user-images.githubusercontent.com/14358394/159369910-6371f08d-b5fa-454d-9c6c-948f7e7a7d26.jpg)](https://youtu.be/U2LkBRBk4LY)|
| [![6 strategies for linking your visual thoughts v4](https://user-images.githubusercontent.com/14358394/171635214-30533c45-94fa-436e-83a9-b2ec99f190e2.jpg)](https://youtu.be/qiKuqMcNWgU)|[![Video thumbnail small](https://user-images.githubusercontent.com/14358394/185791706-3d9983ab-7cb1-4b27-a016-30c039d84e34.jpg)](https://youtu.be/yZQoJg2RCKI)| |
| [![6 strategies for linking your visual thoughts v4](https://user-images.githubusercontent.com/14358394/171635214-30533c45-94fa-436e-83a9-b2ec99f190e2.jpg)](https://youtu.be/qiKuqMcNWgU)|[![Video thumbnail small](https://user-images.githubusercontent.com/14358394/185791706-3d9983ab-7cb1-4b27-a016-30c039d84e34.jpg)](https://youtu.be/yZQoJg2RCKI)|[![Thumbnail - Colors - Excalidraw Basics (Custom)](https://user-images.githubusercontent.com/14358394/194773147-5418a0ab-6be5-4eb0-a8e4-d6af21b1b483.png)](https://youtu.be/6PLGHBH9VZ4) |
|[![Thumbnail - Excalidraw color palettes (Custom)](https://user-images.githubusercontent.com/14358394/194773211-9e871be7-0795-4dc7-947e-c6c275e690d0.png)](https://youtu.be/epYNx2FSf2w) | [![Thumbnail (Custom)](https://user-images.githubusercontent.com/14358394/194773268-400cfb1b-6bde-45e0-9e4b-91bbaa461cf0.png)](https://youtu.be/Amhlv6r9WvM) | [![Thumbnail - Simple rules for beautiful sketches (Custom) (1)](https://user-images.githubusercontent.com/14358394/194773527-ef35c8b9-1a6d-4415-9c7e-b667fb17535d.png)](https://youtu.be/r9oB1SlK1GU) |
|[![Thumbnail - ColorMaster Scripting (Custom)](https://user-images.githubusercontent.com/14358394/195988535-a133a9b9-d094-45ba-ba64-c994b9a1e0ef.png)](https://youtu.be/7gJDwNgQ6NU) | | |
# Key features
@@ -50,8 +53,8 @@ Please upgrade to Obsidian v0.12.19 or higher to get the latest release.
- Insert LaTeX formulas using the Command Palette action "Insert LaTeX formula". You can edit formulas either in Markdown view, or by <kbd>CTRL/CMD + Click</kbd> on the formula.
- Drag & Drop support
- You can drag files from the Obsidian file explorer and they will become links to those files in Excalidraw.
- Dragging image files (PNG, SVG, JPG, Excalidraw) from Obsidian's file explorer while pressing the <kbd>CTRL/CMD</kbd> button will embed the image into your drawing.
- You can drag and drop images from outside Obsidian onto Excalidraw. These images will be embedded into your drawing and saved to Obsidian.
- Dragging image files (PNG, SVG, JPG, ICO, GIF, WEBP, Excalidraw) from Obsidian's file explorer while pressing the <kbd>CTRL</kbd> (<kbd>SHIFT</kbd> on Mac) button will embed the image into your drawing.
- If in addition to <kbd>CTRL</kbd> or <kbd>SHIFT</kbd> you also hold down <kbd>ALT<kbd>, the image will be inserted at 100% of its size. ⚠ Note: this is a very niche feature with a very particular behavior that I built primarily for myself (even more so than other features in Excalidraw Obsidian - also built primarily for myself 😉)... This will reset your embedded image to 100% size every time you open the Excalidraw drawing, or in case you have embedded an Excalidraw drawing on your canvas inserted using this function, every time you update the embedded drawing, it will be scaled back to 100% size. This means that even if you resize the image on the drawing, it will reset to 100% the next time you open the file or you modify the original embedded object. This feature is useful when you decompose a drawing into separate Excalidraw files, but when combined onto a single canvas you want the individual pieces to maintain their actual sizes. I use this feature to construct Book-on-a-Page summaries from atomic drawings.
- You can drag and drop text from Markdown views onto Excalidraw.
- You can drag and drop web addresses from your browser and they will become links.
- Image support

View File

@@ -362,7 +362,7 @@ export declare class ExcalidrawAutomate implements ExcalidrawAutomateInterface {
* If set, this callback is triggered, when the user hovers a link in the scene.
* You can use this callback in case you want to do something additional when the onLinkHover event occurs.
* This callback must return a boolean value.
* In case you want to prevent the excalidraw onLinkHover action you must return false, it will stop the native excalidraw onLinkHover management flow.
* In case you want to prevent the excalidraw onLinkHover action you must return true, it will stop the native excalidraw onLinkHover management flow.
*/
onLinkHoverHook: (element: NonDeletedExcalidrawElement, linkText: string, view: ExcalidrawView, ea: ExcalidrawAutomate) => boolean;
/**

View File

@@ -1,7 +1,7 @@
{
"id": "obsidian-excalidraw-plugin",
"name": "Excalidraw",
"version": "1.7.23",
"version": "1.7.26",
"minAppVersion": "0.15.6",
"description": "An Obsidian plugin to edit and view Excalidraw drawings",
"author": "Zsolt Viczian",

View File

@@ -1,6 +1,6 @@
{
"name": "obsidian-excalidraw-plugin",
"version": "1.7.23",
"version": "1.7.26",
"description": "This is an Obsidian.md plugin that lets you view and edit Excalidraw drawings",
"main": "lib/index.js",
"types": "lib/index.d.ts",
@@ -18,7 +18,7 @@
"license": "MIT",
"dependencies": {
"@types/lz-string": "^1.3.34",
"@zsviczian/excalidraw": "0.12.0-obsidian-11",
"@zsviczian/excalidraw": "0.13.0-obsidian",
"clsx": "^1.1.1",
"lz-string": "^1.4.4",
"monkey-around": "^2.3.0",
@@ -26,7 +26,9 @@
"react-dom": "^17.0.2",
"react-scripts": "^5.0.1",
"roughjs": "^4.5.2",
"colormaster": "1.2.1"
"colormaster": "1.2.1",
"chroma-js": "^2.4.2",
"gl-matrix": "^3.4.3"
},
"devDependencies": {
"@babel/core": "^7.16.12",
@@ -41,6 +43,7 @@
"@rollup/plugin-replace": "^3.0.1",
"@rollup/plugin-typescript": "^8.3.0",
"@types/js-beautify": "^1.13.3",
"@types/chroma-js": "^2.1.4",
"@types/node": "^15.12.4",
"@types/react-dom": "^17.0.2",
"@zerollup/ts-transform-paths": "^1.7.18",
@@ -49,7 +52,7 @@
"eslint-plugin-prettier": "^4.0.0",
"html2canvas": "^1.4.0",
"nanoid": "^4.0.0",
"obsidian": "^0.15.4",
"obsidian": "^0.16.3",
"prettier": "^2.5.1",
"rollup": "^2.70.1",
"rollup-plugin-copy": "^3.4.0",

View File

@@ -48,6 +48,7 @@ export declare type MimeType =
export type FileData = BinaryFileData & {
size: Size;
hasSVGwithBitmap: boolean;
shouldScale: boolean; //true if image should maintain its area, false if image should display at 100% its size
};
export type Size = {
@@ -182,6 +183,14 @@ export class EmbeddedFile {
}
return this.img; //images that are not SVGwithBitmap, only the light string is stored, since inverted and non-inverted are ===
}
/**
*
* @returns true if image should scale such as the updated images has the same area as the previous images, false if the image should be displayed at 100%
*/
public shouldScale() {
return !Boolean(this.linkParts && this.linkParts.original && this.linkParts.original.endsWith("|100%"));
}
}
export class EmbeddedFilesLoader {
@@ -367,6 +376,7 @@ export class EmbeddedFilesLoader {
created: data.created,
size: data.size,
hasSVGwithBitmap: data.hasSVGwithBitmap,
shouldScale: embeddedFile.shouldScale()
});
}
} else if (embeddedFile.isSVGwithBitmap) {
@@ -377,6 +387,7 @@ export class EmbeddedFilesLoader {
created: embeddedFile.mtime,
size: embeddedFile.size,
hasSVGwithBitmap: embeddedFile.isSVGwithBitmap,
shouldScale: embeddedFile.shouldScale()
});
}
}
@@ -395,6 +406,7 @@ export class EmbeddedFilesLoader {
created: data.created,
size: data.size,
hasSVGwithBitmap: false,
shouldScale: true
});
}
}

View File

@@ -9,7 +9,7 @@ import {
NonDeletedExcalidrawElement,
ExcalidrawImageElement,
} from "@zsviczian/excalidraw/types/element/types";
import { normalizePath, TFile, WorkspaceLeaf } from "obsidian";
import { normalizePath, Notice, TFile, WorkspaceLeaf } from "obsidian";
import ExcalidrawView, { ExportSettings, TextMode } from "./ExcalidrawView";
import { ExcalidrawData } from "./ExcalidrawData";
import {
@@ -25,7 +25,6 @@ import {
//debug,
embedFontsInSVG,
errorlog,
getDataURL,
getEmbeddedFilenameParts,
getImageSize,
getPNG,
@@ -59,6 +58,7 @@ import HSVPlugin from "colormaster/plugins/hsv";
import RYBPlugin from "colormaster/plugins/ryb";
import CMYKPlugin from "colormaster/plugins/cmyk";
import { TInput } from "colormaster/types";
import {ConversionResult, svgToExcalidraw} from "./svgToExcalidraw/parser"
extendPlugins([
HarmonyPlugin,
@@ -894,6 +894,7 @@ export class ExcalidrawAutomate implements ExcalidrawAutomateInterface {
topX: number,
topY: number,
imageFile: TFile,
scale: boolean = true, //true will scale the image to MAX_IMAGE_SIZE, false will insert image at 100% of its size
): Promise<string> {
const id = nanoid();
const loader = new EmbeddedFilesLoader(
@@ -910,11 +911,11 @@ export class ExcalidrawAutomate implements ExcalidrawAutomateInterface {
id: fileId,
dataURL: image.dataURL,
created: image.created,
file: imageFile.path,
file: imageFile.path + (scale ? "":"|100%"),
hasSVGwithBitmap: image.hasSVGwithBitmap,
latex: null,
};
if (Math.max(image.size.width, image.size.height) > MAX_IMAGE_SIZE) {
if (scale && (Math.max(image.size.width, image.size.height) > MAX_IMAGE_SIZE)) {
const scale =
MAX_IMAGE_SIZE / Math.max(image.size.width, image.size.height);
image.size.width = scale * image.size.width;
@@ -1491,6 +1492,15 @@ export class ExcalidrawAutomate implements ExcalidrawAutomateInterface {
pointerPosition: { x: number; y: number }; //the pointer position on canvas at the time of drop
}) => boolean = null;
/**
* If set, this callback is triggered whenever the active canvas color changes
*/
onCanvasColorChangeHook: (
ea: ExcalidrawAutomate,
view: ExcalidrawView, //the excalidraw view
color: string,
) => void = null;
/**
* utility function to generate EmbeddedFilesLoader object
* @param isDark
@@ -1858,8 +1868,22 @@ export class ExcalidrawAutomate implements ExcalidrawAutomateInterface {
log("Creates a CM object. Visit https://github.com/lbragile/ColorMaster for documentation.");
return;
}
if(typeof color === "string") {
color = this.colorNameToHex(color);
}
return CM(color);
}
importSVG(svgString:string):boolean {
const res:ConversionResult = svgToExcalidraw(svgString);
if(res.hasErrors) {
new Notice (`There were errors while parsing the given SVG:\n${[...res.errors].map((el) => el.innerHTML)}`);
return false;
}
this.copyViewElementsToEAforEditing(res.content);
return true;
}
};
export async function initExcalidrawAutomate(

View File

@@ -1579,15 +1579,15 @@ export const getTransclusion = async (
if (!para) {
return { contents: linkParts.original.trim(), lineNum: 0 };
}
if (["blockquote", "listItem"].includes(para.type)) {
if (["blockquote"].includes(para.type)) {
para = para.children[0];
} //blockquotes are special, they have one child, which has the paragraph
const startPos = para.position.start.offset;
const lineNum = para.position.start.line;
const endPos =
para.children[para.children.length - 1]?.position.start.offset - 1; //alternative: filter((c:any)=>c.type=="blockid")[0]
const endPos = para.position.end.offset; //https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/853
//para.children[para.children.length - 1]?.position.start.offset - 1; //!not clear what the side effect of the #853 change is
return {
contents: contents.substring(startPos, endPos).trim(),
contents: contents.substring(startPos, endPos).replaceAll(/ \^\S*$|^\^\S*$/gm,"").trim(), //remove the block reference from the end of the line, or from the beginning of a new line
lineNum,
};
}
@@ -1638,7 +1638,7 @@ export const getTransclusion = async (
return {
leadingHashes: "#".repeat(depth) + " ",
contents: contents.substring(startPos).trim(),
lineNum
lineNum
};
}
return { contents: linkParts.original.trim(), lineNum: 0 };

View File

@@ -306,7 +306,6 @@ export default class ExcalidrawView extends TextFileView {
if (!this.getScene || !this.file) {
return;
}
//@ts-ignore
if (app.isMobile) {
const prompt = new Prompt(
app,
@@ -651,7 +650,7 @@ export default class ExcalidrawView extends TextFileView {
if (this.toolsPanelRef && this.toolsPanelRef.current) {
this.toolsPanelRef.current.setFullscreen(true);
}
if (app.isMobile) {
if (this.plugin.device.isPhone) {
if(Platform.isIosApp) {
this.restoreMobileLeaves();
app.workspace.getLayout().main.children
@@ -735,7 +734,7 @@ export default class ExcalidrawView extends TextFileView {
if (this.toolsPanelRef && this.toolsPanelRef.current) {
this.toolsPanelRef.current.setFullscreen(false);
}
if (app.isMobile) {
if (this.plugin.device.isPhone) {
this.restoreMobileLeaves();
const oldStylesheet = document.getElementById("excalidraw-full-screen");
if (oldStylesheet) {
@@ -1256,7 +1255,8 @@ export default class ExcalidrawView extends TextFileView {
this.autosaveTimer = setTimeout(
timer,
this.plugin.activeExcalidrawView === this &&
this.semaphores.dirty
this.semaphores.dirty &&
this.plugin.settings.autosave
? 1000 //try again in 1 second
: this.plugin.settings.autosaveInterval,
);
@@ -1266,12 +1266,10 @@ export default class ExcalidrawView extends TextFileView {
clearTimeout(this.autosaveTimer);
this.autosaveTimer = null;
} // clear previous timer if one exists
if (this.plugin.settings.autosave) {
this.autosaveTimer = setTimeout(
timer,
this.plugin.settings.autosaveInterval,
);
}
this.autosaveTimer = setTimeout(
timer,
this.plugin.settings.autosaveInterval,
);
}
//save current drawing when user closes workspace leaf
@@ -1441,7 +1439,7 @@ export default class ExcalidrawView extends TextFileView {
this.previousSceneVersion = 0;
}
private isLoaded: boolean = false;
public isLoaded: boolean = false;
async setViewData(data: string, clear: boolean = false) {
if(this.plugin.settings.showNewVersionNotification) checkExcalidrawVersion(app);
this.isLoaded = false;
@@ -2355,7 +2353,7 @@ export default class ExcalidrawView extends TextFileView {
elements,
commitToHistory: true,
},
false,
true, //set to true because svtToExcalidraw generates a legacy Excalidraw object
true
);
@@ -2784,14 +2782,24 @@ export default class ExcalidrawView extends TextFileView {
libraryReturnUrl: "app://obsidian.md",
autoFocus: true,
onChange: (et: ExcalidrawElement[], st: AppState) => {
const canvasColorChangeHook = () => {
if(this.plugin.ea.onCanvasColorChangeHook) {
this.plugin.ea.onCanvasColorChangeHook(
this.plugin.ea,
this,
st.viewBackgroundColor
)
}
}
viewModeEnabled = st.viewModeEnabled;
if (this.semaphores.justLoaded) {
this.semaphores.justLoaded = false;
if (!this.semaphores.preventAutozoom) {
this.zoomToFit(false);
this.zoomToFit(false,true);
}
this.previousSceneVersion = this.getSceneVersion(et);
this.previousBackgroundColor = st.viewBackgroundColor;
canvasColorChangeHook();
return;
}
if (this.semaphores.dirty) {
@@ -2816,6 +2824,7 @@ export default class ExcalidrawView extends TextFileView {
this.previousSceneVersion = sceneVersion;
this.previousBackgroundColor = st.viewBackgroundColor;
this.setDirty(6);
canvasColorChangeHook();
}
}
},
@@ -2915,6 +2924,7 @@ export default class ExcalidrawView extends TextFileView {
currentPosition.x,
currentPosition.y,
draggable.file,
!event.altKey,
);
ea.addElementsToView(false, false, true);
})();
@@ -2944,6 +2954,7 @@ export default class ExcalidrawView extends TextFileView {
currentPosition.x + counter*50,
currentPosition.y + counter*50,
f,
!event.altKey,
);
counter++;
await ea.addElementsToView(false, false, true);
@@ -3384,13 +3395,17 @@ export default class ExcalidrawView extends TextFileView {
}
}
public zoomToFit(delay: boolean = true) {
public zoomToFit(delay: boolean = true, justLoaded: boolean = false) {
const api = this.excalidrawAPI;
if (!api || !this.excalidrawRef || this.semaphores.isEditingText) {
return;
}
const maxZoom = this.plugin.settings.zoomToFitMaxLevel;
const elements = api.getSceneElements().filter((el:ExcalidrawElement)=>el.width<10000 && el.height<10000);
if((app.isMobile && elements.length>1000) || elements.length>2500) {
if(justLoaded) api.scrollToContent();
return;
}
if (delay) {
//time for the DOM to render, I am sure there is a more elegant solution
setTimeout(

View File

@@ -27,6 +27,7 @@ export const updateEquation = async (
created: data.created,
size: data.size,
hasSVGwithBitmap: false,
shouldScale: true,
});
addFiles(files, view);
}

View File

@@ -0,0 +1,54 @@
import { App, FuzzySuggestModal, TFile } from "obsidian";
import { REG_LINKINDEX_INVALIDCHARS } from "../Constants";
import ExcalidrawView from "../ExcalidrawView";
import { t } from "../lang/helpers";
import ExcalidrawPlugin from "../main";
export class ImportSVGDialog extends FuzzySuggestModal<TFile> {
public app: App;
public plugin: ExcalidrawPlugin;
private view: ExcalidrawView;
constructor(plugin: ExcalidrawPlugin) {
super(plugin.app);
this.plugin = plugin;
this.app = plugin.app;
this.limit = 20;
this.setInstructions([
{
command: t("SELECT_FILE"),
purpose: "",
},
]);
this.setPlaceholder(t("SELECT_DRAWING"));
this.emptyStateText = t("NO_MATCH");
}
getItems(): TFile[] {
return (this.app.vault.getFiles() || []).filter(
(f: TFile) => f.extension === "svg" &&
//https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/422
!f.path.match(REG_LINKINDEX_INVALIDCHARS),
);
}
getItemText(item: TFile): string {
return item.path;
}
async onChooseItem(item: TFile, event: KeyboardEvent): Promise<void> {
if(!item) return;
const ea = this.plugin.ea;
ea.reset();
ea.setView(this.view);
const svg = await app.vault.read(item);
if(!svg || svg === "") return;
ea.importSVG(svg);
ea.addElementsToView(true, true, true);
}
public start(view: ExcalidrawView) {
this.view = view;
this.open();
}
}

View File

@@ -17,12 +17,23 @@ export class InsertImageDialog extends FuzzySuggestModal<TFile> {
this.limit = 20;
this.setInstructions([
{
command: t("SELECT_FILE"),
command: t("SELECT_FILE_WITH_OPTION_TO_SCALE"),
purpose: "",
},
]);
this.setPlaceholder(t("SELECT_DRAWING"));
this.emptyStateText = t("NO_MATCH");
this.inputEl.onkeyup = (e) => {
//@ts-ignore
if (e.key === "Enter" && e.altKey && this.chooser.values) {
this.onChooseItem(
//@ts-ignore
this.chooser.values[this.chooser.selectedItem].item,
new KeyboardEvent("keypress",{altKey: true})
);
this.close();
}
}
}
getItems(): TFile[] {
@@ -39,13 +50,13 @@ export class InsertImageDialog extends FuzzySuggestModal<TFile> {
return item.path;
}
onChooseItem(item: TFile): void {
onChooseItem(item: TFile, event: KeyboardEvent): void {
const ea = this.plugin.ea;
ea.reset();
ea.setView(this.view);
ea.canvas.theme = this.view.excalidrawAPI.getAppState().theme;
(async () => {
await ea.addImage(0, 0, item);
await ea.addImage(0, 0, item, !event.altKey);
ea.addElementsToView(true, false, true);
})();
}

View File

@@ -17,7 +17,44 @@ I develop this plugin as a hobby, spending most of my free time doing this. If y
<div class="ex-coffee-div"><a href="https://ko-fi.com/zsolt"><img src="https://cdn.ko-fi.com/cdn/kofi3.png?v=3" height=45></a></div>
`,
"1.7.23":`
"1.7.26":`## Fixed
- Transcluded block with a parent bullet does not embed sub-bullet [#853](https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/853)
- Transcluded text will now exclude ^block-references at end of lines
- Phantom duplicates of the drawing appear when "zoom to fit" results in a zoom value below 10% and there are many objects on the canvas [#850](https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/850)
- CTRL+Wheel will increase/decrease zoom in steps of 5% matching the behavior of the "+" & "-" zoom buttons.
- Latest updates from Excalidarw.com
- Freedraw flip not scaling correctly [#5752](https://github.com/excalidraw/excalidraw/pull/5752)
- Multiple elements resizing regressions [#5586](https://github.com/excalidraw/excalidraw/pull/5586)
## New - power user features
- Force the embedded image to always scale to 100%. Note: this is a very niche feature with a very particular behavior that I built primarily for myself (even more so than other features in Excalidraw Obsidian - also built primarily for myself 😉)... This will reset your embedded image to 100% size every time you open the Excalidraw drawing, or in case you have embedded an Excalidraw drawing on your canvas inserted using this function, every time you update the embedded drawing, it will be scaled back to 100% size. This means that even if you resize the image on the drawing, it will reset to 100% the next time you open the file or you modify the original embedded object. This feature is useful when you decompose a drawing into separate Excalidraw files, but when combined onto a single canvas you want the individual pieces to maintain their actual sizes. I use this feature to construct Book-on-a-Page summaries from atomic drawings.
- I added an action to the command palette to temporarily disable/enable Excalidraw autosave. When autosave is disabled, Excalidraw will still save your drawing when changing to another Obsidian window, but it will not save every 10 seconds. On a mobile device (but also on a desktop) this can lead to data loss if you terminate Obsidian abruptly (i.e. swipe the application away, or close Obsidian without first closing the drawing). Use this feature if you find Excalidraw laggy.`,
"1.7.25":`## Fixed
- Tool buttons did not "stick" the first time you clicked them.
- Tray (in tray mode) was higher when the help button was visible. The tray in tablet mode was too large and the help button was missing.
- ExcalidrawAutomate ${String.fromCharCode(96)}getCM(color:TInput): ColorMaster;${String.fromCharCode(96)} function will now properly convert valid [css color names](https://www.w3schools.com/colors/colors_names.asp) to ColorMaster objects.
- The downloaded script icons in the Excalidraw-Obsidian menu were not always correct
- The obsidian mobile navigation bar at the bottom overlapped with Excalidraw
## New
- Created ExcalidrawAutomate hook for styling script when the canvas color changes. See sample [onCanvasColorChangeHook](https://gist.github.com/zsviczian/c7223c5b4af30d5c88a0cae05300305c) implementation following the link.
<div class="excalidraw-videoWrapper"><div>
<iframe src="https://www.youtube.com/embed/LtR04fNTKTM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div></div>
${String.fromCharCode(96, 96, 96)}typescript
/**
* If set, this callback is triggered whenever the active canvas color changes
*/
onCanvasColorChangeHook: (
ea: ExcalidrawAutomate,
view: ExcalidrawView, //the Excalidraw view
color: string,
) => void = null;
${String.fromCharCode(96, 96, 96)}
`,
"1.7.24":`
# New and improved
- **Updated Chinese translation**. Thanks, @tswwe!
- **Improved update for TextElement links**: Until now, when you attached a link to a file to a TextElement using the "Create Link" command, this link did not get updated when the file was renamed or moved. Only links created as markdown links in the TextElement text were updated. Now both approaches work. Keep in mind however, that if you have a link in the TextElemenet text, it will override the link attached to the text element using the create link command. [#566](https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/566)

View File

@@ -52,7 +52,8 @@ export default {
INSERT_LINK_TO_ELEMENT_ERROR: "Select a single element in the scene",
INSERT_LINK_TO_ELEMENT_READY: "Link is READY and available on the clipboard",
INSERT_LINK: "Insert link to file",
INSERT_IMAGE: "Insert image from vault",
INSERT_IMAGE: "Insert image or Excalidraw drawing from your vault",
IMPORT_SVG: "Import an SVG file as Excalidraw strokes (limited SVG support, TEXT currently not supported)",
INSERT_MD: "Insert markdown file from vault",
INSERT_LATEX:
"Insert LaTeX formula (e.g. \\binom{n}{k} = \\frac{n!}{k!(n-k)!})",
@@ -61,6 +62,8 @@ export default {
TRAY_MODE: "Toggle property-panel tray-mode",
SEARCH: "Search for text in drawing",
RESET_IMG_TO_100: "Set selected image element size to 100% of original",
TEMPORARY_DISABLE_AUTOSAVE: "Disable autosave until next time Obsidian starts (only set this if you know what you are doing)",
TEMPORARY_ENABLE_AUTOSAVE: "Enable autosave",
//ExcalidrawView.ts
INSTALL_SCRIPT_BUTTON: "Install or update Excalidraw Scripts",
@@ -113,7 +116,7 @@ export default {
"Template.md, the setting would be: Excalidraw/Template.md (or just Excalidraw/Template - you may omit the .md file extension). " +
"If you are using Excalidraw in compatibility mode, then your template must be a legacy Excalidraw file as well " +
"such as Excalidraw/Template.excalidraw.",
SCRIPT_FOLDER_NAME: "Excalidraw Automate script folder",
SCRIPT_FOLDER_NAME: "Excalidraw Automate script folder (CASE SeNSitiVE!)",
SCRIPT_FOLDER_DESC:
"The files you place in this folder will be treated as Excalidraw Automate scripts. " +
"You can access your scripts from Excalidraw via the Obsidian Command Palette. Assign " +
@@ -418,9 +421,10 @@ export default {
//openDrawings.ts
SELECT_FILE: "Select a file then press enter.",
SELECT_FILE_WITH_OPTION_TO_SCALE: "Select a file then press ENTER, or ALT+ENTER to insert at 100% scale.",
NO_MATCH: "No file matches your query.",
SELECT_FILE_TO_LINK: "Select the file you want to insert the link for.",
SELECT_DRAWING: "Select the drawing you want to insert",
SELECT_DRAWING: "Select the image or drawing you want to insert",
TYPE_FILENAME: "Type name of drawing to select.",
SELECT_FILE_OR_TYPE_NEW:
"Select existing drawing or type name of a new drawing then press Enter.",

View File

@@ -58,6 +58,7 @@ import {
import { openDialogAction, OpenFileDialog } from "./dialogs/OpenDrawing";
import { InsertLinkDialog } from "./dialogs/InsertLinkDialog";
import { InsertImageDialog } from "./dialogs/InsertImageDialog";
import { ImportSVGDialog } from "./dialogs/ImportSVGDialog";
import { InsertMDDialog } from "./dialogs/InsertMDDialog";
import {
initExcalidrawAutomate,
@@ -103,6 +104,7 @@ import { decompressFromBase64 } from "lz-string";
import { Packages } from "./types";
import * as React from "react";
import { ScriptInstallPrompt } from "./dialogs/ScriptInstallPrompt";
import { check } from "prettier";
declare module "obsidian" {
@@ -138,6 +140,7 @@ export default class ExcalidrawPlugin extends Plugin {
private openDialog: OpenFileDialog;
public insertLinkDialog: InsertLinkDialog;
public insertImageDialog: InsertImageDialog;
public importSVGDialog: ImportSVGDialog;
public insertMDDialog: InsertMDDialog;
public activeExcalidrawView: ExcalidrawView = null;
public lastActiveExcalidrawFilePath: string = null;
@@ -165,6 +168,17 @@ export default class ExcalidrawPlugin extends Plugin {
private packageMap: WeakMap<Window,Packages> = new WeakMap<Window,Packages>();
public leafChangeTimeout: NodeJS.Timeout = null;
private forceSaveCommand:Command;
public device: {
isDesktop: boolean,
isPhone: boolean,
isTablet: boolean,
isMobile: boolean,
isLinux: boolean,
isMacOS: boolean,
isWindows: boolean,
isIOS: boolean,
isAndroid: boolean
};
constructor(app: App, manifest: PluginManifest) {
super(app, manifest);
@@ -175,8 +189,6 @@ export default class ExcalidrawPlugin extends Plugin {
this.equationsMaster = new Map<FileId, string>();
}
public getPackage(win:Window):Packages {
if(win===window) {
return {react, reactDOM, excalidrawLib};
@@ -196,13 +208,26 @@ export default class ExcalidrawPlugin extends Plugin {
}
async onload() {
this.device = {
isDesktop: !document.body.hasClass("is-tablet") && !document.body.hasClass("is-mobile"),
isPhone: document.body.hasClass("is-phone"),
isTablet: document.body.hasClass("is-tablet"),
isMobile: document.body.hasClass("is-mobile"), //running Obsidian Mobile, need to also check isTablet
isLinux: document.body.hasClass("mod-linux") && ! document.body.hasClass("is-android"),
isMacOS: document.body.hasClass("mod-macos") && ! document.body.hasClass("is-ios"),
isWindows: document.body.hasClass("mod-windows"),
isIOS: document.body.hasClass("is-ios"),
isAndroid: document.body.hasClass("is-android")
}
addIcon(ICON_NAME, EXCALIDRAW_ICON);
addIcon(SCRIPTENGINE_ICON_NAME, SCRIPTENGINE_ICON);
addIcon(DISK_ICON_NAME, DISK_ICON);
addIcon(PNG_ICON_NAME, PNG_ICON);
addIcon(SVG_ICON_NAME, SVG_ICON);
await this.loadSettings();
await this.loadSettings({reEnableAutosave:true});
this.addSettingTab(new ExcalidrawSettingTab(this.app, this));
this.ea = await initExcalidrawAutomate(this);
@@ -689,6 +714,7 @@ export default class ExcalidrawPlugin extends Plugin {
this.openDialog = new OpenFileDialog(this.app, this);
this.insertLinkDialog = new InsertLinkDialog(this.app);
this.insertImageDialog = new InsertImageDialog(this);
this.importSVGDialog = new ImportSVGDialog(this);
this.insertMDDialog = new InsertMDDialog(this);
this.addRibbonIcon(ICON_NAME, t("CREATE_NEW"), async (e) => {
@@ -757,6 +783,28 @@ export default class ExcalidrawPlugin extends Plugin {
),
);
this.addCommand({
id: "excalidraw-disable-autosave",
name: t("TEMPORARY_DISABLE_AUTOSAVE"),
checkCallback: (checking) => {
if(!this.settings.autosave) return false; //already disabled
if(checking) return true;
this.settings.autosave = false;
return true;
}
})
this.addCommand({
id: "excalidraw-enable-autosave",
name: t("TEMPORARY_ENABLE_AUTOSAVE"),
checkCallback: (checking) => {
if(this.settings.autosave) return false; //already enabled
if(checking) return true;
this.settings.autosave = true;
return true;
}
})
this.addCommand({
id: "excalidraw-download-lib",
name: t("DOWNLOAD_LIBRARY"),
@@ -1141,7 +1189,7 @@ export default class ExcalidrawPlugin extends Plugin {
const view = this.app.workspace.getActiveViewOfType(ExcalidrawView);
(async()=>{
const isLeftHanded = this.settings.isLeftHanded;
await this.loadSettings(false);
await this.loadSettings({applyLefthandedMode: false});
this.settings.isLeftHanded = !isLeftHanded;
this.saveSettings();
//not clear why I need to do this. If I don't double apply the stylesheet changes
@@ -1205,6 +1253,22 @@ export default class ExcalidrawPlugin extends Plugin {
},
});
this.addCommand({
id: "import-svg",
name: t("IMPORT_SVG"),
checkCallback: (checking: boolean) => {
if (checking) {
return Boolean(this.app.workspace.getActiveViewOfType(ExcalidrawView))
}
const view = this.app.workspace.getActiveViewOfType(ExcalidrawView);
if (view) {
this.importSVGDialog.start(view);
return true;
}
return false;
},
});
this.addCommand({
id: "release-notes",
name: t("READ_RELEASE_NOTES"),
@@ -1634,7 +1698,7 @@ export default class ExcalidrawPlugin extends Plugin {
const activeLeafChangeEventHandler = async (leaf: WorkspaceLeaf) => {
//https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/723
if(self.leafChangeTimeout) {
clearTimeout(this.leafChangeTimeout);
clearTimeout(self.leafChangeTimeout);
}
self.leafChangeTimeout = setTimeout(()=>{self.leafChangeTimeout = null;},1000);
@@ -1647,6 +1711,25 @@ export default class ExcalidrawPlugin extends Plugin {
self.lastActiveExcalidrawFilePath = newActiveviewEV.file?.path;
}
//!Temporary hack
//https://discord.com/channels/686053708261228577/817515900349448202/1031101635784613968
if (app.isMobile && newActiveviewEV && !previouslyActiveEV) {
const navbar = document.querySelector("body>.app-container>.mobile-navbar");
if(navbar && navbar instanceof HTMLDivElement) {
navbar.style.position="relative";
}
}
if (app.isMobile && !newActiveviewEV && previouslyActiveEV) {
const navbar = document.querySelector("body>.app-container>.mobile-navbar");
if(navbar && navbar instanceof HTMLDivElement) {
navbar.style.position="";
}
}
//----------------------
//----------------------
if (previouslyActiveEV && previouslyActiveEV !== newActiveviewEV) {
if (previouslyActiveEV.leaf !== leaf) {
//if loading new view to same leaf then don't save. Excalidarw view will take care of saving anyway.
@@ -1684,20 +1767,32 @@ export default class ExcalidrawPlugin extends Plugin {
} //refresh embedded files
}
if ( //@ts-ignore
newActiveviewEV && newActiveviewEV._loaded &&
newActiveviewEV.isLoaded && newActiveviewEV.excalidrawAPI &&
self.ea.onCanvasColorChangeHook
) {
self.ea.onCanvasColorChangeHook(
self.ea,
newActiveviewEV,
newActiveviewEV.excalidrawAPI.getAppState().viewBackgroundColor
);
}
//https://github.com/zsviczian/obsidian-excalidraw-plugin/issues/300
if (self.popScope) {
self.popScope();
self.popScope = null;
}
if (newActiveviewEV) {
const scope = this.app.keymap.getRootScope();
const scope = self.app.keymap.getRootScope();
const handler = scope.register(["Mod"], "Enter", () => true);
const overridSaveShortcut = (
this.forceSaveCommand &&
this.forceSaveCommand.hotkeys[0].key === "s" &&
this.forceSaveCommand.hotkeys[0].modifiers.includes("Ctrl")
self.forceSaveCommand &&
self.forceSaveCommand.hotkeys[0].key === "s" &&
self.forceSaveCommand.hotkeys[0].modifiers.includes("Ctrl")
)
const self = this;
const saveHandler = overridSaveShortcut
? scope.register(["Ctrl"], "s", () => self.forceSaveActiveView(false))
: undefined;
@@ -1948,10 +2043,16 @@ export default class ExcalidrawPlugin extends Plugin {
}
}
public async loadSettings(applyLefthandedMode:boolean = true) {
public async loadSettings(opts: {
applyLefthandedMode?: boolean,
reEnableAutosave?: boolean
} = {applyLefthandedMode: true, reEnableAutosave: false}
) {
if(typeof opts.applyLefthandedMode === "undefined") opts.applyLefthandedMode = true;
if(typeof opts.reEnableAutosave === "undefined") opts.reEnableAutosave = false;
this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
if(applyLefthandedMode) setLeftHandedMode(this.settings.isLeftHanded);
this.settings.autosave = true;
if(opts.applyLefthandedMode) setLeftHandedMode(this.settings.isLeftHanded);
if(opts.reEnableAutosave) this.settings.autosave = true;
this.settings.autosaveInterval = app.isMobile?10000:15000; //more frequent on mobile because Obsidian may be killed on context switching
}

File diff suppressed because one or more lines are too long

View File

@@ -2,7 +2,7 @@ import clsx from "clsx";
import { Notice, TFile } from "obsidian";
import * as React from "react";
import { ActionButton } from "./ActionButton";
import { ICONS } from "./ActionIcons";
import { ICONS, stringToSVG } from "./ActionIcons";
import { SCRIPT_INSTALL_FOLDER, CTRL_OR_CMD } from "../Constants";
import { insertLaTeXToView, search } from "../ExcalidrawAutomate";
import ExcalidrawView, { TextMode } from "../ExcalidrawView";
@@ -257,6 +257,7 @@ export class ToolsPanel extends React.Component<PanelProps, PanelState> {
className="Island App-menu__left scrollbar"
style={{
maxHeight: "350px",
backgroundColor: "transparent",
//@ts-ignore
"--padding": 2,
display: this.state.minimized ? "none" : "block",
@@ -472,6 +473,15 @@ export class ToolsPanel extends React.Component<PanelProps, PanelState> {
icon={ICONS.copyElementLink}
view={this.props.view}
/>
<ActionButton
key={"import-svg"}
title={t("IMPORT_SVG")}
action={(e:React.MouseEvent<HTMLButtonElement, MouseEvent>) => {
this.props.view.plugin.importSVGDialog.start(this.props.view);
}}
icon={ICONS.importSVG}
view={this.props.view}
/>
</div>
</fieldset>
{this.renderScriptButtons(false)}
@@ -532,21 +542,9 @@ export class ToolsPanel extends React.Component<PanelProps, PanelState> {
}
}}
icon={
this.state.scriptIconMap[key].svgString ? (
<img
src={`data:image/svg+xml,${encodeURIComponent(
this.state.theme === "dark"
? this.state.scriptIconMap[key].svgString.replace(
"<svg ",
dark,
)
: this.state.scriptIconMap[key].svgString.replace(
"<svg ",
light,
),
)}`}
/>
) : (
this.state.scriptIconMap[key].svgString
? stringToSVG(this.state.scriptIconMap[key].svgString)
: (
ICONS.cog
)
}

View File

@@ -16,6 +16,7 @@ import {
getEmbedFilename,
} from "./utils/FileUtils";
import {
fragWithHTML,
setLeftHandedMode,
} from "./utils/Utils";
@@ -198,9 +199,6 @@ export const DEFAULT_SETTINGS: ExcalidrawSettings = {
mathjaxSourceURL: "https://cdn.jsdelivr.net/npm/mathjax@3.2.1/es5/tex-svg.js"
};
const fragWithHTML = (html: string) =>
createFragment((frag) => (frag.createDiv().innerHTML = html));
export class ExcalidrawSettingTab extends PluginSettingTab {
plugin: ExcalidrawPlugin;
private requestEmbedUpdate: boolean = false;

View File

@@ -0,0 +1,133 @@
import chroma from "chroma-js";
import { ExcalidrawElementBase } from "./elements/ExcalidrawElement";
export function hexWithAlpha(color: string, alpha: number): string {
return chroma(color).alpha(alpha).css();
}
export function has(el: Element, attr: string): boolean {
return el.hasAttribute(attr);
}
export function get(el: Element, attr: string, backup?: string): string {
return el.getAttribute(attr) || backup || "";
}
export function getNum(el: Element, attr: string, backup?: number): number {
const numVal = Number(get(el, attr));
return numVal === NaN ? backup || 0 : numVal;
}
const presAttrs = {
stroke: "stroke",
"stroke-opacity": "stroke-opacity",
"stroke-width": "stroke-width",
fill: "fill",
"fill-opacity": "fill-opacity",
opacity: "opacity",
} as const;
type ExPartialElement = Partial<ExcalidrawElementBase>;
type AttrHandlerArgs = {
el: Element;
exVals: ExPartialElement;
};
type PresAttrHandlers = {
[key in keyof typeof presAttrs]: (args: AttrHandlerArgs) => void;
};
const attrHandlers: PresAttrHandlers = {
stroke: ({ el, exVals }) => {
const strokeColor = get(el, "stroke");
exVals.strokeColor = has(el, "stroke-opacity")
? hexWithAlpha(strokeColor, getNum(el, "stroke-opacity"))
: strokeColor;
},
"stroke-opacity": ({ el, exVals }) => {
exVals.strokeColor = hexWithAlpha(
get(el, "stroke", "#000000"),
getNum(el, "stroke-opacity"),
);
},
"stroke-width": ({ el, exVals }) => {
exVals.strokeWidth = getNum(el, "stroke-width");
},
fill: ({ el, exVals }) => {
const fill = get(el, `fill`);
exVals.backgroundColor = fill === "none" ? "#00000000" : fill;
},
"fill-opacity": ({ el, exVals }) => {
exVals.backgroundColor = hexWithAlpha(
get(el, "fill", "#000000"),
getNum(el, "fill-opacity"),
);
},
opacity: ({ el, exVals }) => {
exVals.opacity = getNum(el, "opacity", 100);
},
};
// Presentation Attributes for SVG Elements:
// https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/Presentation
export function presAttrsToElementValues(
el: Element,
): Partial<ExcalidrawElementBase> {
const exVals = [...el.attributes].reduce((exVals, attr) => {
const name = attr.name;
if (Object.keys(attrHandlers).includes(name)) {
attrHandlers[name as keyof PresAttrHandlers]({ el, exVals });
}
return exVals;
}, {} as ExPartialElement);
return exVals;
}
type FilterAttrs = Partial<
Pick<ExcalidrawElementBase, "x" | "y" | "width" | "height">
>;
export function filterAttrsToElementValues(el: Element): FilterAttrs {
const filterVals: FilterAttrs = {};
if (has(el, "x")) {
filterVals.x = getNum(el, "x");
}
if (has(el, "y")) {
filterVals.y = getNum(el, "y");
}
if (has(el, "width")) {
filterVals.width = getNum(el, "width");
}
if (has(el, "height")) {
filterVals.height = getNum(el, "height");
}
return filterVals;
}
export function pointsAttrToPoints(el: Element): number[][] {
let points: number[][] = [];
if (has(el, "points")) {
points = get(el, "points")
.split(" ")
.map((p) => p.split(",").map(parseFloat));
}
return points;
}

View File

@@ -0,0 +1,117 @@
import { randomId, randomInteger } from "../utils";
import { ExcalidrawLinearElement, FillStyle, GroupId, StrokeSharpness, StrokeStyle } from "@zsviczian/excalidraw/types/element/types";
export type Point = [number, number];
export type ExcalidrawElementBase = {
id: string;
x: number;
y: number;
strokeColor: string;
backgroundColor: string;
fillStyle: FillStyle;
strokeWidth: number;
strokeStyle: StrokeStyle;
strokeSharpness: StrokeSharpness;
roughness: number;
opacity: number;
width: number;
height: number;
angle: number;
/** Random integer used to seed shape generation so that the roughjs shape
doesn't differ across renders. */
seed: number;
/** Integer that is sequentially incremented on each change. Used to reconcile
elements during collaboration or when saving to server. */
version: number;
/** Random integer that is regenerated on each change.
Used for deterministic reconciliation of updates during collaboration,
in case the versions (see above) are identical. */
versionNonce: number;
isDeleted: boolean;
/** List of groups the element belongs to.
Ordered from deepest to shallowest. */
groupIds: GroupId[];
/** Ids of (linear) elements that are bound to this element. */
boundElementIds: ExcalidrawLinearElement["id"][] | null;
};
export type ExcalidrawRectangle = ExcalidrawElementBase & {
type: "rectangle";
};
export type ExcalidrawLine = ExcalidrawElementBase & {
type: "line";
points: readonly Point[];
};
export type ExcalidrawEllipse = ExcalidrawElementBase & {
type: "ellipse";
};
export type ExcalidrawGenericElement =
| ExcalidrawRectangle
| ExcalidrawEllipse
| ExcalidrawLine
| ExcalidrawDraw;
export type ExcalidrawDraw = ExcalidrawElementBase & {
type: "line";
points: readonly Point[];
};
export function createExElement(): ExcalidrawElementBase {
return {
id: randomId(),
x: 0,
y: 0,
strokeColor: "#000000",
backgroundColor: "#000000",
fillStyle: "solid",
strokeWidth: 1,
strokeStyle: "solid",
strokeSharpness: "sharp",
roughness: 0,
opacity: 100,
width: 0,
height: 0,
angle: 0,
seed: randomInteger(),
version: 0,
versionNonce: 0,
isDeleted: false,
groupIds: [],
boundElementIds: null,
};
}
export function createExRect(): ExcalidrawRectangle {
return {
...createExElement(),
type: "rectangle",
};
}
export function createExLine(): ExcalidrawLine {
return {
...createExElement(),
type: "line",
points: [],
};
}
export function createExEllipse(): ExcalidrawEllipse {
return {
...createExElement(),
type: "ellipse",
};
}
export function createExDraw(): ExcalidrawDraw {
return {
...createExElement(),
type: "line",
points: [],
};
}

View File

@@ -0,0 +1,21 @@
import { ExcalidrawGenericElement } from "./ExcalidrawElement";
class ExcalidrawScene {
type = "excalidraw";
version = 2;
source = "https://excalidraw.com";
elements: ExcalidrawGenericElement[] = [];
constructor(elements:any = []) {
this.elements = elements;
}
toExJSON(): any {
return {
...this,
elements: this.elements.map((el) => ({ ...el })),
};
}
}
export default ExcalidrawScene;

View File

@@ -0,0 +1,23 @@
import { randomId } from "../utils";
import { presAttrsToElementValues } from "../attributes";
import { ExcalidrawElementBase } from "../elements/ExcalidrawElement";
export function getGroupAttrs(groups: Group[]): any {
return groups.reduce((acc, { element }) => {
const elVals = presAttrsToElementValues(element);
return { ...acc, ...elVals };
}, {} as Partial<ExcalidrawElementBase>);
}
class Group {
id = randomId();
element: Element;
constructor(element: Element) {
this.element = element;
}
}
export default Group;

View File

@@ -0,0 +1,5 @@
import * as path from "./path";
export default {
path,
};

View File

@@ -0,0 +1,35 @@
import { RawElement } from "../../types";
import { getElementBoundaries } from "../utils";
import pathToPoints from "./utils/path-to-points";
const parse = (node: Element) => {
const data = node.getAttribute("d");
const backgroundColor = node.getAttribute("fill");
const strokeColor = node.getAttribute("stroke");
return {
data: data || "",
backgroundColor:
(backgroundColor !== "currentColor" && backgroundColor) || "transparent",
strokeColor: (strokeColor !== "currentColor" && strokeColor) || "#000000",
};
};
export const convert = (node: Element): RawElement[] => {
const { data, backgroundColor, strokeColor } = parse(node);
const elementsPoints = pathToPoints(data);
return elementsPoints.map((points) => {
const boundaries = getElementBoundaries(points);
return {
type: "line",
roughness: 0,
strokeSharpness: "sharp",
points,
backgroundColor,
strokeColor,
...boundaries,
};
});
};

View File

@@ -0,0 +1,66 @@
import { safeNumber } from "../../../utils";
/**
* Get a point at a given section of a cubic bezier curve.
* This function only supports two dimensions curves
* @see https://en.wikipedia.org/wiki/B%C3%A9zier_curve#Cubic_B%C3%A9zier_curves
*/
const getPointOfCubicCurve = (
controlPoints: number[][],
section: number,
): number[] =>
Array.from({ length: 2 }).map((v, i) => {
const point =
controlPoints[0][i] * (1 - section) ** 3 +
3 * controlPoints[1][i] * section * (1 - section) ** 2 +
3 * controlPoints[2][i] * section ** 2 * (1 - section) +
controlPoints[3][i] * section ** 3;
return safeNumber(point);
});
/**
* Get a point at a given section of a quadratic bezier curve.
* This function only supports two dimensions curves
* @see https://en.wikipedia.org/wiki/B%C3%A9zier_curve#Quadratic_B%C3%A9zier_curves
*/
const getPointOfQuadraticCurve = (
controlPoints: number[][],
section: number,
): number[] =>
Array.from({ length: 2 }).map((v, i) => {
const point =
controlPoints[0][i] * (1 - section) ** 2 +
2 * controlPoints[1][i] * section * (1 - section) +
controlPoints[2][i] * section ** 2;
return safeNumber(point);
});
/**
* Get list of points for a cubic bézier curve.
* Starting point is not returned
*/
export const curveToPoints = (
type: "cubic" | "quadratic",
controlPoints: number[][],
nbPoints = 10,
): number[][] => {
if (nbPoints <= 0) {
throw new Error("Requested amount of points must be positive");
} else if (nbPoints > 100) {
nbPoints = 100;
}
return Array.from({ length: nbPoints }, (value, index) => {
const section = safeNumber(((100 / nbPoints) * (index + 1)) / 100);
if (type === "cubic") {
return getPointOfCubicCurve(controlPoints, section);
} else if (type === "quadratic") {
return getPointOfQuadraticCurve(controlPoints, section);
}
throw new Error("Invalid bézier curve type requested");
});
};

View File

@@ -0,0 +1,133 @@
const degreeToRadian = (degree: number): number => (degree * Math.PI) / 180;
/**
* Get each possible ellipses center points given two points and ellipse radius
* @see https://math.stackexchange.com/questions/2240031/solving-an-equation-for-an-ellipse
*/
export const getEllipsesCenter = (
curX: number,
curY: number,
destX: number,
destY: number,
radiusX: number,
radiusY: number,
): number[][] => [
[
(curX + destX) / 2 +
((radiusX * (curY - destY)) / (2 * radiusY)) *
Math.sqrt(
4 /
((curX - destX) ** 2 / radiusX ** 2 +
(curY - destY) ** 2 / radiusY ** 2) -
1,
),
(curY + destY) / 2 -
((radiusY * (curX - destX)) / (2 * radiusX)) *
Math.sqrt(
4 /
((curX - destX) ** 2 / radiusX ** 2 +
(curY - destY) ** 2 / radiusY ** 2) -
1,
),
],
[
(curX + destX) / 2 -
((radiusX * (curY - destY)) / (2 * radiusY)) *
Math.sqrt(
4 /
((curX - destX) ** 2 / radiusX ** 2 +
(curY - destY) ** 2 / radiusY ** 2) -
1,
),
(curY + destY) / 2 +
((radiusY * (curX - destX)) / (2 * radiusX)) *
Math.sqrt(
4 /
((curX - destX) ** 2 / radiusX ** 2 +
(curY - destY) ** 2 / radiusY ** 2) -
1,
),
],
];
/**
* Get point of ellipse at given degree
*/
const getPointAtDegree = (
centerX: number,
centerY: number,
radiusX: number,
radiusY: number,
degree: number,
): number[] => [
Math.round(radiusX * Math.cos(degreeToRadian(degree)) + centerX),
Math.round(radiusY * Math.sin(degreeToRadian(degree)) + centerY),
];
/**
* Get all points of a given ellipse
*/
export const getEllipsePoints = (
centerX: number,
centerY: number,
radiusX: number,
radiusY: number,
): number[][] => {
const points: number[][] = [];
for (let i = 0; i < 360; i += 1) {
const pointAtDegree = getPointAtDegree(
centerX,
centerY,
radiusX,
radiusY,
i,
);
const existingPoint = points.find(
([x, y]) => x === pointAtDegree[0] && y === pointAtDegree[1],
);
if (!existingPoint) {
points.push(pointAtDegree);
}
}
return points;
};
/**
* Find ellipse arc given sweep parameter
*/
export const findArc = (
points: number[][],
sweep: boolean,
curX: number,
curY: number,
destX: number,
destY: number,
): number[][] => {
const indexCur = points.findIndex(
([x, y]) => x === Math.round(curX) && y === Math.round(curY),
);
const indexDest = points.findIndex(
([x, y]) => x === Math.round(destX) && y === Math.round(destY),
);
const arc = [];
const step = sweep ? -1 : 1;
for (let i = indexDest; true; i += step) {
arc.push(points[i]);
if (i === indexCur) {
break;
}
if (sweep && i === 0) {
i = points.length;
} else if (!sweep && i === points.length - 1) {
i = -1;
}
}
return arc.reverse();
};

View File

@@ -0,0 +1,313 @@
import { PathCommand } from "../../../types";
import { safeNumber } from "../../../utils";
import { curveToPoints } from "./bezier";
import { findArc, getEllipsePoints, getEllipsesCenter } from "./ellipse";
const PATH_COMMANDS_REGEX =
/(?:([HhVv] *-?\d*(?:\.\d+)?)|([MmLlTt](?: *-?\d*(?:\.\d+)?(?:,| *)?){2})|([Cc](?: *-?\d*(?:\.\d+)?(?:,| *)?){6})|([QqSs](?: *-?\d*(?:\.\d+)?(?:,| *)?){4})|([Aa](?: *-?\d*(?:\.\d+)?(?:,| *)?){7})|(z|Z))/g;
const COMMAND_REGEX = /(?:[MmLlHhVvCcSsQqTtAaZz]|(-?\d+(?:\.\d+)?))/g;
const handleMoveToAndLineTo = (
currentPosition: number[],
parameters: number[],
isRelative: boolean,
): number[] => {
if (isRelative) {
return [
currentPosition[0] + parameters[0],
currentPosition[1] + parameters[1],
];
}
return parameters;
};
const handleHorizontalLineTo = (
currentPosition: number[],
x: number,
isRelative: boolean,
): number[] => {
if (isRelative) {
return [currentPosition[0] + x, currentPosition[1]];
}
return [x, currentPosition[1]];
};
const handleVerticalLineTo = (
currentPosition: number[],
y: number,
isRelative: boolean,
): number[] => {
if (isRelative) {
return [currentPosition[0], currentPosition[1] + y];
}
return [currentPosition[0], y];
};
const handleCubicCurveTo = (
currentPosition: number[],
parameters: number[],
lastCommand: PathCommand,
isSimpleForm: boolean,
isRelative: boolean,
): number[][] => {
const controlPoints = [currentPosition];
let inferredControlPoint;
if (isSimpleForm) {
inferredControlPoint = ["C", "c"].includes(lastCommand?.type)
? [
currentPosition[0] - (lastCommand.parameters[2] - currentPosition[0]),
currentPosition[1] - (lastCommand.parameters[3] - currentPosition[1]),
]
: currentPosition;
}
if (isRelative) {
controlPoints.push(
inferredControlPoint || [
currentPosition[0] + parameters[0],
currentPosition[1] + parameters[1],
],
[currentPosition[0] + parameters[2], currentPosition[1] + parameters[3]],
[currentPosition[0] + parameters[4], currentPosition[1] + parameters[5]],
);
} else {
controlPoints.push(
inferredControlPoint || [parameters[0], parameters[1]],
[parameters[2], parameters[3]],
[parameters[4], parameters[5]],
);
}
return curveToPoints("cubic", controlPoints);
};
const handleQuadraticCurveTo = (
currentPosition: number[],
parameters: number[],
lastCommand: PathCommand,
isSimpleForm: boolean,
isRelative: boolean,
): number[][] => {
const controlPoints = [currentPosition];
let inferredControlPoint;
if (isSimpleForm) {
inferredControlPoint = ["Q", "q"].includes(lastCommand?.type)
? [
currentPosition[0] - (lastCommand.parameters[0] - currentPosition[0]),
currentPosition[1] - (lastCommand.parameters[1] - currentPosition[1]),
]
: currentPosition;
}
if (isRelative) {
controlPoints.push(
inferredControlPoint || [
currentPosition[0] + parameters[0],
currentPosition[1] + parameters[1],
],
[currentPosition[0] + parameters[2], currentPosition[1] + parameters[3]],
);
} else {
controlPoints.push(inferredControlPoint || [parameters[0], parameters[1]], [
parameters[2],
parameters[3],
]);
}
return curveToPoints("quadratic", controlPoints);
};
/**
* @todo handle arcs rotation
* @todo handle specific cases where only one ellipse can exist
*/
const handleArcTo = (
currentPosition: number[],
[radiusX, radiusY, , large, sweep, destX, destY]: number[],
isRelative: boolean,
): number[][] => {
destX = isRelative ? currentPosition[0] + destX : destX;
destY = isRelative ? currentPosition[1] + destY : destY;
const ellipsesCenter = getEllipsesCenter(
currentPosition[0],
currentPosition[1],
destX,
destY,
radiusX,
radiusY,
);
const ellipsesPoints = [
getEllipsePoints(
ellipsesCenter[0][0],
ellipsesCenter[0][1],
radiusX,
radiusY,
),
getEllipsePoints(
ellipsesCenter[1][0],
ellipsesCenter[1][1],
radiusX,
radiusY,
),
];
const arcs = [
findArc(
ellipsesPoints[0],
!!sweep,
currentPosition[0],
currentPosition[1],
destX,
destY,
),
findArc(
ellipsesPoints[1],
!!sweep,
currentPosition[0],
currentPosition[1],
destX,
destY,
),
];
const finalArc = arcs.reduce(
(arc, curArc) =>
(large && curArc.length > arc.length) ||
(!large && (!arc.length || curArc.length < arc.length))
? curArc
: arc,
[],
);
return finalArc;
};
/**
* Convert a SVG path data to list of points
*/
const pathToPoints = (path: string): number[][][] => {
const commands = path.match(PATH_COMMANDS_REGEX);
const elements = [];
const commandsHistory = [];
let currentPosition = [0, 0];
let points = [];
if (!commands?.length) {
throw new Error("No commands found in given path");
}
for (const command of commands) {
const lastCommand = commandsHistory[commandsHistory.length - 2];
const commandMatch = command.match(COMMAND_REGEX);
currentPosition = points[points.length - 1] || currentPosition;
if (commandMatch?.length) {
const commandType = commandMatch[0];
const parameters = commandMatch
.slice(1, commandMatch.length)
.map((parameter) => safeNumber(Number(parameter)));
const isRelative = commandType.toLowerCase() === commandType;
commandsHistory.push({
type: commandType,
parameters,
isRelative,
});
switch (commandType) {
case "M":
case "m":
case "L":
case "l":
points.push(
handleMoveToAndLineTo(currentPosition, parameters, isRelative),
);
break;
case "H":
case "h":
points.push(
handleHorizontalLineTo(currentPosition, parameters[0], isRelative),
);
break;
case "V":
case "v":
points.push(
handleVerticalLineTo(currentPosition, parameters[0], isRelative),
);
break;
case "C":
case "c":
case "S":
case "s":
points.push(
...handleCubicCurveTo(
currentPosition,
parameters,
lastCommand,
["S", "s"].includes(commandType),
isRelative,
),
);
break;
case "Q":
case "q":
case "T":
case "t":
points.push(
...handleQuadraticCurveTo(
currentPosition,
parameters,
lastCommand,
["T", "t"].includes(commandType),
isRelative,
),
);
break;
case "A":
case "a":
points.push(...handleArcTo(currentPosition, parameters, isRelative));
break;
case "Z":
case "z":
if (points.length) {
if (
currentPosition[0] !== points[0][0] ||
currentPosition[1] !== points[0][1]
) {
points.push(points[0]);
}
elements.push(points);
}
points = [];
break;
}
} else {
// console.error("Unsupported command provided will be ignored:", command);
}
}
if (elements.length === 0 && points.length) {
elements.push(points);
}
return elements;
};
export default pathToPoints;

View File

@@ -0,0 +1,39 @@
import { ElementBoundaries } from "../types";
export const getElementBoundaries = (points: number[][]): ElementBoundaries => {
const { x, y } = points.reduce(
(boundaries, [x, y]) => {
if (x < boundaries.x.min) {
boundaries.x.min = x;
}
if (x > boundaries.x.max) {
boundaries.x.max = x;
}
if (y < boundaries.y.min) {
boundaries.y.min = y;
}
if (y > boundaries.y.max) {
boundaries.y.max = y;
}
return boundaries;
},
{
x: {
min: Infinity,
max: 0,
},
y: {
min: Infinity,
max: 0,
},
},
);
return {
x: x.min,
y: y.min,
width: x.max - x.min,
height: y.max - y.min,
};
};

View File

@@ -0,0 +1,40 @@
import ExcalidrawScene from "./elements/ExcalidrawScene";
import Group from "./elements/Group";
import { createTreeWalker, walk } from "./walker";
export type ConversionResult = {
hasErrors: boolean;
errors: NodeListOf<Element> | null;
content: any; // Serialized Excalidraw JSON
};
export const svgToExcalidraw = (svgString: string): ConversionResult => {
const parser = new DOMParser();
const svgDOM = parser.parseFromString(svgString, "image/svg+xml");
// was there a parsing error?
const errorsElements = svgDOM.querySelectorAll("parsererror");
const hasErrors = errorsElements.length > 0;
let content = null;
if (hasErrors) {
console.error(
"There were errors while parsing the given SVG: ",
[...errorsElements].map((el) => el.innerHTML),
);
} else {
const tw = createTreeWalker(svgDOM);
const scene = new ExcalidrawScene();
const groups: Group[] = [];
walk({ tw, scene, groups, root: svgDOM }, tw.nextNode());
content = scene.elements; //scene.toExJSON();
}
return {
hasErrors,
errors: hasErrors ? errorsElements : null,
content,
};
};

View File

@@ -0,0 +1,2 @@
Original source https://github.com/excalidraw/svg-to-excalidraw. Last commit: https://github.com/excalidraw/svg-to-excalidraw/commit/6f6e4b7269c4194b56cf7517a8357ba73be12a3a
Embedded into the project instead of using an import because compiled file size difference (smaller this way). Also the svg-to-excalidraw package has not been maintained for over a year, thus I don't expect to miss out on frequent updates

View File

@@ -0,0 +1,173 @@
import Group from "./elements/Group";
import { vec3, mat4 } from "gl-matrix";
/*
SVG transform attr is a bit strange in that it can accept traditional
css transform string (at least per spec) as well as a it's own "unitless"
version of transform functions.
https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/transform
*/
const transformFunctions = {
matrix: "matrix",
matrix3d: "matrix3d",
perspective: "perspective",
rotate: "rotate",
rotate3d: "rotate3d",
rotateX: "rotateX",
rotateY: "rotateY",
rotateZ: "rotateZ",
scale: "scale",
scale3d: "scale3d",
scaleX: "scaleX",
scaleY: "scaleY",
scaleZ: "scaleZ",
skew: "skew",
skewX: "skewX",
skewY: "skewY",
translate: "translate",
translate3d: "translate3d",
translateX: "translateX",
translateY: "translateY",
translateZ: "translateZ",
} as const;
const transformFunctionsArr = Object.keys(transformFunctions);
// type Transform
type TransformFuncValue = {
value: string;
unit: string;
};
type TransformFunc = {
type: keyof typeof transformFunctions;
values: TransformFuncValue[];
};
const defaultUnits = {
matrix: "",
matrix3d: "",
perspective: "perspective",
rotate: "deg",
rotate3d: "deg",
rotateX: "deg",
rotateY: "deg",
rotateZ: "deg",
scale: "",
scale3d: "",
scaleX: "",
scaleY: "",
scaleZ: "",
skew: "skew",
skewX: "deg",
skewY: "deg",
translate: "px",
translate3d: "px",
translateX: "px",
translateY: "px",
translateZ: "px",
};
// Convert between possible svg transform attribute values to css transform attribute values.
const svgTransformToCSSTransform = (svgTransformStr: string): string => {
// Create transform function string "chunks", e.g "rotate(90deg)"
const tFuncs = svgTransformStr.match(/(\w+)\(([^)]*)\)/g);
if (!tFuncs) {
return "";
}
const tFuncValues: TransformFunc[] = tFuncs.map((tFuncStr): TransformFunc => {
const type = tFuncStr.split("(")[0] as keyof typeof transformFunctions;
if (!type) {
throw new Error("Unable to find transform name");
}
if (!transformFunctionsArr.includes(type)) {
throw new Error(`transform function name "${type}" is not valid`);
}
// get the arg/props of the transform function, e.g "90deg".
const tFuncParts = tFuncStr.match(/([-+]?[0-9]*\.?[0-9]+)([a-z])*/g);
if (!tFuncParts) {
return { type, values: [] };
}
let values = tFuncParts.map((a): TransformFuncValue => {
// Separate the arg value and unit. e.g ["90", "deg"]
const [value, unit] = a.matchAll(/([-+]?[0-9]*\.?[0-9]+)|([a-z])*/g);
return {
unit: unit[0] || defaultUnits[type],
value: value[0],
};
});
// Not supporting x, y args of svg rotate transform yet...
if (values && type === "rotate" && values?.length > 1) {
values = [values[0]];
}
return {
type,
values,
};
});
// Generate a string of transform functions that can be set as a CSS Transform.
const csstransformStr = tFuncValues
.map(({ type, values }) => {
const valStr = values
.map(({ unit, value }) => `${value}${unit}`)
.join(", ");
return `${type}(${valStr})`;
})
.join(" ");
return csstransformStr;
};
export const createDOMMatrixFromSVGStr = (
svgTransformStr: string,
): DOMMatrix => {
const cssTransformStr = svgTransformToCSSTransform(svgTransformStr);
return new DOMMatrix(cssTransformStr);
};
export function getElementMatrix(el: Element): mat4 {
if (el.hasAttribute("transform")) {
const elMat = new DOMMatrix(
svgTransformToCSSTransform(el.getAttribute("transform") || ""),
);
return mat4.multiply(mat4.create(), mat4.create(), elMat.toFloat32Array());
}
return mat4.create();
}
export function getTransformMatrix(el: Element, groups: Group[]): mat4 {
const accumMat = groups
.map(({ element }) => getElementMatrix(element))
.concat([getElementMatrix(el)])
.reduce((acc, mat) => mat4.multiply(acc, acc, mat), mat4.create());
return accumMat;
}
export function transformPoints(
points: number[][],
transform: mat4,
): [number, number][] {
return points.map(([x, y]) => {
const [newX, newY] = vec3.transformMat4(
vec3.create(),
vec3.fromValues(x, y, 1),
transform,
);
return [newX, newY];
});
}

View File

@@ -0,0 +1,118 @@
import { ExcalidrawElement, ExcalidrawLinearElement, ExcalidrawTextElement, FillStyle, GroupId, StrokeSharpness, StrokeStyle } from "@zsviczian/excalidraw/types/element/types";
export type PathCommand = {
type: string;
parameters: number[];
isRelative: boolean;
};
export type RawElement = {
type: string;
x: number;
y: number;
width: number;
height: number;
points: number[][];
backgroundColor: string;
strokeColor: string;
};
export type ElementBoundaries = {
x: number;
y: number;
height: number;
width: number;
};
/* from Excalidraw codebase */
// 1-based in case we ever do `if(element.fontFamily)`
export const FONT_FAMILY = {
1: "Virgil",
2: "Helvetica",
3: "Cascadia",
} as const;
export declare type RoughPoint = [number, number];
export type Point = Readonly<RoughPoint>;
export declare type Line = [Point, Point];
export interface Rectangle {
x: number;
y: number;
width: number;
height: number;
}
type _ExcalidrawElementBase = Readonly<{
id: string;
x: number;
y: number;
strokeColor: string;
backgroundColor: string;
fillStyle: FillStyle;
strokeWidth: number;
strokeStyle: StrokeStyle;
strokeSharpness: StrokeSharpness;
roughness: number;
opacity: number;
width: number;
height: number;
angle: number;
/** Random integer used to seed shape generation so that the roughjs shape
doesn't differ across renders. */
seed: number;
/** Integer that is sequentially incremented on each change. Used to reconcile
elements during collaboration or when saving to server. */
version: number;
/** Random integer that is regenerated on each change.
Used for deterministic reconciliation of updates during collaboration,
in case the versions (see above) are identical. */
versionNonce: number;
isDeleted: boolean;
/** List of groups the element belongs to.
Ordered from deepest to shallowest. */
groupIds: readonly GroupId[];
/** Ids of (linear) elements that are bound to this element. */
boundElementIds: readonly ExcalidrawLinearElement["id"][] | null;
}>;
export type ExcalidrawSelectionElement = _ExcalidrawElementBase & {
type: "selection";
};
export type ExcalidrawRectangleElement = _ExcalidrawElementBase & {
type: "rectangle";
};
export type ExcalidrawDiamondElement = _ExcalidrawElementBase & {
type: "diamond";
};
export type ExcalidrawEllipseElement = _ExcalidrawElementBase & {
type: "ellipse";
};
/**
* These are elements that don't have any additional properties.
*/
export type ExcalidrawGenericElement =
| ExcalidrawSelectionElement
| ExcalidrawRectangleElement
| ExcalidrawDiamondElement
| ExcalidrawEllipseElement;
/**
* ExcalidrawElement should be JSON serializable and (eventually) contain
* no computed data. The list of all ExcalidrawElements should be shareable
* between peers and contain no state local to the peer.
*/
export type _ExcalidrawElement =
| ExcalidrawGenericElement
| ExcalidrawTextElement
| ExcalidrawLinearElement;
export type NonDeleted<TElement extends ExcalidrawElement> = TElement & {
isDeleted: false;
};

View File

@@ -0,0 +1,40 @@
import { Random } from "roughjs/bin/math";
import { nanoid } from "nanoid";
import { Point } from "./elements/ExcalidrawElement";
const random = new Random(Date.now());
export const randomInteger = (): number => Math.floor(random.next() * 2 ** 31);
export const randomId = (): string => nanoid();
export const safeNumber = (number: number): number => Number(number.toFixed(2));
export function dimensionsFromPoints(points: number[][]): number[] {
const xCoords = points.map(([x]) => x);
const yCoords = points.map(([, y]) => y);
const minX = Math.min(...xCoords);
const minY = Math.min(...yCoords);
const maxX = Math.max(...xCoords);
const maxY = Math.max(...yCoords);
return [maxX - minX, maxY - minY];
}
// winding order is clockwise values is positive, counter clockwise if negative.
export function getWindingOrder(
points: Point[],
): "clockwise" | "counterclockwise" {
const total = points.reduce((acc, [x1, y1], idx, arr) => {
const p2 = arr[idx + 1];
const x2 = p2 ? p2[0] : 0;
const y2 = p2 ? p2[1] : 0;
const e = (x2 - x1) * (y2 + y1);
return e + acc;
}, 0);
return total > 0 ? "clockwise" : "counterclockwise";
}

View File

@@ -0,0 +1,463 @@
import { mat4 } from "gl-matrix";
import { dimensionsFromPoints } from "./utils";
import ExcalidrawScene from "./elements/ExcalidrawScene";
import Group, { getGroupAttrs } from "./elements/Group";
import {
ExcalidrawElementBase,
ExcalidrawRectangle,
ExcalidrawEllipse,
ExcalidrawLine,
ExcalidrawDraw,
createExRect,
createExEllipse,
createExLine,
createExDraw,
Point,
} from "./elements/ExcalidrawElement";
import {
presAttrsToElementValues,
filterAttrsToElementValues,
pointsAttrToPoints,
has,
get,
getNum,
} from "./attributes";
import { getTransformMatrix, transformPoints } from "./transform";
import { pointsOnPath } from "points-on-path";
import { randomId, getWindingOrder } from "./utils";
const SUPPORTED_TAGS = [
"svg",
"path",
"g",
"use",
"circle",
"ellipse",
"rect",
"polyline",
"polygon",
];
const nodeValidator = (node: Element): number => {
if (SUPPORTED_TAGS.includes(node.tagName)) {
return NodeFilter.FILTER_ACCEPT;
}
return NodeFilter.FILTER_REJECT;
};
export function createTreeWalker(dom: Node): TreeWalker {
return document.createTreeWalker(dom, NodeFilter.SHOW_ALL, {
acceptNode: nodeValidator,
});
}
type WalkerArgs = {
root: Document;
tw: TreeWalker;
scene: ExcalidrawScene;
groups: Group[];
};
const presAttrs = (
el: Element,
groups: Group[],
): Partial<ExcalidrawElementBase> => {
return {
...getGroupAttrs(groups),
...presAttrsToElementValues(el),
...filterAttrsToElementValues(el),
};
};
const skippedUseAttrs = ["id"];
const allwaysPassedUseAttrs = [
"x",
"y",
"width",
"height",
"href",
"xlink:href",
];
/*
"Most attributes on use do not override those already on the element
referenced by use. (This differs from how CSS style attributes override
those set 'earlier' in the cascade). Only the attributes x, y, width,
height and href on the use element will override those set on the
referenced element. However, any other attributes not set on the referenced
element will be applied to the use element."
Situation 1: Attr is set on defEl, NOT on useEl
- result: use defEl attr
Situation 2: Attr is on useEl, NOT on defEl
- result: use the useEl attr
Situation 3: Attr is on both useEl and defEl
- result: use the defEl attr (Unless x, y, width, height, href, xlink:href)
*/
const getDefElWithCorrectAttrs = (defEl: Element, useEl: Element): Element => {
const finalEl = [...useEl.attributes].reduce((el, attr) => {
if (skippedUseAttrs.includes(attr.value)) {
return el;
}
// Does defEl have the attr? If so, use it, else use the useEl attr
if (
!defEl.hasAttribute(attr.name) ||
allwaysPassedUseAttrs.includes(attr.name)
) {
el.setAttribute(attr.name, useEl.getAttribute(attr.name) || "");
}
return el;
}, defEl.cloneNode() as Element);
return finalEl;
};
const walkers = {
svg: (args: WalkerArgs) => {
walk(args, args.tw.nextNode());
},
g: (args: WalkerArgs) => {
const nextArgs = {
...args,
tw: createTreeWalker(args.tw.currentNode),
groups: [...args.groups, new Group(args.tw.currentNode as Element)],
};
walk(nextArgs, nextArgs.tw.nextNode());
walk(args, args.tw.nextSibling());
},
use: (args: WalkerArgs) => {
const { root, tw, scene } = args;
const useEl = tw.currentNode as Element;
const id = useEl.getAttribute("href") || useEl.getAttribute("xlink:href");
if (!id) {
throw new Error("unable to get id of use element");
}
const defEl = root.querySelector(id);
if (!defEl) {
throw new Error(`unable to find def element with id: ${id}`);
}
const tempScene = new ExcalidrawScene();
const finalEl = getDefElWithCorrectAttrs(defEl, useEl);
walk(
{
...args,
scene: tempScene,
tw: createTreeWalker(finalEl),
},
finalEl,
);
const exEl = tempScene.elements.pop();
if (exEl) {
scene.elements.push(exEl);
//throw new Error("Unable to create ex element");
}
walk(args, args.tw.nextNode());
},
circle: (args: WalkerArgs): void => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const r = getNum(el, "r", 0);
const d = r * 2;
const x = getNum(el, "x", 0) + getNum(el, "cx", 0) - r;
const y = getNum(el, "y", 0) + getNum(el, "cy", 0) - r;
const mat = getTransformMatrix(el, groups);
// @ts-ignore
const m = mat4.fromValues(d, 0, 0, 0, 0, d, 0, 0, 0, 0, 1, 0, x, y, 0, 1);
const result = mat4.multiply(mat4.create(), mat, m);
const circle: ExcalidrawEllipse = {
...createExEllipse(),
...presAttrs(el, groups),
x: result[12],
y: result[13],
width: result[0],
height: result[5],
groupIds: groups.map((g) => g.id),
};
scene.elements.push(circle);
walk(args, tw.nextNode());
},
ellipse: (args: WalkerArgs): void => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const rx = getNum(el, "rx", 0);
const ry = getNum(el, "ry", 0);
const cx = getNum(el, "cx", 0);
const cy = getNum(el, "cy", 0);
const x = getNum(el, "x", 0) + cx - rx;
const y = getNum(el, "y", 0) + cy - ry;
const w = rx * 2;
const h = ry * 2;
const mat = getTransformMatrix(el, groups);
const m = mat4.fromValues(w, 0, 0, 0, 0, h, 0, 0, 0, 0, 1, 0, x, y, 0, 1);
const result = mat4.multiply(mat4.create(), mat, m);
const ellipse: ExcalidrawEllipse = {
...createExEllipse(),
...presAttrs(el, groups),
x: result[12],
y: result[13],
width: result[0],
height: result[5],
groupIds: groups.map((g) => g.id),
};
scene.elements.push(ellipse);
walk(args, tw.nextNode());
},
line: (args: WalkerArgs) => {
// unimplemented
walk(args, args.tw.nextNode());
},
polygon: (args: WalkerArgs) => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const points = pointsAttrToPoints(el);
const mat = getTransformMatrix(el, groups);
const transformedPoints = transformPoints(points, mat);
// The first point needs to be 0, 0, and all following points
// are relative to the first point.
const x = transformedPoints[0][0];
const y = transformedPoints[0][1];
const relativePoints = transformedPoints.map(([_x, _y]) => [
_x - x,
_y - y,
]);
const [width, height] = dimensionsFromPoints(relativePoints);
const line: ExcalidrawLine = {
...createExLine(),
...getGroupAttrs(groups),
...presAttrsToElementValues(el),
points: relativePoints.concat([[0, 0]]),
x,
y,
width,
height,
};
scene.elements.push(line);
walk(args, args.tw.nextNode());
},
polyline: (args: WalkerArgs) => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const mat = getTransformMatrix(el, groups);
const points = pointsAttrToPoints(el);
const transformedPoints = transformPoints(points, mat);
// The first point needs to be 0, 0, and all following points
// are relative to the first point.
const x = transformedPoints[0][0];
const y = transformedPoints[0][1];
const relativePoints = transformedPoints.map(([_x, _y]) => [
_x - x,
_y - y,
]);
const [width, height] = dimensionsFromPoints(relativePoints);
const hasFill = has(el, "fill");
const fill = get(el, "fill");
const shouldFill = !hasFill || (hasFill && fill !== "none");
const line: ExcalidrawLine = {
...createExLine(),
...getGroupAttrs(groups),
...presAttrsToElementValues(el),
points: relativePoints.concat(shouldFill ? [[0, 0]] : []),
x,
y,
width,
height,
};
scene.elements.push(line);
walk(args, args.tw.nextNode());
},
rect: (args: WalkerArgs) => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const x = getNum(el, "x", 0);
const y = getNum(el, "y", 0);
const w = getNum(el, "width", 0);
const h = getNum(el, "height", 0);
const mat = getTransformMatrix(el, groups);
// @ts-ignore
const m = mat4.fromValues(w, 0, 0, 0, 0, h, 0, 0, 0, 0, 1, 0, x, y, 0, 1);
const result = mat4.multiply(mat4.create(), mat, m);
/*
NOTE: Currently there doesn't seem to be a way to specify the border
radius of a rect within Excalidraw. This means that attributes
rx and ry can't be used.
*/
const isRound = el.hasAttribute("rx") || el.hasAttribute("ry");
const rect: ExcalidrawRectangle = {
...createExRect(),
...presAttrs(el, groups),
x: result[12],
y: result[13],
width: result[0],
height: result[5],
strokeSharpness: isRound ? "round" : "sharp",
};
scene.elements.push(rect);
walk(args, args.tw.nextNode());
},
path: (args: WalkerArgs) => {
const { tw, scene, groups } = args;
const el = tw.currentNode as Element;
const mat = getTransformMatrix(el, groups);
const points = pointsOnPath(get(el, "d"));
const fillColor = get(el, "fill", "black");
const fillRule = get(el, "fill-rule", "nonzero");
let elements: ExcalidrawDraw[] = [];
let localGroup = randomId();
switch (fillRule) {
case "nonzero":
let initialWindingOrder = "clockwise";
elements = points.map((pointArr, idx): ExcalidrawDraw => {
const tPoints: Point[] = transformPoints(pointArr, mat4.clone(mat));
const x = tPoints[0][0];
const y = tPoints[0][1];
const [width, height] = dimensionsFromPoints(tPoints);
const relativePoints = tPoints.map(
([_x, _y]): Point => [_x - x, _y - y],
);
const windingOrder = getWindingOrder(relativePoints);
if (idx === 0) {
initialWindingOrder = windingOrder;
localGroup = randomId();
}
let backgroundColor = fillColor;
if (initialWindingOrder !== windingOrder) {
backgroundColor = "#FFFFFF";
}
return {
...createExDraw(),
strokeWidth: 0,
strokeColor: "#00000000",
...presAttrs(el, groups),
points: relativePoints,
backgroundColor,
width,
height,
x: x + getNum(el, "x", 0),
y: y + getNum(el, "y", 0),
groupIds: [localGroup],
};
});
break;
case "evenodd":
elements = points.map((pointArr, idx): ExcalidrawDraw => {
const tPoints: Point[] = transformPoints(pointArr, mat4.clone(mat));
const x = tPoints[0][0];
const y = tPoints[0][1];
const [width, height] = dimensionsFromPoints(tPoints);
const relativePoints = tPoints.map(
([_x, _y]): Point => [_x - x, _y - y],
);
if (idx === 0) {
localGroup = randomId();
}
return {
...createExDraw(),
...presAttrs(el, groups),
points: relativePoints,
width,
height,
x: x + getNum(el, "x", 0),
y: y + getNum(el, "y", 0),
};
});
break;
default:
}
scene.elements = scene.elements.concat(elements);
walk(args, tw.nextNode());
},
};
export function walk(args: WalkerArgs, nextNode: Node | null): void {
if (!nextNode) {
return;
}
const nodeName = nextNode.nodeName as keyof typeof walkers;
if (walkers[nodeName]) {
walkers[nodeName](args);
}
}

View File

@@ -11,7 +11,6 @@ import {
CASCADIA_FONT,
REG_BLOCK_REF_CLEAN,
VIRGIL_FONT,
PLUGIN_ID,
FRONTMATTER_KEY_EXPORT_DARK,
FRONTMATTER_KEY_EXPORT_TRANSPARENT,
FRONTMATTER_KEY_EXPORT_SVGPADDING,
@@ -383,19 +382,29 @@ export const scaleLoadedImage = (
.filter((e: any) => e.type === "image" && e.fileId === f.id)
.forEach((el: any) => {
const [w_old, h_old] = [el.width, el.height];
const elementAspectRatio = w_old / h_old;
if (imageAspectRatio != elementAspectRatio) {
dirty = true;
const h_new = Math.sqrt((w_old * h_old * h_image) / w_image);
const w_new = Math.sqrt((w_old * h_old * w_image) / h_image);
el.height = h_new;
el.width = w_new;
el.y += (h_old - h_new) / 2;
el.x += (w_old - w_new) / 2;
if(f.shouldScale) {
const elementAspectRatio = w_old / h_old;
if (imageAspectRatio != elementAspectRatio) {
dirty = true;
const h_new = Math.sqrt((w_old * h_old * h_image) / w_image);
const w_new = Math.sqrt((w_old * h_old * w_image) / h_image);
el.height = h_new;
el.width = w_new;
el.y += (h_old - h_new) / 2;
el.x += (w_old - w_new) / 2;
}
} else {
if(w_old !== w_image || h_old !== h_image) {
dirty = true;
el.height = h_image;
el.width = w_image;
el.y += (h_old - h_image) / 2;
el.x += (w_old - w_image) / 2;
}
}
});
return { dirty, scene };
}
return { dirty, scene };
};
export const setDocLeftHandedMode = (isLeftHanded: boolean, ownerDocument:Document) => {
@@ -622,6 +631,9 @@ export const getEmbeddedFilenameParts = (fname:string):{
}
}
export const fragWithHTML = (html: string) =>
createFragment((frag) => (frag.createDiv().innerHTML = html));
export const errorlog = (data: {}) => {
console.error({ plugin: "Excalidraw", ...data });
};

View File

@@ -223,4 +223,8 @@ textarea.excalidraw-wysiwyg {
-moz-box-shadow: none;
box-shadow: none;
border-radius: 0;
}
.is-tablet .excalidraw button {
padding: initial;
}

View File

@@ -7,6 +7,7 @@
"allowJs": true,
"noImplicitAny": true,
"moduleResolution": "node",
"esModuleInterop": true,
"importHelpers": true,
"lib": [
"dom",

View File

@@ -1676,6 +1676,11 @@
dependencies:
"@types/node" "*"
"@types/chroma-js@^2.1.4":
"integrity" "sha512-l9hWzP7cp7yleJUI7P2acmpllTJNYf5uU6wh50JzSIZt3fFHe+w2FM6w9oZGBTYzjjm2qHdnQvI+fF/JF/E5jQ=="
"resolved" "https://registry.npmjs.org/@types/chroma-js/-/chroma-js-2.1.4.tgz"
"version" "2.1.4"
"@types/codemirror@0.0.108":
"integrity" "sha512-3FGFcus0P7C2UOGCNUVENqObEb4SFk+S8Dnxq7K6aIsLVs/vDtlangl3PEO0ykaKXyK56swVF6Nho7VsA44uhw=="
"resolved" "https://registry.npmjs.org/@types/codemirror/-/codemirror-0.0.108.tgz"
@@ -2216,10 +2221,10 @@
dependencies:
"@zerollup/ts-helpers" "^1.7.18"
"@zsviczian/excalidraw@0.12.0-obsidian-11":
"integrity" "sha512-DoCXKyjFFkpBQ5GTK5Ud3RocqAxwbHzy9fWZIgWqznMqy2sdR9QDg0y/QILMKG4cOuiRlXXvHnpMxfOPkT4eeA=="
"resolved" "https://registry.npmjs.org/@zsviczian/excalidraw/-/excalidraw-0.12.0-obsidian-11.tgz"
"version" "0.12.0-obsidian-11"
"@zsviczian/excalidraw@0.13.0-obsidian":
"integrity" "sha512-c4SnBEGKtenLB/1gSjXe3BVA+yZfo8b1p2E7sVcaPG8MTz6cpQsCB2+cv7Zta5ihIxuGfK3ZSepVhMbN7RFY2w=="
"resolved" "https://registry.npmjs.org/@zsviczian/excalidraw/-/excalidraw-0.13.0-obsidian.tgz"
"version" "0.13.0-obsidian"
"abab@^2.0.3", "abab@^2.0.5":
"integrity" "sha512-9IK9EadsbHo6jLWIpxpR6pL0sazTXV6+SQv25ZB+F7Bj9mJNaOc4nCRabwd5M/JwmUa8idz6Eci6eKfJryPs6Q=="
@@ -2964,6 +2969,11 @@
optionalDependencies:
"fsevents" "~2.3.2"
"chroma-js@^2.4.2":
"integrity" "sha512-U9eDw6+wt7V8z5NncY2jJfZa+hUH8XEj8FQHgFJTrUFnJfXYf4Ml4adI2vXZOjqRDpFWtYVWypDfZwnJ+HIR4A=="
"resolved" "https://registry.npmjs.org/chroma-js/-/chroma-js-2.4.2.tgz"
"version" "2.4.2"
"chrome-trace-event@^1.0.2":
"integrity" "sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg=="
"resolved" "https://registry.npmjs.org/chrome-trace-event/-/chrome-trace-event-1.0.3.tgz"
@@ -4628,6 +4638,11 @@
"call-bind" "^1.0.2"
"get-intrinsic" "^1.1.1"
"gl-matrix@^3.4.3":
"integrity" "sha512-wcCp8vu8FT22BnvKVPjXa/ICBWRq/zjFfdofZy1WSpQZpphblv12/bOQLBC1rMM7SGOFS9ltVmKOHil5+Ml7gA=="
"resolved" "https://registry.npmjs.org/gl-matrix/-/gl-matrix-3.4.3.tgz"
"version" "3.4.3"
"glob-parent@^5.1.2", "glob-parent@~5.1.2":
"integrity" "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow=="
"resolved" "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz"
@@ -6206,10 +6221,10 @@
dependencies:
"minimist" "^1.2.5"
"moment@2.29.3":
"integrity" "sha512-c6YRvhEo//6T2Jz/vVtYzqBzwvPT95JBQ+smCytzf7c50oMZRsR/a4w88aD34I+/QVSfnoAnSBFPJHItlOMJVw=="
"resolved" "https://registry.npmjs.org/moment/-/moment-2.29.3.tgz"
"version" "2.29.3"
"moment@2.29.4":
"integrity" "sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w=="
"resolved" "https://registry.npmjs.org/moment/-/moment-2.29.4.tgz"
"version" "2.29.4"
"monkey-around@^2.3.0":
"integrity" "sha512-QWcCUWjqE/MCk9cXlSKZ1Qc486LD439xw/Ak8Nt6l2PuL9+yrc9TJakt7OHDuOqPRYY4nTWBAEFKn32PE/SfXA=="
@@ -6420,13 +6435,13 @@
"define-properties" "^1.1.3"
"es-abstract" "^1.19.1"
"obsidian@^0.15.4":
"integrity" "sha512-FE11CxxpVD6t/DBvjLvlT7q7YYW91ubTqPKIIp286LdnyLipS8Xi3Tif8i8ALPv87Vg9obKM43aWcPsYLxLllQ=="
"resolved" "https://registry.npmjs.org/obsidian/-/obsidian-0.15.4.tgz"
"version" "0.15.4"
"obsidian@^0.16.3":
"integrity" "sha512-hal9qk1A0GMhHSeLr2/+o3OpLmImiP+Y+sx2ewP13ds76KXsziG96n+IPFT0mSkup1zSwhEu+DeRhmbcyCCXWw=="
"resolved" "https://registry.npmjs.org/obsidian/-/obsidian-0.16.3.tgz"
"version" "0.16.3"
dependencies:
"@types/codemirror" "0.0.108"
"moment" "2.29.3"
"moment" "2.29.4"
"obuf@^1.0.0", "obuf@^1.1.2":
"integrity" "sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg=="