Skip to content
tektharPublic

About

The design system for ABP applications on Chakra UI v3 and React 19: tokens, components, an app shell and a settings frame. Names no product.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

@abpjs/ui

The design system for ABP applications on Chakra UI v3 and React 19: tokens, recipes, an app shell, tables and lists with filters and grouping, boards, timelines, calendars, forms, pickers, motion that respects reduced motion, skeletons, a command search, and a settings frame that packages and plugins add pages to. Right-to-left languages work throughout.

It is not @abpjs/components or @abpjs/theme-shared, which are ABP's own module components on React 18.

It names no product. The host gives its CSS variable prefix, its colours and its words.

Install

npm install @abpjs/ui @chakra-ui/react @emotion/react next-themes react react-dom

Peers: React 19, Chakra UI 3.38 or later (3.x), emotion 11, next-themes.

Use

import { AbpProvider, createAbpSystem } from '@abpjs/ui';

// Your prefix (the CSS variables are --acme-colors-bg and so on) and your colours; the package's own when left out.
const system = createAbpSystem({ prefix: 'acme', brand: acmeBrand });

export function Providers({ children, locale }: { children: React.ReactNode; locale: string }) {
  return (
    <AbpProvider system={system} locale={locale} productName="Acme" labels={translatedLabels}>
      {children}
    </AbpProvider>
  );
}
  • Words: every component takes its words as props or from the provider's labels; the package has no translations of its own and no i18n library.
  • Brand: six scales (neutral, accent, green, amber, red, blue), light to dark; components only use the semantic tokens (bg, fg, border, accent...), which pick steps per colour mode.
  • Fonts: the host loads them and sets --{prefix}-font-sans, --{prefix}-font-arabic and --{prefix}-font-mono.
  • Settings: settingsArea(sections, pages) orders an area's sections and pages by weight, then title, and leaves out pages the person can't see; SettingsLayout draws the area; findSettingsPage serves a catch-all route.
  • Rules without React: @abpjs/ui/rules has the query conditions, grouping, the breadcrumb fold and the settings order, for code that can't load Chakra.

Develop

npm ci
npm run typecheck
npm test
npm run build
npm run check:names

Releases: a v<version> tag publishes to npm from CI. See CHANGELOG.md.

Licence

Apache-2.0. See LICENSE.

About

The design system for ABP applications on Chakra UI v3 and React 19: tokens, components, an app shell and a settings frame. Names no product.

Resources

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages