Skip to Content
BBRICKSv0.7.4
Getting started

Installation

Install @ergasti/bricks from the GitHub Packages registry.

@ergasti/bricks is published to the GitHub Packages npm registry of the Ergasti organisation, not to npmjs.com.

1. Point the scope at the registry

Add this line to the project's .npmrc:

@ergasti:registry=https://npm.pkg.github.com

2. Authenticate

GitHub Packages needs a token even to read a package. Create a personal access token (classic) with the read:packages scope and put it in your user-level ~/.npmrc, not in the repository:

//npm.pkg.github.com/:_authToken=YOUR_TOKEN

In GitHub Actions use the job's GITHUB_TOKEN (the workflow needs packages: read), for example by setting NODE_AUTH_TOKEN and using actions/setup-node with registry-url: https://npm.pkg.github.com and scope: '@ergasti'. This repository's own release workflow does exactly that.

3. Install

npm install @ergasti/bricks

React 18 is a peer dependency (react and react-dom, ^18.3.1). lucide-react is the only runtime dependency.

Which version

The latest release is 0.5.0. The changes waiting to be released as 0.6.0 are listed on Changelog; these docs already describe them. Pin the version your project was tested with:

npm install @ergasti/bricks@0.5.0 --save-exact

The package is pre-1.0, so a minor release can change how things look (see Versioning and releases). When you raise it, read the parts of Migration between your version and the new one.

ESM only

The package is "type": "module" and its exports map has an import condition only: there is no CommonJS build. A bundler (Vite, webpack 5, esbuild, Rollup) or Node's ESM loader handles it. require('@ergasti/bricks') fails. Because it ships one file per module and declares sideEffects: ["**/*.css"], a bundler can drop what you do not import.

The public entry is @ergasti/bricks and the stylesheets listed on Stylesheets. Nothing under dist/ is a supported deep import.

The library ships no fonts

The tokens name Inter, Plus Jakarta Sans (display) and Cairo (Arabic) but load none of them. Your app loads its own fonts, or accepts the system fallbacks in the stack.

This documentation site loads Plus Jakarta Sans, Inter and Cairo from Google Fonts, from fonts.googleapis.com, in the docs pages only. That is the one network request the site makes at runtime; everything else (scripts, styles, search, examples) is in the page files. Block that host and the docs fall back to system fonts.

TypeScript

Types are generated into dist/index.d.ts. The package needs moduleResolution set to bundler, node16 or nodenext so the exports map is read.

Next

Quick start wraps an app in BricksProvider and draws the first component.

On this page