Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

Feature: Hint viewer (#666)

Gasim Gasimzadaf70bd0081cf4
diff --git a/src/appState.ts b/src/appState.ts
index 52576b32cd..e0b750c79d 100644
--- a/src/appState.ts
+++ b/src/appState.ts
@@ -26,6 +26,7 @@ export function getDefaultAppState(): AppState {
cursorY: 0,
scrolledOutside: false,
name: DEFAULT_PROJECT_NAME,
+ isResizing: false,
};
}
diff --git a/src/components/HintViewer.css b/src/components/HintViewer.css
new file mode 100644
index 0000000000..89eb9ab0de
--- /dev/null
+++ b/src/components/HintViewer.css
@@ -0,0 +1,6 @@
+.HintViewer {
+ position: absolute;
+ left: 0.5em;
+ bottom: 0.5em;
+ font-size: 0.8rem;
+}
diff --git a/src/components/HintViewer.tsx b/src/components/HintViewer.tsx
new file mode 100644
index 0000000000..ad25562d9d
--- /dev/null
+++ b/src/components/HintViewer.tsx
@@ -0,0 +1,55 @@
+import React from "react";
+import { t } from "../i18n";
+import { ExcalidrawElement } from "../element/types";
+
+import "./HintViewer.css";
+
+interface Hint {
+ elementType: string;
+ multiMode: boolean;
+ isResizing: boolean;
+ elements: readonly ExcalidrawElement[];
+}
+
+const getHints = ({ elementType, multiMode, isResizing, elements }: Hint) => {
+ if (elementType === "arrow" || elementType === "line") {
+ if (!multiMode) {
+ return t("hints.linearElement");
+ }
+ return t("hints.linearElementMulti");
+ }
+
+ if (isResizing) {
+ const selectedElements = elements.filter(el => el.isSelected);
+ if (
+ selectedElements.length === 1 &&
+ (selectedElements[0].type === "arrow" ||
+ selectedElements[0].type === "line") &&
+ selectedElements[0].points.length > 2
+ ) {
+ return null;
+ }
+ return t("hints.resize");
+ }
+
+ return null;
+};
+
+export const HintViewer = ({
+ elementType,
+ multiMode,
+ isResizing,
+ elements,
+}: Hint) => {
+ const hint = getHints({
+ elementType,
+ multiMode,
+ isResizing,
+ elements,
+ });
+ if (!hint) {
+ return null;
+ }
+
+ return <div className="HintViewer">{hint}</div>;
+};
diff --git a/src/index.tsx b/src/index.tsx
index 581df9593c..b87a1eb9c0 100644
--- a/src/index.tsx
+++ b/src/index.tsx
@@ -99,6 +99,7 @@ import { LanguageList } from "./components/LanguageList";
import { Point } from "roughjs/bin/geometry";
import { t, languages, setLanguage, getLanguage } from "./i18n";
import { StoredScenesList } from "./components/StoredScenesList";
+import { HintViewer } from "./components/HintViewer";
let { elements } = createScene();
const { history } = createHistory();
@@ -1186,6 +1187,7 @@ export class App extends React.Component<any, AppState> {
}
if (isResizingElements && this.state.resizingElement) {
+ this.setState({ isResizing: true });
const el = this.state.resizingElement;
const selectedElements = elements.filter(el => el.isSelected);
if (selectedElements.length === 1) {
@@ -1541,6 +1543,7 @@ export class App extends React.Component<any, AppState> {
};
const onMouseUp = (e: MouseEvent) => {
+ this.setState({ isResizing: false });
const {
draggingElement,
resizingElement,
@@ -1805,6 +1808,13 @@ export class App extends React.Component<any, AppState> {
</canvas>
</main>
<footer role="contentinfo">
+ <HintViewer
+ elementType={this.state.elementType}
+ multiMode={this.state.multiElement !== null}
+ isResizing={this.state.isResizing}
+ elements={elements}
+ />
+
<LanguageList
onChange={lng => {
setLanguage(lng);
diff --git a/src/locales/en.json b/src/locales/en.json
index d832e56ae3..f58d1b48a2 100644
--- a/src/locales/en.json
+++ b/src/locales/en.json
@@ -77,5 +77,10 @@
"canvasActions": "Canvas actions",
"selectedShapeActions": "Selected shape actions",
"shapes": "Shapes"
+ },
+ "hints": {
+ "linearElement": "Click to start multiple points, drag for single line",
+ "linearElementMulti": "Press Escape or Enter to finish",
+ "resize": "You can constraint proportions by holding SHIFT while resizing"
}
}
diff --git a/src/types.ts b/src/types.ts
index 69d76764a8..b53ec97d96 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -25,4 +25,5 @@ export type AppState = {
scrolledOutside: boolean;
name: string;
selectedId?: string;
+ isResizing: boolean;
};