Documentation

Documentation

Public Beta support

The supported @ds-gn/ui Public Beta components and their 0.x compatibility promise.

The Public Beta of @ds-gn/ui includes 24 supported custom elements, listed below.

Included component set

Group Component Custom element Package subpath
App-capable Button dsgn-button @ds-gn/ui/button
App-capable Input dsgn-input @ds-gn/ui/input
App-capable Modal dsgn-modal @ds-gn/ui/modal
Display and layout Background dsgn-background @ds-gn/ui/background
Display and layout Badge dsgn-badge @ds-gn/ui/badge
Display and layout Card dsgn-card @ds-gn/ui/card
Display and layout CodeBlock dsgn-code-block @ds-gn/ui/code-block
Display and layout Container dsgn-container @ds-gn/ui/container
Display and layout Divider dsgn-divider @ds-gn/ui/divider
Display and layout Grid dsgn-grid @ds-gn/ui/grid
Display and layout Stack dsgn-stack @ds-gn/ui/stack
Content Heading dsgn-heading @ds-gn/ui/heading
Content Text dsgn-text @ds-gn/ui/text
Content Icon dsgn-icon @ds-gn/ui/icon
Content Image dsgn-image @ds-gn/ui/image
Marketing and composition Hero dsgn-hero @ds-gn/ui/hero
Marketing and composition HeadingBlock dsgn-heading-block @ds-gn/ui/heading-block
Marketing and composition FeatureItem dsgn-feature-item @ds-gn/ui/feature-item
Marketing and composition FeatureTabs dsgn-feature-tabs @ds-gn/ui/feature-tabs
Marketing and composition FormBlock dsgn-form-block @ds-gn/ui/form-block
Navigation Nav dsgn-nav @ds-gn/ui/nav
Navigation NavLink dsgn-nav-link @ds-gn/ui/nav-link
Navigation NavDropdownColumn dsgn-nav-dropdown-column @ds-gn/ui/nav-dropdown-column
Navigation Footer dsgn-footer @ds-gn/ui/footer

Modal supports native <dialog> semantics, centered and edge-sheet placements, focus containment and return, and cancelable dismissal. It also includes a React wrapper.

Every currently exported custom element is included. There are no exported components withheld from the Public Beta.

Each of the 24 has one canonical documentation page under Components, and those pages are the compatibility surface: the props, slots, events, methods, and CSS parts they document are what the 0.x promise below covers.

Explicit exclusions

  • The aurora mesh engine is an internal rendering helper. It has no custom element tag, package subpath, or React wrapper and is not public API.
  • Field, Label, Description, Error, Table, Select, Option, Dropdown Menu, Toast Region, Toast, Avatar, Checkbox, Radio, Radio Group, Switch, Toggle, Toggle Group, Popover, Tooltip, application Tabs, Accordion, Collapsible, Skeleton, Spinner, Pagination, Combobox, DataTable controllers, Menu, and Menubar are post-launch roadmap work. None are currently exported, and none blocks the initial Public Beta.
  • Vue-, Svelte-, and Solid-specific wrappers are not part of this launch.

0.x compatibility promise

Public Beta components are supported for consumer evaluation and production trials. Before 1.0, we may refine their APIs based on usage, accessibility findings, and platform changes.

  • Patch releases do not intentionally break documented APIs.
  • Planned breaking changes ship in a minor release. The changelog and release notes announce the change and include migration guidance.
  • Deprecations remain available for at least one complete minor release and at least 90 days, whichever is longer, before removal.
  • Security, legal, or broken-platform emergencies may require a faster change. We announce those exceptions explicitly and provide the safest available migration.

The supported surface includes documented package subpaths, custom element tags, attributes and properties, slots, public methods, events, CSS parts and custom properties, and generated React wrappers. Undocumented implementation details are not part of the compatibility contract.

DS-GN maintains the documentation against the shipped component APIs.

Esc