@gbl-uzh/ui

Shared React components and orchestration hooks for learning games built on the GBL platform.

The package is ESM-only and pre-1.0. Pin a tested version and review release notes before upgrading.

Install

pnpm add @gbl-uzh/ui

The game must declare compatible framework and shared-context peers, including Next.js, React, Apollo Client, React Hook Form, and the UZH design system. Use the versions accepted by this package's peerDependencies.

The React 18 reference games use Apollo Client 3.11. React 19 consumers should use Apollo Client 3.14.1 or newer; that combination is covered by the strict external-consumer build.

Use

import { GameSidebar, Layout, StoryElements } from "@gbl-uzh/ui";

Import the utilities-only stylesheet once in the game's global CSS:

@import "@gbl-uzh/ui/style.css";

App Router modules that import this hook-based bundle need a 'use client' boundary. GBL reference games use the Pages Router.

The full component inventory and game integration guidance live in the GBL platform wiki.

License

LGPL-3.0