Real Time Figma Clone
📋 Table of Contents
- 🤖 Introduction
- ⚙️ Tech Stack
- 🔋 Features
- 🤸 Quick Start
- 🕸️ Snippets
- 🔗 Links
- 🚀 More
🚨 Tutorial
This repository contains the code corresponding to an in-depth tutorial available on our YouTube channel, JavaScript Mastery.
If you prefer visual learning, this is the perfect resource for you. Follow our tutorial to learn how to build projects like these step-by-step in a beginner-friendly manner!
🤖 Introduction
A minimalistic Figma clone to show how to add real-world features like live collaboration with cursor chat, comments, reactions, and drawing designs (shapes, image upload) on the canvas using fabric.js.
If you're getting started and need assistance or face any bugs, join our active Discord community with over 27k+ members. It's a place where people help each other out.
⚙️ Tech Stack
- Next.js
- TypeScript
- Liveblocks
- Fabric.js
- Shadcn
- Tailwind CSS
🔋 Features
👉 Multi Cursors, Cursor Chat, and Reactions: Allows multiple users to collaborate simultaneously by showing individual cursors, enabling real-time chat, and reactions for interactive communication.
👉 Active Users: Displays a list of currently active users in the collaborative environment, providing visibility into who is currently engaged.
👉 Comment Bubbles: Enables users to attach comments to specific elements on the canvas, fostering communication and feedback on design components.
👉 Creating Different Shapes: Provides tools for users to generate a variety of shapes on the canvas, allowing for diverse design elements
👉 Uploading Images: Import images onto the canvas, expanding the range of visual content in the design
👉 Customization: Allows users to adjust the properties of design elements, offering flexibility in customizing and fine-tuning visual components
👉 Freeform Drawing: Enables users to draw freely on the canvas, promoting artistic expression and creative design.
👉 Undo/Redo: Provides the ability to reverse (undo) or restore (redo) previous actions, offering flexibility in design decision-making
👉 Keyboard Actions: Allows users to utilize keyboard shortcuts for various actions, including copying, pasting, deleting, and triggering shortcuts for features like opening cursor chat, reactions, and more, enhancing efficiency and accessibility.
👉 History: Review the chronological history of actions and changes made on the canvas, aiding in project management and version control.
👉 Deleting, Scaling, Moving, Clearing, Exporting Canvas: Offers a range of functions for managing design elements, including deletion, scaling, moving, clearing the canvas, and exporting the final design for external use.
and many more, including code architecture, advanced react hooks, and reusability
🤸 Quick Start
Follow these steps to set up the project locally on your machine.
Prerequisites
Make sure you have the following installed on your machine:
Cloning the Repository
git clone https://github.com/JavaScript-Mastery-Pro/figma-ts.git
cd figma-tsInstallation
Install the project dependencies using npm:
npm installSet Up Environment Variables
Create a new file named .env.local in the root of your project and add the following content:
NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=Replace the placeholder values with your actual Liveblocks credentials. You can obtain these credentials by signing up on the Liveblocks website.
Running the Project
npm run devOpen http://localhost:3000 in your browser to view the project.
🕸️ Snippets
Styles
tailwind.config.ts
```typescript
import type { Config } from "tailwindcss";
const config = {
darkMode: ["class"],
content: [
"./pages/**/*.{ts,tsx}",
"./components/**/*.{ts,tsx}",
"./app/**/*.{ts,tsx}",
"./src/**/*.{ts,tsx}",
],
prefix: "",
theme: {
container: {
center: true,
padding: "2rem",
screens: {
"2xl": "1400px",
},
},
extend: {
colors: {
primary: {
black: "#14181F",
green: "#56FFA6",
grey: {
100: "#2B303B",
200: "#202731",
300: "#C4D3ED",
},
},
},
keyframes: {
"accordion-down": {
from: { height: "0" },
to: { height: "var(--radix-accordion-content-height)" },
},
"accordion-up": {
from: { height: "var(--radix-accordion-content-height)" },
to: { height: "0" },
},
},
animation: {
"accordion-down": "accordion-down 0.2s ease-out",
"accordion-up": "accordion-up 0.2s ease-out",
},
},
},
plugins: [require("tailwindcss-animate")],
} satisfies Config;
export default config;
```
app/globals.css
```css
@tailwind base;
@tailwind components;
@tailwind utilities;
@import "@liveblocks/react-comments/styles.css";
* {
font-family:
work sans,
sans-serif;
}
@layer utilities {
.no-ring {
@apply outline-none ring-0 ring-offset-0 focus:ring-0 focus:ring-offset-0 focus-visible:ring-offset-0 !important;
}
.input-ring {
@apply h-8 rounded-none border-none bg-transparent outline-none ring-offset-0 focus:ring-1 focus:ring-primary-green focus:ring-offset-0 focus-visible:ring-offset-0 !important;
}
.right-menu-content {
@apply flex w-80 flex-col gap-y-1 border-none bg-primary-black py-4 text-white !important;
}
.right-menu-item {
@apply flex justify-between px-3 py-2 hover:bg-primary-grey-200 !important;
}
}
```
Overlay Comments
NewThread
```tsx
"use client";
import {
FormEvent,
ReactNode,
useCallback,
useEffect,
useRef,
useState,
} from "react";
import { Slot } from "@radix-ui/react-slot";
import * as Portal from "@radix-ui/react-portal";
import { ComposerSubmitComment } from "@liveblocks/react-comments/primitives";
import { useCreateThread } from "@/liveblocks.config";
import { useMaxZIndex } from "@/lib/useMaxZIndex";
import PinnedComposer from "./PinnedComposer";
import NewThreadCursor from "./NewThreadCursor";
type ComposerCoords = null | { x: number; y: number };
type Props = {
children: ReactNode;
};
export const NewThread = ({ children }: Props) => {
// set state to track if we're placing a new comment or not
const [creatingCommentState, setCreatingCommentState] = useState<
"placing" | "placed" | "complete"
>("complete");
/**
* We're using the useCreateThread hook to create a new thread.
*
* useCreateThread: https://liveblocks.io/docs/api-reference/liveblocks-react#useCreateThread
*/
const createThread = useCreateThread();
// get the max z-index of a thread
const maxZIndex = useMaxZIndex();
// set state to track the coordinates of the composer (liveblocks comment editor)
const [composerCoords, setComposerCoords] = useStatePinnedComposer
```tsx
"use client";
import Image from "next/image";
import { Composer, ComposerProps } from "@liveblocks/react-comments";
type Props = {
onComposerSubmit: ComposerProps["onComposerSubmit"];
};
const PinnedComposer = ({ onComposerSubmit, ...props }: Props) => {
return (
NewThreadCursor
```tsx
"use client";
import { useEffect, useState } from "react";
import * as Portal from "@radix-ui/react-portal";
const DEFAULT_CURSOR_POSITION = -10000;
// display a custom cursor when placing a new thread
const NewThreadCursor = ({ display }: { display: boolean }) => {
const [coords, setCoords] = useState({
x: DEFAULT_CURSOR_POSITION,
y: DEFAULT_CURSOR_POSITION,
});
useEffect(() => {
const updatePosition = (e: MouseEvent) => {
// get canvas element
const canvas = document.getElementById("canvas");
if (canvas) {
/**
* getBoundingClientRect returns the size of an element and its position relative to the viewport
*
* getBoundingClientRect: https://developer.mozilla.org/en-US/docs/Web/API/Element/getBoundingClientRect
*/
const canvasRect = canvas.getBoundingClientRect();
// check if the mouse is outside the canvas
// if so, hide the custom comment cursor
if (
e.clientX < canvasRect.left ||
e.clientX > canvasRect.right ||
e.clientY < canvasRect.top ||
e.clientY > canvasRect.bottom
) {
setCoords({
x: DEFAULT_CURSOR_POSITION,
y: DEFAULT_CURSOR_POSITION,
});
return;
}
}
// set the coordinates of the cursor
setCoords({
x: e.clientX,
y: e.clientY,
});
};
document.addEventListener("mousemove", updatePosition, false);
document.addEventListener("mouseenter", updatePosition, false);
return () => {
document.removeEventListener("mousemove", updatePosition);
document.removeEventListener("mouseenter", updatePosition);
};
}, []);
useEffect(() => {
if (display) {
document.documentElement.classList.add("hide-cursor");
} else {
document.documentElement.classList.remove("hide-cursor");
}
}, [display]);
if (!display) {
return null;
}
return (
// Portal.Root is used to render a component outside of its parent component
CommentsOverlay
```tsx
"use client";
import { useCallback, useRef } from "react";
import { ThreadData } from "@liveblocks/client";
import { ThreadMetadata, useEditThreadMetadata, useThreads, useUser } from "@/liveblocks.config";
import { useMaxZIndex } from "@/lib/useMaxZIndex";
import { PinnedThread } from "./PinnedThread";
type OverlayThreadProps = {
thread: ThreadDataPinnedThread
```tsx
"use client";
import Image from "next/image";
import { useMemo, useState } from "react";
import { ThreadData } from "@liveblocks/client";
import { Thread } from "@liveblocks/react-comments";
import { ThreadMetadata } from "@/liveblocks.config";
type Props = {
thread: ThreadData🔗 Links
🚀 More
Advance your skills with Next.js 14 Pro Course
Enjoyed creating this project? Dive deeper into our PRO courses for a richer learning adventure. They're packed with detailed explanations, cool features, and exercises to boost your skills. Give it a go!
Accelerate your professional journey with the Expert Training program
And if you're hungry for more than just a course and want to understand how we learn and tackle tech challenges, hop into our personalized masterclass. We cover best practices, different web skills, and offer mentorship to boost your confidence. Let's learn and grow together!
#