Overview

The gospace Floorplan SDK (@gospace-ai/floorplan) enables developers to seamlessly embed interactive floorplans into web or native applications, allowing users to visualise and interact with space allocations such as desks, private offices, and meeting rooms. Hosted at https://floorplan.gospace.app, the SDK provides a secure, framework-agnostic solution for integrating floorplans with real-time space selection capabilities.

The SDK supports two distinct rendering modes for embedding interactive floorplans: 2D Mode and 3D Mode. These modes determine how the floorplan is displayed and interacted with, based on the configuration parameters provided during SDK initialisation

Key Features

• Cross-Platform Compatibility: Works with any JavaScript framework (e.g., React, Vue, Nuxt, Angular) or vanilla JavaScript, supporting both web and native app integrations.

• Interactive Floorplan Embedding: Embeds a fully interactive floorplan iframe, built with Nuxt UI, into your application.

• Space Allocation Visualization: Displays user-specific space allocations (e.g., desks, private offices, meeting rooms) with optional highlighting of specific spaces.

• Secure Communication: Uses postMessage to securely pass configuration parameters like access_token, location_id, layer_id, room_id, zone_id, and spaces.

• Event Handling: Emits SPACE_CLICKED events with a space_id when users interact with spaces, enabling custom logic for space selection.

• TypeScript Support: Includes type definitions for robust development and IDE support.