Virtual whiteboard for sketching hand-drawn like diagrams
feat: support src collaborators (#5114)
Aakansha Doshi9e6d5fdbcbfa
diff --git a/src/actions/actionNavigate.tsx b/src/actions/actionNavigate.tsxindex 453fd52717..6a13ef3ad0 100644--- a/src/actions/actionNavigate.tsx+++ b/src/actions/actionNavigate.tsx@@ -1,4 +1,4 @@-import { getClientColors, getClientInitials } from "../clients";+import { getClientColors } from "../clients";import { Avatar } from "../components/Avatar";import { centerScrollOn } from "../scene/scroll";import { Collaborator } from "../types";@@ -43,16 +43,15 @@ export const actionGoToCollaborator = register({}const { background, stroke } = getClientColors(clientId, appState);- const shortName = getClientInitials(collaborator.username);return (<Avatarcolor={background}border={stroke}onClick={() => updateData(collaborator.pointer)}- >- {shortName}- </Avatar>+ name={collaborator.username || ""}+ src={collaborator.src}+ />);},});diff --git a/src/components/Avatar.scss b/src/components/Avatar.scssindex d077d916bf..d3f8c8bd30 100644--- a/src/components/Avatar.scss+++ b/src/components/Avatar.scss@@ -12,5 +12,11 @@cursor: pointer;font-size: 0.8rem;font-weight: 500;++ &-img {+ width: 100%;+ height: 100%;+ border-radius: 100%;+ }}}diff --git a/src/components/Avatar.tsx b/src/components/Avatar.tsxindex 2b85137077..9b2c8b71d3 100644--- a/src/components/Avatar.tsx+++ b/src/components/Avatar.tsx@@ -1,20 +1,28 @@import "./Avatar.scss";import React from "react";+import { getClientInitials } from "../clients";type AvatarProps = {- children: string;onClick: (e: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;color: string;border: string;+ name: string;+ src?: string;};-export const Avatar = ({ children, color, border, onClick }: AvatarProps) => (- <div- className="Avatar"- style={{ background: color, border: `1px solid ${border}` }}- onClick={onClick}- >- {children}- </div>-);+export const Avatar = ({ color, border, onClick, name, src }: AvatarProps) => {+ const shortName = getClientInitials(name);+ const style = src+ ? undefined+ : { background: color, border: `1px solid ${border}` };+ return (+ <div className="Avatar" style={style} onClick={onClick}>+ {src ? (+ <img className="Avatar-img" src={src} alt={shortName} />+ ) : (+ shortName+ )}+ </div>+ );+};diff --git a/src/components/Tooltip.scss b/src/components/Tooltip.scssindex e40f81e619..bb2b2f72e6 100644--- a/src/components/Tooltip.scss+++ b/src/components/Tooltip.scss@@ -2,7 +2,7 @@// container in body where the actual tooltip is appended to.excalidraw-tooltip {- position: absolute;+ position: fixed;z-index: 1000;padding: 8px;diff --git a/src/packages/excalidraw/CHANGELOG.md b/src/packages/excalidraw/CHANGELOG.mdindex 3c18aa282b..3a52dbf709 100644--- a/src/packages/excalidraw/CHANGELOG.md+++ b/src/packages/excalidraw/CHANGELOG.md@@ -17,6 +17,7 @@ Please add the latest change on the top under the correct section.#### Features+- Support [`src`](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L50) for collaborators. Now onwards host can pass `src` to render the customized avatar for collaborators [#5114](https://github.com/excalidraw/excalidraw/pull/5114).- Support `libraryItems` argument in `initialData.libraryItems` and `updateScene({ libraryItems })` to be a Promise resolving to `LibraryItems`, and support functional update of `libraryItems` in [`updateScene({ libraryItems })`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#updateScene). [#5101](https://github.com/excalidraw/excalidraw/pull/5101).- Expose util [`mergeLibraryItems`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#mergeLibraryItems) [#5101](https://github.com/excalidraw/excalidraw/pull/5101).- Expose util [`exportToClipboard`](https://github.com/excalidraw/excalidraw/blob/master/src/packages/excalidraw/README.md#exportToClipboard) which allows to copy the scene contents to clipboard as `svg`, `png` or `json` [#5103](https://github.com/excalidraw/excalidraw/pull/5103).diff --git a/src/packages/excalidraw/README_NEXT.md b/src/packages/excalidraw/README_NEXT.mdindex 13c2cf8a58..f82ca5c8a0 100644--- a/src/packages/excalidraw/README_NEXT.md+++ b/src/packages/excalidraw/README_NEXT.md@@ -512,7 +512,7 @@ You can use this function to update the scene with the sceneData. It accepts the| --- | --- | --- || `elements` | [`ImportedDataState["elements"]`](https://github.com/excalidraw/excalidraw/blob/master/src/data/types.ts#L17) | The `elements` to be updated in the scene || `appState` | [`ImportedDataState["appState"]`](https://github.com/excalidraw/excalidraw/blob/master/src/data/types.ts#L18) | The `appState` to be updated in the scene. |-| `collaborators` | <pre>Map<string, <a href="https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L29">Collaborator></a></pre> | The list of collaborators to be updated in the scene. |+| `collaborators` | <pre>Map<string, <a href="https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L35">Collaborator></a></pre> | The list of collaborators to be updated in the scene. || `commitToHistory` | `boolean` | Implies if the `history (undo/redo)` should be recorded. Defaults to `false`. || `libraryItems` | [LibraryItems](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L200) | Promise<[LibraryItems](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L200)> | ((currentItems: [LibraryItems](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L200)>) => [LibraryItems](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L200) | Promise<[LibraryItems](https://github.com/excalidraw/excalidraw/blob/master/src/types.ts#L200)>) | The `libraryItems` to be update in the scene. |diff --git a/src/packages/excalidraw/example/App.js b/src/packages/excalidraw/example/App.jsindex 49af956c87..34780948bc 100644--- a/src/packages/excalidraw/example/App.js+++ b/src/packages/excalidraw/example/App.js@@ -31,7 +31,10 @@ const resolvablePromise = () => {const renderTopRightUI = () => {return (- <button onClick={() => alert("This is dummy top right UI")}>+ <button+ onClick={() => alert("This is dummy top right UI")}+ style={{ height: "2.5rem" }}+ >{" "}Click me{" "}</button>@@ -58,6 +61,7 @@ export default function App() {const [exportWithDarkMode, setExportWithDarkMode] = useState(false);const [exportEmbedScene, setExportEmbedScene] = useState(false);const [theme, setTheme] = useState("light");+ const [isCollaborating, setIsCollaborating] = useState(false);const initialStatePromiseRef = useRef({ promise: null });if (!initialStatePromiseRef.current.promise) {@@ -228,6 +232,36 @@ export default function App() {/>Switch to Dark Theme</label>+ <label>+ <input+ type="checkbox"+ checked={isCollaborating}+ onChange={() => {+ if (!isCollaborating) {+ const collaborators = new Map();+ collaborators.set("id1", {+ username: "Doremon",+ src: "doremon.png",+ });+ collaborators.set("id2", {+ username: "Excalibot",+ src: "https://avatars.githubusercontent.com/excalibot",+ });+ collaborators.set("id3", {+ username: "Pika",+ src: "pika.jpeg",+ });+ excalidrawRef.current.updateScene({ collaborators });+ } else {+ excalidrawRef.current.updateScene({+ collaborators: new Map(),+ });+ }+ setIsCollaborating(!isCollaborating);+ }}+ />+ Show collaborators+ </label><div><button onClick={onCopy.bind(null, "png")}>Copy to Clipboard as PNGdiff --git a/src/packages/excalidraw/example/public/doremon.png b/src/packages/excalidraw/example/public/doremon.pngnew file mode 100644index 0000000000..36208a4665Binary files /dev/null and b/src/packages/excalidraw/example/public/doremon.png differdiff --git a/src/packages/excalidraw/example/public/pika.jpeg b/src/packages/excalidraw/example/public/pika.jpegnew file mode 100644index 0000000000..455ed52a63Binary files /dev/null and b/src/packages/excalidraw/example/public/pika.jpeg differdiff --git a/src/types.ts b/src/types.tsindex 6aefedf9f0..19585c4a6d 100644--- a/src/types.ts+++ b/src/types.ts@@ -45,6 +45,9 @@ export type Collaborator = {background: string;stroke: string;};+ // The url of the collaborator's avatar, defaults to username intials+ // if not present+ src?: string;};export type DataURL = string & { _brand: "DataURL" };