Skip to content

Virtual whiteboard for sketching hand-drawn like diagrams

fix: mark more props as optional for element (#6448)

Aakansha Doshi21726e22cce0
diff --git a/src/appState.ts b/src/appState.ts
index f02d5943c7..6f4db75572 100644
--- a/src/appState.ts
+++ b/src/appState.ts
@@ -1,5 +1,6 @@
import oc from "open-color";
import {
+ DEFAULT_ELEMENT_PROPS,
DEFAULT_FONT_FAMILY,
DEFAULT_FONT_SIZE,
DEFAULT_TEXT_ALIGN,
@@ -23,18 +24,18 @@ export const getDefaultAppState = (): Omit<
theme: THEME.LIGHT,
collaborators: new Map(),
currentChartType: "bar",
- currentItemBackgroundColor: "transparent",
+ currentItemBackgroundColor: DEFAULT_ELEMENT_PROPS.backgroundColor,
currentItemEndArrowhead: "arrow",
- currentItemFillStyle: "hachure",
+ currentItemFillStyle: DEFAULT_ELEMENT_PROPS.fillStyle,
currentItemFontFamily: DEFAULT_FONT_FAMILY,
currentItemFontSize: DEFAULT_FONT_SIZE,
- currentItemOpacity: 100,
- currentItemRoughness: 1,
+ currentItemOpacity: DEFAULT_ELEMENT_PROPS.opacity,
+ currentItemRoughness: DEFAULT_ELEMENT_PROPS.roughness,
currentItemStartArrowhead: null,
- currentItemStrokeColor: oc.black,
+ currentItemStrokeColor: DEFAULT_ELEMENT_PROPS.strokeColor,
currentItemRoundness: "round",
- currentItemStrokeStyle: "solid",
- currentItemStrokeWidth: 1,
+ currentItemStrokeStyle: DEFAULT_ELEMENT_PROPS.strokeStyle,
+ currentItemStrokeWidth: DEFAULT_ELEMENT_PROPS.strokeWidth,
currentItemTextAlign: DEFAULT_TEXT_ALIGN,
cursorButton: "up",
draggingElement: null,
@@ -44,7 +45,7 @@ export const getDefaultAppState = (): Omit<
activeTool: {
type: "selection",
customType: null,
- locked: false,
+ locked: DEFAULT_ELEMENT_PROPS.locked,
lastActiveTool: null,
},
penMode: false,
diff --git a/src/charts.ts b/src/charts.ts
index e8980db6c8..c3b0950d1f 100644
--- a/src/charts.ts
+++ b/src/charts.ts
@@ -1,10 +1,5 @@
import colors from "./colors";
-import {
- DEFAULT_FONT_FAMILY,
- DEFAULT_FONT_SIZE,
- ENV,
- VERTICAL_ALIGN,
-} from "./constants";
+import { DEFAULT_FONT_SIZE, ENV } from "./constants";
import { newElement, newLinearElement, newTextElement } from "./element";
import { NonDeletedExcalidrawElement } from "./element/types";
import { randomId } from "./random";
@@ -166,17 +161,7 @@ const bgColors = colors.elementBackground.slice(
// Put all the common properties here so when the whole chart is selected
// the properties dialog shows the correct selected values
const commonProps = {
- fillStyle: "hachure",
- fontFamily: DEFAULT_FONT_FAMILY,
- fontSize: DEFAULT_FONT_SIZE,
- opacity: 100,
- roughness: 1,
strokeColor: colors.elementStroke[0],
- roundness: null,
- strokeStyle: "solid",
- strokeWidth: 1,
- verticalAlign: VERTICAL_ALIGN.MIDDLE,
- locked: false,
} as const;
const getChartDimentions = (spreadsheet: Spreadsheet) => {
@@ -323,7 +308,6 @@ const chartBaseElements = (
x: x + chartWidth / 2,
y: y - BAR_HEIGHT - BAR_GAP * 2 - DEFAULT_FONT_SIZE,
roundness: null,
- strokeStyle: "solid",
textAlign: "center",
})
: null;
diff --git a/src/components/App.tsx b/src/components/App.tsx
index be5561995a..fcbcca873f 100644
--- a/src/components/App.tsx
+++ b/src/components/App.tsx
@@ -2732,7 +2732,6 @@ class App extends React.Component<AppProps, AppState> {
strokeStyle: this.state.currentItemStrokeStyle,
roughness: this.state.currentItemRoughness,
opacity: this.state.currentItemOpacity,
- roundness: null,
text: "",
fontSize,
fontFamily,
@@ -2744,7 +2743,6 @@ class App extends React.Component<AppProps, AppState> {
: DEFAULT_VERTICAL_ALIGN,
containerId: shouldBindToContainer ? container?.id : undefined,
groupIds: container?.groupIds ?? [],
- locked: false,
lineHeight,
});
diff --git a/src/constants.ts b/src/constants.ts
index ef563e4a41..23fefa6e54 100644
--- a/src/constants.ts
+++ b/src/constants.ts
@@ -1,6 +1,7 @@
import cssVariables from "./css/variables.module.scss";
import { AppProps } from "./types";
-import { FontFamilyValues } from "./element/types";
+import { ExcalidrawElement, FontFamilyValues } from "./element/types";
+import oc from "open-color";
export const isDarwin = /Mac|iPod|iPhone|iPad/.test(navigator.platform);
export const isWindows = /^Win/.test(navigator.platform);
@@ -254,3 +255,23 @@ export const ROUNDNESS = {
/** key containt id of precedeing elemnt id we use in reconciliation during
* collaboration */
export const PRECEDING_ELEMENT_KEY = "__precedingElement__";
+
+export const DEFAULT_ELEMENT_PROPS: {
+ strokeColor: ExcalidrawElement["strokeColor"];
+ backgroundColor: ExcalidrawElement["backgroundColor"];
+ fillStyle: ExcalidrawElement["fillStyle"];
+ strokeWidth: ExcalidrawElement["strokeWidth"];
+ strokeStyle: ExcalidrawElement["strokeStyle"];
+ roughness: ExcalidrawElement["roughness"];
+ opacity: ExcalidrawElement["opacity"];
+ locked: ExcalidrawElement["locked"];
+} = {
+ strokeColor: oc.black,
+ backgroundColor: "transparent",
+ fillStyle: "hachure",
+ strokeWidth: 1,
+ strokeStyle: "solid",
+ roughness: 1,
+ opacity: 100,
+ locked: false,
+};
diff --git a/src/element/newElement.ts b/src/element/newElement.ts
index e3b25e848d..36c8cc0e02 100644
--- a/src/element/newElement.ts
+++ b/src/element/newElement.ts
@@ -36,7 +36,14 @@ import {
getMaxContainerWidth,
getDefaultLineHeight,
} from "./textElement";
-import { VERTICAL_ALIGN } from "../constants";
+import {
+ DEFAULT_ELEMENT_PROPS,
+ DEFAULT_FONT_FAMILY,
+ DEFAULT_FONT_SIZE,
+ DEFAULT_TEXT_ALIGN,
+ DEFAULT_VERTICAL_ALIGN,
+ VERTICAL_ALIGN,
+} from "../constants";
import { isArrowElement } from "./typeChecks";
import { MarkOptional, Merge, Mutable } from "../utility-types";
@@ -51,6 +58,15 @@ type ElementConstructorOpts = MarkOptional<
| "version"
| "versionNonce"
| "link"
+ | "strokeStyle"
+ | "fillStyle"
+ | "strokeColor"
+ | "backgroundColor"
+ | "roughness"
+ | "strokeWidth"
+ | "roundness"
+ | "locked"
+ | "opacity"
>;
const _newElementBase = <T extends ExcalidrawElement>(
@@ -58,13 +74,13 @@ const _newElementBase = <T extends ExcalidrawElement>(
{
x,
y,
- strokeColor,
- backgroundColor,
- fillStyle,
- strokeWidth,
- strokeStyle,
- roughness,
- opacity,
+ strokeColor = DEFAULT_ELEMENT_PROPS.strokeColor,
+ backgroundColor = DEFAULT_ELEMENT_PROPS.backgroundColor,
+ fillStyle = DEFAULT_ELEMENT_PROPS.fillStyle,
+ strokeWidth = DEFAULT_ELEMENT_PROPS.strokeWidth,
+ strokeStyle = DEFAULT_ELEMENT_PROPS.strokeStyle,
+ roughness = DEFAULT_ELEMENT_PROPS.roughness,
+ opacity = DEFAULT_ELEMENT_PROPS.opacity,
width = 0,
height = 0,
angle = 0,
@@ -72,7 +88,7 @@ const _newElementBase = <T extends ExcalidrawElement>(
roundness = null,
boundElements = null,
link = null,
- locked,
+ locked = DEFAULT_ELEMENT_PROPS.locked,
...rest
}: ElementConstructorOpts & Omit<Partial<ExcalidrawGenericElement>, "type">,
) => {
@@ -138,27 +154,39 @@ const getTextElementPositionOffsets = (
export const newTextElement = (
opts: {
text: string;
- fontSize: number;
- fontFamily: FontFamilyValues;
- textAlign: TextAlign;
- verticalAlign: VerticalAlign;
+ fontSize?: number;
+ fontFamily?: FontFamilyValues;
+ textAlign?: TextAlign;
+ verticalAlign?: VerticalAlign;
containerId?: ExcalidrawTextContainer["id"];
lineHeight?: ExcalidrawTextElement["lineHeight"];
+ strokeWidth?: ExcalidrawTextElement["strokeWidth"];
} & ElementConstructorOpts,
): NonDeleted<ExcalidrawTextElement> => {
- const lineHeight = opts.lineHeight || getDefaultLineHeight(opts.fontFamily);
+ const fontFamily = opts.fontFamily || DEFAULT_FONT_FAMILY;
+ const fontSize = opts.fontSize || DEFAULT_FONT_SIZE;
+ const lineHeight = opts.lineHeight || getDefaultLineHeight(fontFamily);
const text = normalizeText(opts.text);
- const metrics = measureText(text, getFontString(opts), lineHeight);
- const offsets = getTextElementPositionOffsets(opts, metrics);
+ const metrics = measureText(
+ text,
+ getFontString({ fontFamily, fontSize }),
+ lineHeight,
+ );
+ const textAlign = opts.textAlign || DEFAULT_TEXT_ALIGN;
+ const verticalAlign = opts.verticalAlign || DEFAULT_VERTICAL_ALIGN;
+ const offsets = getTextElementPositionOffsets(
+ { textAlign, verticalAlign },
+ metrics,
+ );
const textElement = newElementWith(
{
..._newElementBase<ExcalidrawTextElement>("text", opts),
text,
- fontSize: opts.fontSize,
- fontFamily: opts.fontFamily,
- textAlign: opts.textAlign,
- verticalAlign: opts.verticalAlign,
+ fontSize,
+ fontFamily,
+ textAlign,
+ verticalAlign,
x: opts.x - offsets.x,
y: opts.y - offsets.y,
width: metrics.width,