How thatopen/engine_ui-components works
Project type and purpose
• This is a monorepo library of Web Components for Building Information Modeling (BIM) UI, built with Lit.
• It contains two main packages:
• @thatopen/ui (core UI primitives)
• @thatopen/ui-obc (pre-built functional UIs that wrap That Open Engine components)
• The repo also provides a catalog of static examples demonstrating each component in action.
File structure
• Top-level:
• .github/ – CI workflows for publishing to NPM and releasing
• examples/ – standalone HTML demos for each component
• packages/
– core/ – the @thatopen/ui package
– obc/ – the @thatopen/ui-obc package
• resources/ – shared assets, sample IFC, shaders, scripts
• config files: ESLint, Jest, tsconfig, Vite configs, Yarn Berry setup
• packages/core/src and packages/obc/src each follow a folder-per-component pattern, with index.ts entry points and example fixtures.
README insights
• Monorepo organized to minimize bundle size via peerDependencies.
• Core provides raw Web Components (buttons, panels, tables, inputs).
• OBC provides ready-to-use UIs that wire core components to That Open Engine functionalities (e.g., load IFC, show classifications).
• Web Components are framework-agnostic, authored with Lit.
Main components & relationships
a. Components
• Monorepo Root
• Package Manager (Yarn Berry) & Build Tool (Vite)
• @thatopen/ui (core library)
• @thatopen/ui-obc (functional UI library)
• Examples site (static HTML + built assets)
• External dependencies: @thatopen/components, @thatopen/components-front
• CI/CD: GitHub Actions → NPM registry
b. Interactions
• Core and OBC packages import shared build configs, TypeScript settings, and Lit.
• OBC has peerDependencies on core + engine components.
• The Examples folder imports built outputs (via vite.config-examples) to render demos.
• CI workflows trigger on push/release tags, build packages, run tests, and publish.
c. Architectural patterns
• Monorepo with independent packages (package-per-component)
• Component-driven development (each component folder has code + example)
• Peer-dependency isolation to optimize bundle size
• Shared build tooling (Vite + Yarn workspaces)
d. Key technologies
• Lit (Web Components authoring)
• Vite (dev server & bundler)
• Yarn 3 (workspaces)
• TypeScript
• Jest (unit tests)
• GitHub Actions (CI/CD)