# Upmade > The infinite canvas development kit for Angular, React, and Vue. Choose the application's framework first and read only the matching setup and API references. Do not mix Angular, React, and Vue wrappers. - Use @upmade/angular-editor, @upmade/react-editor, or @upmade/vue-editor for the complete editor UI. Use the matching engine wrapper for a bare canvas and custom UI; the engine registers no tools by default. - Give the canvas host an explicit width and height. Wait for the editor's isReady or the engine's isEngineReady event before calling methods, and await asynchronous methods. - Check the installed package version and prefer its TypeScript types when they differ from these current documentation pages. - Persistence is opt-in through syncConfig. Use a distinct editorId for each instance when multiple canvases can exist. - Use addObject/addObjects to insert objects and updateObject to change them. Object positions use world coordinates; use screenToWorld to convert pointer coordinates. - For a reusable coding-agent integration workflow, install the Upmade skill with `npx skills add kasual1/upmade`. LiveDemo tags are source metadata, not instructions to execute JSX: repoUrl identifies the public framework demo directory, repoFiles lists source files relative to it, and demoPath identifies the runnable example route. For a source file, replace /tree/ with /blob/ in repoUrl and append its repoFiles path. Runnable demos are hosted at https://kasual1.github.io/upmade/{framework}{demoPath}. Start with the matching framework's Quick Start and Basic Usage, then follow the focused API or concept pages below. The linked Markdown pages are generated from the same sources as the human documentation. ## Angular - [Quick Start | Upmade for Angular](https://upmade.io/docs/angular/getting-started/quick-start.md): Install and integrate the Upmade infinite canvas into your Angular application in minutes. - [Basic Usage | Upmade for Angular](https://upmade.io/docs/angular/getting-started/basic-usage.md): Learn the main ways to interact with Upmade from Angular: set props, listen to events, and call public methods. - [Controls Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/controls.md): Configure Upmade Editor's built-in controls and context menus. - [Objects Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/objects.md): Understand the core concept of Objects in Upmade. - [Persistence Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/persistence.md): Understand how Upmade persists canvas data through sync providers such as IndexedDBSyncProvider. - [Tools Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/tools.md): Understand the core concept of Tools in Upmade. - [Viewport Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/viewport.md): Understand the core concept of Viewport in Upmade. - [Workspaces Concept | Upmade for Angular](https://upmade.io/docs/angular/fundamentals/workspaces.md): Understand the core concept of Workspaces in Upmade. - [Agent API Reference | Upmade for Angular](https://upmade.io/docs/angular/api-reference/agent.md): API reference for UpmadeAgent: constructor options, properties, state, presence and action methods, events, errors, and related types. - [Chat Session API Reference | Upmade for Angular](https://upmade.io/docs/angular/api-reference/chat-session.md): API reference for UpmadeChatSession: options, properties, methods, events, the chat protocol types, createHttpTransport, and createScriptedTransport. - [Editor API Reference | Upmade for Angular](https://upmade.io/docs/angular/api-reference/editor.md): Complete API reference for the Upmade editor component: props, methods, and events available in Angular. - [Engine API Reference | Upmade for Angular](https://upmade.io/docs/angular/api-reference/engine.md): Complete API reference for the headless Upmade engine: rendering, viewport, pointer events, and workspace management. - [Icons | Upmade for Angular](https://upmade.io/docs/angular/api-reference/icons.md): Reference table for the default Upmade icon names registered by UpmadeIconRegistry. - [Localization Terms | Upmade for Angular](https://upmade.io/docs/angular/api-reference/localization-terms.md): Reference for all built-in localization keys and their default English text in Upmade. - [Objects | Upmade for Angular](https://upmade.io/docs/angular/api-reference/objects.md): Reference for all canvas object types in Upmade: brush, line, shape, text, and image. - [Providers | Upmade for Angular](https://upmade.io/docs/angular/api-reference/providers.md): Reference for all sync provider classes and configuration interfaces in Upmade: in-memory, IndexedDB, BroadcastChannel, WebSocket, and Hocuspocus. - [Theming | Upmade for Angular](https://upmade.io/docs/angular/api-reference/theming.md): Reference for every property supported by the UpmadeTheme interface. - [Tools | Upmade for Angular](https://upmade.io/docs/angular/api-reference/tools.md): Reference for all drawing tool classes and tool configuration interfaces in Upmade: base tool, selection, brush, line, shape, text, image, and eraser. - [Custom Fonts Concept | Upmade for Angular](https://upmade.io/docs/angular/customization/fonts.md): Understand the core concept of Custom Fonts in Upmade. - [Custom Icons Concept | Upmade for Angular](https://upmade.io/docs/angular/customization/icons.md): Understand how to register and use custom SVG icons in Upmade. - [Locales | Upmade for Angular](https://upmade.io/docs/angular/customization/locales.md): Understand how to customize Upmade with locales. - [Themes | Upmade for Angular](https://upmade.io/docs/angular/customization/themes.md): Understand how to customize Upmade with themes. - [Agents | Upmade for Angular](https://upmade.io/docs/angular/advanced/agents.md): Connect the chat box to an LLM and let it work on the canvas, as the user or as an agent with its own cursor, selection, and undo history. Agents c... - [Collaboration Concept | Upmade for Angular](https://upmade.io/docs/angular/advanced/collaboration.md): Understand the core concept of Collaboration in Upmade — cross-tab sync and multi-user editing using Yjs providers. - [Dynamic Objects Concept | Upmade for Angular](https://upmade.io/docs/angular/advanced/dynamic-objects.md): Understand how to embed native HTML or registered framework components as canvas objects in Upmade. - [Import/Export Concept | Upmade for Angular](https://upmade.io/docs/angular/advanced/import-export.md): Understand how to programmatically export the viewport as PNG or SVG, export the workspace as JSON, and import a workspace from JSON in Upmade. - [User Management Concept | Upmade for Angular](https://upmade.io/docs/angular/advanced/user-management.md): Understand how to configure Upmade's user management and login dialog with authentication providers. - [Interactive Blueprint & Defect Pin Mapper | Upmade for Angular](https://upmade.io/docs/angular/examples/blueprint-defect-mapper.md): Incorporate static architectural blueprints and allow facility inspectors to register defect pins onto custom vector layouts. - [Generative UI Example | Upmade for Angular](https://upmade.io/docs/angular/examples/generative-ui.md): Bind a chat session with the iframe canvas tools to the chat box and let a language model build working, sandboxed user interfaces on the infinite ... - [Image Annotation Studio Example | Upmade for Angular](https://upmade.io/docs/angular/examples/image-annotation-studio.md): Build an annotation surface with a centered image and a custom external toolbar with color swatches and sketch or text modes. - [Object Explorer Example | Upmade for Angular](https://upmade.io/docs/angular/examples/object-explorer.md): Build a structured tree-based object explorer with filtering, visibility toggles, and a live inspector for canvas objects. - [Performance Showcase Example | Upmade for Angular](https://upmade.io/docs/angular/examples/performance-showcase.md): Fill an infinite canvas with thousands of interactive GitHub Star buttons built as dynamic objects, and pan and zoom across them smoothly. - [Slideshow Presentation Example | Upmade for Angular](https://upmade.io/docs/angular/examples/slideshow-presentation.md): Build a beautiful slideshow presentation layout on an infinite canvas with horizontal slide guides and dynamic slide boundaries. - [License & Watermark | Upmade for Angular](https://upmade.io/docs/angular/license.md): Upmade is free and open source under the MIT License. Learn how to show or hide the upmade.io watermark in your Angular application. ## React - [Quick Start | Upmade for React](https://upmade.io/docs/react/getting-started/quick-start.md): Install and integrate the Upmade infinite canvas into your React application in minutes. - [Basic Usage | Upmade for React](https://upmade.io/docs/react/getting-started/basic-usage.md): Learn the main ways to interact with Upmade from React: set props, listen to events, and call public methods. - [Controls Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/controls.md): Configure Upmade Editor's built-in controls and context menus. - [Objects Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/objects.md): Understand the core concept of Objects in Upmade. - [Persistence Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/persistence.md): Understand how Upmade persists canvas data through sync providers such as IndexedDBSyncProvider. - [Tools Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/tools.md): Understand the core concept of Tools in Upmade. - [Viewport Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/viewport.md): Understand the core concept of Viewport in Upmade. - [Workspaces Concept | Upmade for React](https://upmade.io/docs/react/fundamentals/workspaces.md): Understand the core concept of Workspaces in Upmade. - [Agent API Reference | Upmade for React](https://upmade.io/docs/react/api-reference/agent.md): API reference for UpmadeAgent: constructor options, properties, state, presence and action methods, events, errors, and related types. - [Chat Session API Reference | Upmade for React](https://upmade.io/docs/react/api-reference/chat-session.md): API reference for UpmadeChatSession: options, properties, methods, events, the chat protocol types, createHttpTransport, and createScriptedTransport. - [Editor API Reference | Upmade for React](https://upmade.io/docs/react/api-reference/editor.md): Complete API reference for the Upmade editor component: props, methods, and events available in React. - [Engine API Reference | Upmade for React](https://upmade.io/docs/react/api-reference/engine.md): Complete API reference for the headless Upmade engine: rendering, viewport, pointer events, and workspace management. - [Icons | Upmade for React](https://upmade.io/docs/react/api-reference/icons.md): Reference for the default Upmade icon names available to Upmade React applications. - [Localization Terms | Upmade for React](https://upmade.io/docs/react/api-reference/localization-terms.md): Reference for all built-in localization keys and their default English text in Upmade. - [Objects | Upmade for React](https://upmade.io/docs/react/api-reference/objects.md): Reference for all canvas object types in Upmade: brush, line, shape, text, and image. - [Providers | Upmade for React](https://upmade.io/docs/react/api-reference/providers.md): Reference for all sync provider classes and configuration interfaces in Upmade: in-memory, IndexedDB, BroadcastChannel, WebSocket, and Hocuspocus. - [Theming | Upmade for React](https://upmade.io/docs/react/api-reference/theme-tokens.md): Customize the look and feel of the Upmade editor with CSS variables and theme tokens. - [Theming | Upmade for React](https://upmade.io/docs/react/api-reference/theming.md): Reference for the UpmadeTheme properties available to Upmade React applications. - [Tools | Upmade for React](https://upmade.io/docs/react/api-reference/tools.md): Reference for all drawing tool classes and tool configuration interfaces in Upmade: base tool, selection, brush, line, shape, text, image, and eraser. - [Types & Interfaces | Upmade for React](https://upmade.io/docs/react/api-reference/types.md): TypeScript types and interfaces exposed by the Upmade library for use in React projects. - [Custom Fonts Concept | Upmade for React](https://upmade.io/docs/react/customization/fonts.md): Understand the core concept of Custom Fonts in Upmade. - [Custom Icons Concept | Upmade for React](https://upmade.io/docs/react/customization/icons.md): Understand how to register and use custom SVG icons in Upmade. - [Locales | Upmade for React](https://upmade.io/docs/react/customization/locales.md): Understand how to customize Upmade with locales. - [Themes | Upmade for React](https://upmade.io/docs/react/customization/themes.md): Understand how to customize Upmade with themes. - [Agents | Upmade for React](https://upmade.io/docs/react/advanced/agents.md): Connect the chat box to an LLM and let it work on the canvas, as the user or as an agent with its own cursor, selection, and undo history. Agents c... - [Collaboration Concept | Upmade for React](https://upmade.io/docs/react/advanced/collaboration.md): Understand the core concept of Collaboration in Upmade - cross-tab sync and multi-user editing using Yjs providers. - [Dynamic Objects Concept | Upmade for React](https://upmade.io/docs/react/advanced/dynamic-objects.md): Understand how to embed native HTML or registered framework components as canvas objects in Upmade. - [Import/Export Concept | Upmade for React](https://upmade.io/docs/react/advanced/import-export.md): Understand how to programmatically export the viewport as PNG or SVG, export the workspace as JSON, and import a workspace from JSON in Upmade. - [User Management Concept | Upmade for React](https://upmade.io/docs/react/advanced/user-management.md): Understand how to configure Upmade's user management and login dialog with authentication providers. - [Interactive Blueprint & Defect Pin Mapper | Upmade for React](https://upmade.io/docs/react/examples/blueprint-defect-mapper.md): Incorporate static architectural blueprints and allow facility inspectors to register defect pins onto custom vector layouts. - [Generative UI Example | Upmade for React](https://upmade.io/docs/react/examples/generative-ui.md): Bind a chat session with the iframe canvas tools to the chat box and let a language model build working, sandboxed user interfaces on the infinite ... - [Image Annotation Studio Example | Upmade for React](https://upmade.io/docs/react/examples/image-annotation-studio.md): Build an annotation surface with a centered image and a custom external toolbar with color swatches and sketch or text modes. - [Object Explorer Example | Upmade for React](https://upmade.io/docs/react/examples/object-explorer.md): Build a structured tree-based object explorer with filtering, visibility toggles, and a live inspector for canvas objects. - [Performance Showcase Example | Upmade for React](https://upmade.io/docs/react/examples/performance-showcase.md): Fill an infinite canvas with thousands of interactive GitHub Star buttons built as dynamic objects, and pan and zoom across them smoothly. - [Slideshow Presentation Example | Upmade for React](https://upmade.io/docs/react/examples/slideshow-presentation.md): Build a beautiful slideshow presentation layout on an infinite canvas with horizontal slide guides and dynamic slide boundaries. - [License & Watermark | Upmade for React](https://upmade.io/docs/react/license.md): Upmade is free and open source under the MIT License. Learn how to show or hide the upmade.io watermark in your React application. ## Vue - [Quick Start | Upmade for Vue](https://upmade.io/docs/vue/getting-started/quick-start.md): Install and integrate the Upmade infinite canvas into your Vue application in minutes. - [Basic Usage | Upmade for Vue](https://upmade.io/docs/vue/getting-started/basic-usage.md): Learn the main ways to interact with Upmade from Vue: set props, listen to events, and call public methods. - [Controls Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/controls.md): Configure Upmade Editor's built-in controls and context menus. - [Objects Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/objects.md): Understand the core concept of Objects in Upmade. - [Persistence Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/persistence.md): Understand how Upmade persists canvas data through sync providers such as IndexedDBSyncProvider. - [Tools Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/tools.md): Understand the core concept of Tools in Upmade. - [Viewport Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/viewport.md): Understand the core concept of Viewport in Upmade. - [Workspaces Concept | Upmade for Vue](https://upmade.io/docs/vue/fundamentals/workspaces.md): Understand the core concept of Workspaces in Upmade. - [Agent API Reference | Upmade for Vue](https://upmade.io/docs/vue/api-reference/agent.md): API reference for UpmadeAgent: constructor options, properties, state, presence and action methods, events, errors, and related types. - [Chat Session API Reference | Upmade for Vue](https://upmade.io/docs/vue/api-reference/chat-session.md): API reference for UpmadeChatSession: options, properties, methods, events, the chat protocol types, createHttpTransport, and createScriptedTransport. - [Editor API Reference | Upmade for Vue](https://upmade.io/docs/vue/api-reference/editor.md): Complete API reference for the Upmade editor component: props, methods, and events available in Vue. - [Engine API Reference | Upmade for Vue](https://upmade.io/docs/vue/api-reference/engine.md): Complete API reference for the headless Upmade engine: rendering, viewport, pointer events, and workspace management. - [Icons | Upmade for Vue](https://upmade.io/docs/vue/api-reference/icons.md): Reference table for the default Upmade icon names registered by UpmadeIconRegistry. - [Localization Terms | Upmade for Vue](https://upmade.io/docs/vue/api-reference/localization-terms.md): Reference for all built-in localization keys and their default English text in Upmade. - [Objects | Upmade for Vue](https://upmade.io/docs/vue/api-reference/objects.md): Reference for all canvas object types in Upmade: brush, line, shape, text, and image. - [Providers | Upmade for Vue](https://upmade.io/docs/vue/api-reference/providers.md): Reference for all sync provider classes and configuration interfaces in Upmade: in-memory, IndexedDB, BroadcastChannel, WebSocket, and Hocuspocus. - [Theming | Upmade for Vue](https://upmade.io/docs/vue/api-reference/theming.md): Reference for every property supported by the UpmadeTheme interface. - [Tools | Upmade for Vue](https://upmade.io/docs/vue/api-reference/tools.md): Reference for all drawing tool classes and tool configuration interfaces in Upmade: base tool, selection, brush, line, shape, text, image, and eraser. - [Types & Interfaces | Upmade for Vue](https://upmade.io/docs/vue/api-reference/types.md): TypeScript types and interfaces exposed by the Upmade library for use in Vue projects. - [Custom Fonts Concept | Upmade for Vue](https://upmade.io/docs/vue/customization/fonts.md): Understand the core concept of Custom Fonts in Upmade. - [Custom Icons Concept | Upmade for Vue](https://upmade.io/docs/vue/customization/icons.md): Understand how to register and use custom SVG icons in Upmade. - [Locales | Upmade for Vue](https://upmade.io/docs/vue/customization/locales.md): Understand how to customize Upmade with locales. - [Themes | Upmade for Vue](https://upmade.io/docs/vue/customization/themes.md): Understand how to customize Upmade with themes. - [Agents | Upmade for Vue](https://upmade.io/docs/vue/advanced/agents.md): Connect the chat box to an LLM and let it work on the canvas, as the user or as an agent with its own cursor, selection, and undo history. Agents c... - [Collaboration Concept | Upmade for Vue](https://upmade.io/docs/vue/advanced/collaboration.md): Understand the core concept of Collaboration in Upmade - cross-tab sync and multi-user editing using Yjs providers. - [Dynamic Objects Concept | Upmade for Vue](https://upmade.io/docs/vue/advanced/dynamic-objects.md): Understand how to embed native HTML or registered framework components as canvas objects in Upmade. - [Import/Export Concept | Upmade for Vue](https://upmade.io/docs/vue/advanced/import-export.md): Understand how to programmatically export the viewport as PNG or SVG, export the workspace as JSON, and import a workspace from JSON in Upmade. - [User Management Concept | Upmade for Vue](https://upmade.io/docs/vue/advanced/user-management.md): Understand how to configure Upmade's user management and login dialog with authentication providers. - [Interactive Blueprint & Defect Pin Mapper | Upmade for Vue](https://upmade.io/docs/vue/examples/blueprint-defect-mapper.md): Incorporate static architectural blueprints and allow facility inspectors to register defect pins onto custom vector layouts. - [Generative UI Example | Upmade for Vue](https://upmade.io/docs/vue/examples/generative-ui.md): Bind a chat session with the iframe canvas tools to the chat box and let a language model build working, sandboxed user interfaces on the infinite ... - [Image Annotation Studio Example | Upmade for Vue](https://upmade.io/docs/vue/examples/image-annotation-studio.md): Build an annotation surface with a centered image and a custom external toolbar with color swatches and sketch or text modes. - [Object Explorer Example | Upmade for Vue](https://upmade.io/docs/vue/examples/object-explorer.md): Build a structured tree-based object explorer with filtering, visibility toggles, and a live inspector for canvas objects. - [Performance Showcase Example | Upmade for Vue](https://upmade.io/docs/vue/examples/performance-showcase.md): Fill an infinite canvas with thousands of interactive GitHub Star buttons built as dynamic objects, and pan and zoom across them smoothly. - [Slideshow Presentation Example | Upmade for Vue](https://upmade.io/docs/vue/examples/slideshow-presentation.md): Build a beautiful slideshow presentation layout on an infinite canvas with horizontal slide guides and dynamic slide boundaries. - [License & Watermark | Upmade for Vue](https://upmade.io/docs/vue/license.md): Upmade is free and open source under the MIT License. Learn how to show or hide the upmade.io watermark in your Vue application.