Skip to content

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

feat(freehand): freehand preset color and thickness

pubuzhixing8eafb5cec2fad
diff --git a/packages/drawnix/src/components/color-picker.tsx b/packages/drawnix/src/components/color-picker.tsx
index c1967e6..260ed89 100644
--- a/packages/drawnix/src/components/color-picker.tsx
+++ b/packages/drawnix/src/components/color-picker.tsx
@@ -32,12 +32,18 @@ export type ColorPickerProps = {
onColorChange: (color: string) => void;
onOpacityChange: (opacity: number) => void;
currentColor?: string;
+ hideOpacitySlider?: boolean;
};
export const ColorPicker = React.forwardRef((props: ColorPickerProps, ref) => {
const board = useBoard();
const { t } = useI18n();
- const { currentColor, onColorChange, onOpacityChange } = props;
+ const {
+ currentColor,
+ onColorChange,
+ onOpacityChange,
+ hideOpacitySlider = false,
+ } = props;
const [selectedColor, setSelectedColor] = useState(
(currentColor && removeHexAlpha(currentColor)) ||
ROWS_CLASSIC_COLORS[0][0].value
@@ -48,6 +54,7 @@ export const ColorPicker = React.forwardRef((props: ColorPickerProps, ref) => {
});
return (
<Stack.Col gap={3}>
+ {!hideOpacitySlider && (
<SizeSlider
title={t('popupToolbar.opacity')}
step={5}
@@ -65,7 +72,8 @@ export const ColorPicker = React.forwardRef((props: ColorPickerProps, ref) => {
}}
disabled={selectedColor === CLASSIC_COLORS[0]['value']}
></SizeSlider>
- <Stack.Col gap={2}>
+ )}
+ <Stack.Col gap={2}>
{ROWS_CLASSIC_COLORS.map((colors, index) => (
<Stack.Row key={index} gap={2}>
{colors.map((color) => {
diff --git a/packages/drawnix/src/components/toolbar/creation-toolbar.tsx b/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
index 4e73b9a..fe05144 100644
--- a/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
+++ b/packages/drawnix/src/components/toolbar/creation-toolbar.tsx
@@ -29,7 +29,7 @@ import {
DrawPointerType,
FlowchartSymbols,
} from '@plait/draw';
-import { FreehandPanel , FREEHANDS } from './freehand-panel/freehand-panel';
+import { FreehandPanel } from './freehand-panel/freehand-panel';
import { ShapePicker } from '../shape-picker';
import { ArrowPicker } from '../arrow-picker';
import { useState } from 'react';
@@ -42,9 +42,10 @@ import {
} from '../../hooks/use-drawnix';
import { ExtraToolsButton } from './extra-tools/extra-tools-button';
import { addImage } from '../../utils/image';
-import { useI18n } from '../../i18n';
+import { Translations, useI18n } from '../../i18n';
import { SHAPES } from '../shape-picker';
import { ARROWS } from '../arrow-picker';
+import { FREEHANDS } from '../../constants/freehand';
export enum PopupKey {
'shape' = 'shape',
@@ -53,7 +54,7 @@ export enum PopupKey {
}
type AppToolButtonProps = {
- titleKey?: keyof typeof import('../../i18n').Translations;
+ titleKey?: keyof Translations;
name?: string;
icon: React.ReactNode;
pointer?: DrawnixPointerType;
@@ -143,8 +144,12 @@ export const CreationToolbar = () => {
useState<AppToolButtonProps>(
BUTTONS.find((button) => button.key === PopupKey.freehand)!
);
- const [lastShapePointer, setLastShapePointer] = useState<string | undefined>(SHAPES[0].pointer);
- const [lastArrowPointer, setLastArrowPointer] = useState<string | undefined>(ARROWS[0].pointer);
+ const [lastShapePointer, setLastShapePointer] = useState<DrawPointerType>(
+ SHAPES[0].pointer
+ );
+ const [lastArrowPointer, setLastArrowPointer] = useState<DrawPointerType>(
+ ARROWS[0].pointer
+ );
const onPointerDown = (pointer: DrawnixPointerType) => {
setCreationMode(board, BoardCreationMode.dnd);
@@ -214,9 +219,17 @@ export const CreationToolbar = () => {
<FreehandPanel
onPointerUp={(pointer: DrawnixPointerType) => {
setPointer(pointer);
- setLastFreehandButton(
- FREEHANDS.find((button) => button.pointer === pointer)!
+ const matched = FREEHANDS.find(
+ (item: (typeof FREEHANDS)[number]) =>
+ item.type === 'tool' && item.pointer === pointer
);
+ if (matched && matched.type === 'tool') {
+ setLastFreehandButton({
+ icon: matched.icon,
+ pointer: matched.pointer,
+ titleKey: matched.titleKey,
+ });
+ }
}}
></FreehandPanel>
</PopoverContent>
@@ -250,9 +263,9 @@ export const CreationToolbar = () => {
if (isShapePointer(board)) {
BoardTransforms.updatePointerType(board, board.pointer);
} else {
- setPointer(lastShapePointer || SHAPES[0].pointer)
+ setPointer(lastShapePointer as DrawnixPointerType);
setCreationMode(board, BoardCreationMode.drawing);
- BoardTransforms.updatePointerType(board, lastShapePointer || SHAPES[0].pointer);
+ BoardTransforms.updatePointerType(board, lastShapePointer);
}
}}
/>
@@ -261,7 +274,7 @@ export const CreationToolbar = () => {
<ShapePicker
onPointerUp={(pointer: DrawPointerType) => {
setShapeOpen(false);
- setPointer(pointer);
+ setPointer(pointer as DrawnixPointerType);
setLastShapePointer(pointer);
}}
></ShapePicker>
@@ -292,9 +305,9 @@ export const CreationToolbar = () => {
if (isArrowLinePointer(board)) {
BoardTransforms.updatePointerType(board, board.pointer);
} else {
- setCreationMode(board, BoardCreationMode.drawing);
+ setPointer(lastArrowPointer as DrawnixPointerType);
BoardTransforms.updatePointerType(board, lastArrowPointer || ARROWS[0].pointer);
- setPointer(lastArrowPointer || ARROWS[0].pointer);
+ BoardTransforms.updatePointerType(board, lastArrowPointer);
}
}}
/>
@@ -303,7 +316,7 @@ export const CreationToolbar = () => {
<ArrowPicker
onPointerUp={(pointer: DrawPointerType) => {
setArrowOpen(false);
- setPointer(pointer);
+ setPointer(pointer as DrawnixPointerType);
setLastArrowPointer(pointer);
}}
></ArrowPicker>
diff --git a/packages/drawnix/src/components/toolbar/freehand-panel/freehand-panel.tsx b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-panel.tsx
index 835890e..313b65a 100644
--- a/packages/drawnix/src/components/toolbar/freehand-panel/freehand-panel.tsx
+++ b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-panel.tsx
@@ -2,41 +2,63 @@ import classNames from 'classnames';
import { Island } from '../../island';
import Stack from '../../stack';
import { ToolButton } from '../../tool-button';
-import {
- EraseIcon,
- FeltTipPenIcon,
-} from '../../icons';
-import { BoardTransforms } from '@plait/core';
+import { BoardTransforms, PlaitBoard } from '@plait/core';
import React from 'react';
import { BoardCreationMode, setCreationMode } from '@plait/common';
-import { FreehandShape } from '../../../plugins/freehand/type';
import { useBoard } from '@plait-board/react-board';
-import { splitRows } from '../../../utils/common';
-import {
- DrawnixPointerType,
-} from '../../../hooks/use-drawnix';
+import { DrawnixPointerType } from '../../../hooks/use-drawnix';
import { useI18n } from '../../../i18n';
+import { FreehandShape } from '../../../plugins/freehand/type';
+import {
+ FreeHandItems,
+ FreehandItem,
+ FreehandPresetItem,
+ FreehandToolItem,
+} from '../../../constants/freehand';
+import {
+ FreehandStylePresetItem,
+ FreehandStylePreset,
+} from './freehand-style-preset-item';
+import './freehand-style-preset-item.scss';
+
+const FreehandStyleDivider = () => (
+ <span className="freehand-style-divider" aria-hidden="true" />
+);
+
+FreehandStyleDivider.displayName = 'FreehandStyleDivider';
-export interface FreehandProps {
- titleKey: string;
- icon: React.ReactNode;
- pointer: DrawnixPointerType;
-}
+const FIRST_PRESET_ID =
+ FreeHandItems.find(
+ (item): item is FreehandPresetItem => item.type === 'preset'
+ )?.id || '';
-export const FREEHANDS: FreehandProps[] = [
- {
- icon: FeltTipPenIcon,
- pointer: FreehandShape.feltTipPen,
- titleKey: 'toolbar.pen',
- },
- {
- icon: EraseIcon,
- pointer: FreehandShape.eraser,
- titleKey: 'toolbar.eraser',
- },
-];
+const isFreehandPresetItem = (item: FreehandItem): item is FreehandPresetItem =>
+ item.type === 'preset';
-const ROW_FREEHANDS = splitRows(FREEHANDS, 5);
+const isFreehandToolItem = (item: FreehandItem): item is FreehandToolItem =>
+ item.type === 'tool';
+
+const toPreset = (item: FreehandPresetItem): FreehandStylePreset => ({
+ id: item.id,
+ color: item.color,
+ size: item.size,
+});
+
+const updatePresetInItems = (
+ items: FreehandItem[],
+ presetId: string,
+ updater: (preset: FreehandPresetItem) => FreehandPresetItem
+): FreehandItem[] =>
+ items.map((item) =>
+ isFreehandPresetItem(item) && item.id === presetId ? updater(item) : item
+ );
+
+const getPresetItems = (items: FreehandItem[]): FreehandPresetItem[] =>
+ items.filter((item): item is FreehandPresetItem =>
+ isFreehandPresetItem(item)
+ );
+const getToolItems = (items: FreehandItem[]): FreehandToolItem[] =>
+ items.filter((item): item is FreehandToolItem => isFreehandToolItem(item));
export type FreehandPickerProps = {
onPointerUp: (pointer: DrawnixPointerType) => void;
@@ -47,39 +69,75 @@ export const FreehandPanel: React.FC<FreehandPickerProps> = ({
}) => {
const { t } = useI18n();
const board = useBoard();
+ const container = PlaitBoard.getBoardContainer(board);
+ const [items, setItems] = React.useState<FreehandItem[]>(FreeHandItems);
+ const [activePresetId, setActivePresetId] =
+ React.useState<string>(FIRST_PRESET_ID);
+ const toolItems = getToolItems(items);
+ const presetItems = getPresetItems(items);
+ const showPresets = board.pointer !== FreehandShape.eraser;
+
+ const saveAndApplyPreset = (preset: FreehandPresetItem) => {
+ // do nothing now
+ };
+
return (
<Island padding={1}>
- <Stack.Col gap={1}>
- {ROW_FREEHANDS.map((rowFreehands, rowIndex) => {
- return (
- <Stack.Row gap={1} key={rowIndex}>
- {rowFreehands.map((freehand, index) => {
- return (
- <ToolButton
- key={index}
- className={classNames({ fillable: false })}
- selected={board.pointer === freehand.pointer}
- type="icon"
- size={'small'}
- visible={true}
- icon={freehand.icon}
- title={t(freehand.titleKey)}
- aria-label={t(freehand.titleKey)}
- onPointerDown={() => {
- setCreationMode(board, BoardCreationMode.dnd);
- BoardTransforms.updatePointerType(board, freehand.pointer);
- }}
- onPointerUp={() => {
- setCreationMode(board, BoardCreationMode.drawing);
- onPointerUp(freehand.pointer);
- }}
- />
- );
- })}
- </Stack.Row>
- );
- })}
- </Stack.Col>
+ <Stack.Row gap={1} align="start" className="freehand-style-list">
+ {toolItems.map((freehand, index) => (
+ <ToolButton
+ key={index}
+ className={classNames({ fillable: false })}
+ selected={board.pointer === freehand.pointer}
+ type="icon"
+ size={'small'}
+ visible={true}
+ icon={freehand.icon}
+ title={t(freehand.titleKey)}
+ aria-label={t(freehand.titleKey)}
+ onPointerDown={() => {
+ setCreationMode(board, BoardCreationMode.dnd);
+ BoardTransforms.updatePointerType(board, freehand.pointer);
+ }}
+ onPointerUp={() => {
+ setCreationMode(board, BoardCreationMode.drawing);
+ onPointerUp(freehand.pointer);
+ }}
+ />
+ ))}
+ {showPresets && toolItems.length > 0 && presetItems.length > 0 && (
+ <FreehandStyleDivider />
+ )}
+ {showPresets &&
+ presetItems.map((preset) => (
+ <FreehandStylePresetItem
+ key={preset.id}
+ preset={toPreset(preset)}
+ selected={activePresetId === preset.id}
+ container={container}
+ onSelect={() => {
+ setActivePresetId(preset.id);
+ saveAndApplyPreset(preset);
+ }}
+ onColorChange={(color) => {
+ setItems((value) =>
+ updatePresetInItems(value, preset.id, (item) => ({
+ ...item,
+ color,
+ }))
+ );
+ }}
+ onSizeChange={(size) => {
+ setItems((value) =>
+ updatePresetInItems(value, preset.id, (item) => ({
+ ...item,
+ size,
+ }))
+ );
+ }}
+ />
+ ))}
+ </Stack.Row>
</Island>
);
};
diff --git a/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.scss b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.scss
new file mode 100644
index 0000000..2b6eb80
--- /dev/null
+++ b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.scss
@@ -0,0 +1,38 @@
+.drawnix {
+ .freehand-style-list {
+ margin-top: 0;
+ }
+
+ .freehand-style-divider {
+ width: 1px;
+ height: 20px;
+ margin: 0 calc(var(--space-factor));
+ background-color: var(--color-gray-20);
+ align-self: center;
+ }
+
+ .freehand-style-preset__preview {
+ width: var(--default-icon-size);
+ height: var(--default-icon-size);
+ border-radius: 50%;
+ border: 1px solid var(--color-gray-40);
+ display: inline-flex;
+ align-items: center;
+ justify-content: center;
+ background-color: var(--color-surface-lowest);
+ }
+
+ .freehand-style-preset__dot {
+ border-radius: 50%;
+ display: inline-flex;
+ }
+
+ .freehand-style-setting {
+ width: auto;
+ min-width: auto;
+ }
+
+ .freehand-style-setting .slider-container {
+ width: 100%;
+ }
+}
diff --git a/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.tsx b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.tsx
new file mode 100644
index 0000000..15526e3
--- /dev/null
+++ b/packages/drawnix/src/components/toolbar/freehand-panel/freehand-style-preset-item.tsx
@@ -0,0 +1,118 @@
+import React from 'react';
+import classNames from 'classnames';
+import { ToolButton } from '../../tool-button';
+import { Popover, PopoverContent, PopoverTrigger } from '../../popover/popover';
+import { Island } from '../../island';
+import Stack from '../../stack';
+import { SizeSlider } from '../../size-slider';
+import { useI18n } from '../../../i18n';
+import { ColorPicker } from '../../color-picker';
+
+export interface FreehandStylePreset {
+ id: string;
+ color: string;
+ size: number;
+}
+
+export interface FreehandStylePresetItemProps {
+ preset: FreehandStylePreset;
+ selected: boolean;
+ container: HTMLElement | null;
+ onSelect: () => void;
+ onColorChange: (color: string) => void;
+ onSizeChange: (size: number) => void;
+}
+
+export const FreehandStylePresetItem: React.FC<FreehandStylePresetItemProps> = ({
+ preset,
+ selected,
+ container,
+ onSelect,
+ onColorChange,
+ onSizeChange,
+}) => {
+ const { t } = useI18n();
+ const [open, setOpen] = React.useState(false);
+
+ React.useEffect(() => {
+ if (!selected) {
+ setOpen(false);
+ }
+ }, [selected]);
+
+ return (
+ <Popover
+ open={open}
+ sideOffset={12}
+ onOpenChange={(nextOpen) => {
+ if (nextOpen) {
+ onSelect();
+ setOpen(true);
+ return;
+ }
+ setOpen(false);
+ }}
+ >
+ <PopoverTrigger asChild>
+ <ToolButton
+ className={classNames('freehand-style-preset')}
+ selected={selected || open}
+ type="button"
+ size="small"
+ visible={true}
+ aria-label={`${t('toolbar.pen')} ${preset.id}`}
+ onPointerUp={() => {
+ if (selected) {
+ setOpen(!open);
+ return;
+ }
+ onSelect();
+ setOpen(false);
+ }}
+ >
+ <span
+ className="freehand-style-preset__preview"
+ style={{
+ borderColor: preset.color,
+ }}
+ >
+ <span
+ className="freehand-style-preset__dot"
+ style={{
+ backgroundColor: preset.color,
+ width: `${Math.min(Math.max(preset.size + 1, 4), 14)}px`,
+ height: `${Math.min(Math.max(preset.size + 1, 4), 14)}px`,
+ }}
+ />
+ </span>
+ </ToolButton>
+ </PopoverTrigger>
+ <PopoverContent container={container}>
+ <Island padding={4} className="freehand-style-setting">
+ <Stack.Col gap={3}>
+ <SizeSlider
+ title={t('popupToolbar.stroke')}
+ min={1}
+ max={24}
+ step={1}
+ defaultValue={preset.size}
+ onChange={(value) => {
+ onSizeChange(value);
+ }}
+ />
+ <ColorPicker
+ currentColor={preset.color}
+ hideOpacitySlider={true}
+ onColorChange={(selectedColor: string) => {
+ onColorChange(selectedColor);
+ }}
+ onOpacityChange={() => {
+ return;
+ }}
+ ></ColorPicker>
+ </Stack.Col>
+ </Island>
+ </PopoverContent>
+ </Popover>
+ );
+};
diff --git a/packages/drawnix/src/constants/freehand.ts b/packages/drawnix/src/constants/freehand.ts
new file mode 100644
index 0000000..0753bce
--- /dev/null
+++ b/packages/drawnix/src/constants/freehand.ts
@@ -0,0 +1,70 @@
+import { CLASSIC_COLORS } from './color';
+import type React from 'react';
+import { EraseIcon, FeltTipPenIcon } from '../components/icons';
+import { FreehandShape } from '../plugins/freehand/type';
+import type { Translations } from '../i18n';
+
+export const DEFAULT_FREEHAND_PRESET_SIZES = {
+ preset1: 2,
+ preset2: 6,
+ preset3: 10,
+} as const;
+
+export type FreehandToolItem = {
+ type: 'tool';
+ titleKey: keyof Translations;
+ icon: React.ReactNode;
+ pointer: FreehandShape.feltTipPen | FreehandShape.eraser;
+};
+
+export type FreehandPresetItem = {
+ type: 'preset';
+ id: string;
+ color: string;
+ size: number;
+};
+
+export type FreehandItem = FreehandToolItem | FreehandPresetItem;
+
+const getClassicColorValue = (name: string) => {
+ return CLASSIC_COLORS.find((item) => item.name === name)?.value;
+};
+
+export const DEFAULT_FREEHAND_PRESETS: FreehandPresetItem[] = [
+ {
+ type: 'preset',
+ id: 'preset-1',
+ color: getClassicColorValue('color.default') || CLASSIC_COLORS[1].value,
+ size: DEFAULT_FREEHAND_PRESET_SIZES.preset1,
+ },
+ {
+ type: 'preset',
+ id: 'preset-2',
+ color: getClassicColorValue('color.red') || CLASSIC_COLORS[5].value,
+ size: DEFAULT_FREEHAND_PRESET_SIZES.preset2,
+ },
+ {
+ type: 'preset',
+ id: 'preset-3',
+ color: getClassicColorValue('color.green') || CLASSIC_COLORS[6].value,
+ size: DEFAULT_FREEHAND_PRESET_SIZES.preset3,
+ },
+];
+
+export const FreeHandItems: FreehandItem[] = [
+ {
+ type: 'tool',
+ icon: FeltTipPenIcon,
+ pointer: FreehandShape.feltTipPen,
+ titleKey: 'toolbar.pen',
+ },
+ {
+ type: 'tool',
+ icon: EraseIcon,
+ pointer: FreehandShape.eraser,
+ titleKey: 'toolbar.eraser',
+ },
+ ...DEFAULT_FREEHAND_PRESETS,
+];
+
+export const FREEHANDS = FreeHandItems;