Documentation
Cross-framework Public Alpha for DnDGem. Official channel:
@alpha → 0.1.0-alpha.4.
Getting started
-
Quick Start — first React layout with
@alpha - Playground — adaptive layout demo
- Support — feedback and security contacts
- What’s new in Alpha.4 — release notes in the public repository
Framework guides
- Vanilla / DOM —
@dndgem/dom+@dndgem/core - React —
npm install @dndgem/react@alpha - Vue —
npm install @dndgem/vue@alpha - Angular —
npm install @dndgem/angular@alpha - Svelte —
npm install @dndgem/svelte@alpha
In-repo developer guides on
GitHub:
docs/guides/react.md, vue.md, angular.md,
svelte.md, vanilla.md.
Meta-framework compatibility
Validated environments — use the adapter package, not a dedicated DnDGem meta package:
-
Next.js →
@dndgem/react@alpha('use client'on integration root) - Nuxt →
@dndgem/vue@alpha -
SvelteKit →
@dndgem/svelte@alpha(SSR shell safe; client session after mount)
No @dndgem/next, @dndgem/nuxt, or @dndgem/sveltekit.
Module import safe ≠ server-side DnDGem layout solving.
Install
Use @alpha for the supported Alpha channel. Do not rely on
latest for Alpha releases.
npm install @dndgem/react@alpha
npm install @dndgem/vue@alpha
npm install @dndgem/angular@alpha
npm install @dndgem/svelte@alpha
npm install @dndgem/dom@alpha
Package matrix
| Package | Role | Alpha version |
|---|---|---|
@dndgem/core |
Constraints, validity, solver | 0.1.0-alpha.4 |
@dndgem/dom |
DOM measurement, drag, session | 0.1.0-alpha.4 |
@dndgem/react |
React provider + hooks | 0.1.0-alpha.4 |
@dndgem/vue |
Vue 3 provider + composables | 0.1.0-alpha.4 |
@dndgem/angular |
Angular board directive + signals | 0.1.0-alpha.4 |
@dndgem/svelte |
Svelte 5 provider + actions | 0.1.0-alpha.4 |
Architecture concepts
Constraints → deterministic solving → adaptive Auto-Layout → optional advisory planning.
- Auto-Layout — opt-in; default off on
@alpha - Constraints — content-aware min/preferred dimensions
- Validity — VALID / DEGRADED / INVALID
- SSR / client runtime — import/build shell safe; session after client mount
-
Advisory planning — optional; proposes intent only.
solveLayout/evaluateLayoutremain authoritative
Alpha.4 — optional advisory planning
Phase 4 is complete and shipped in 0.1.0-alpha.4. Planning can propose layout
or item-order intent while deterministic DnDGem validates and resolves. No LLM is required;
model assistance remains deferred.
-
Optional automatic item-order proposals via
AutoLayoutProposalInput.automaticItemOrderandcreateAutoLayoutProposal(...)— layout/planning intent, not automatic DOM / focus / tab / ARIA rewriting -
Optional
planner/onPlannerEventand explicitreplan()on DOM and framework adapters — planner integration is optional; replanning is explicit; initial layout does not depend on planner completion
Full notes: docs/releases/0.1.0-alpha.4.md on GitHub. The playground demonstrates adaptive Auto-Layout; Alpha.4 planner APIs are documented here and in the release notes.
Known limitations
- 0.x Alpha API may break between prereleases
- Keyboard drag and screen-reader drag announcements deferred
- Mobile not validated; Angular Universal not validated
- Model / LLM assistance deferred — Alpha.4 planning is optional and advisory; DnDGem validation and final resolution remain deterministic; no hosted AI or API key required