About this project
Braid is a themeable design system for the SEEK Group, published to npm as braid-design-system. The README describes setup optimized for sku projects: install the package, then at the very top of the application import the reset styles first to avoid CSS ordering issues, import a theme such as seekJobs, and import BraidProvider and components. The provider takes a theme prop and renders components; it can also opt out of body styles with styleBody={false}. A custom link component can be supplied via linkComponent, using makeLinkComponent, to customize Link and TextLink implementation, for example to integrate React Router links. Local development uses pnpm and Storybook. Braid uses Vanilla Extract for styling, authoring CSS in TypeScript that is statically extracted into atomic CSS classes, requiring a bundler plugin. Runtime assertions from the assert library are used for component usage checks; the README recommends stripping them in production with unassert, as done via sku and Babel. Dev-time and build-time warnings such as deprecations rely on process.env.NODE_ENV and can be stripped from production bundles. Contributing information is in CONTRIBUTING.md. Chromatic is thanked for component screenshot testing powered by Storybook. License is MIT.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.