Overview

The gospace Floorplan SDK (@gospace-ai/floorplan) lets you embed fully interactive, real-time floorplans into your web or native applications. Users can explore, visualise, and interact with workplace spaces such as desks, private offices, meeting rooms, and zones — all within a secure, framework-agnostic integration.

Hosted at https://floorplan.gospace.app, the SDK works with any JavaScript environment and supports deep integration with your workplace management workflows.

---

What It Does

• Displays a live, interactive floorplan directly inside your app.

• Shows real-time space allocations for people, teams, or departments.

• Allows secure, filtered views of specific locations, layers, rooms, zones, or spaces.

• Sends user interaction events back to your application for custom handling.

---

Rendering Modes

The SDK supports two rendering modes, configured at initialisation:

• 2D Mode – A top-down floorplan for fast navigation and clear allocation visualisation.

• 3D Mode – A richer, more immersive environment for showcasing layouts and spaces.

---

Key Features

Cross-Platform Compatibility Works with any JavaScript framework (React, Vue, Nuxt, Angular) or plain JS. Supports both browser and native webview integrations.

Interactive Floorplan Embedding Embeds an iframe-based floorplan (built with Nuxt UI) into your application, allowing intuitive pan, zoom, and click interactions.

Space Allocation Visualisation Highlights user-specific or filter-based allocations for desks, rooms, and other spaces, with the option to focus on selected areas.

Secure Communication Uses postMessage for safe, cross-origin communication. Passes parameters like:

• access_token

• location_id

• layer_id

• room_id

• zone_id

• spaces (array of space IDs)

Event Handling Emits SPACE_CLICKED events when users click a space, returning its space_id for your application to handle.

TypeScript Support Includes full type definitions for strong typing, autocompletion, and IDE hints.