A lightweight CSS style library for Fizyr. Contains tokens, base styles, components, and utilities.

Install:

npm install @fizyr/orama

Usage (pick one):

• All-in-one (bundlers or PostCSS):

@import "@fizyr/orama/main.css";

• Cherry-pick specific layers/files (import tokens.css first — components rely on its CSS variables):

@import "@fizyr/orama/tokens.css";
@import "@fizyr/orama/base/reset.css";
@import "@fizyr/orama/base/typography.css";
@import "@fizyr/orama/components/buttons.css";
@import "@fizyr/orama/components/pagination.css";
@import "@fizyr/orama/components/toolbar.css";
@import "@fizyr/orama/components/overlay.css";
@import "@fizyr/orama/utilities/utilities.css";

CDN (no build step):

<link rel="stylesheet" href="https://unpkg.com/@fizyr/orama/main.min.css" />

Project structure:

• tokens/variables.css
• base/reset.css
• base/typography.css
• components/buttons.css
• components/pagination.css
• components/toolbar.css
• components/overlay.css
• utilities/utilities.css

Notes:

• main.css is the source aggregator. The published build outputs dist/main.css and dist/main.min.css with imports inlined.

Git submodule setup (internal use, no registry/auth):

1. Add the submodule in a consumer repo (choose your path):

git submodule add [email protected]:fizyr-private/fizyr-orama.git vendor/fizyr-orama
git submodule update --init --recursive

2. Use the built CSS in your app:

HTML:

<link rel="stylesheet" href="/vendor/fizyr-orama/dist/main.min.css">

or CSS:

@import "../vendor/fizyr-orama/dist/main.css";

3. Update the styles when needed:

cd vendor/fizyr-orama
git fetch origin
git checkout main
git pull
cd -
git add vendor/fizyr-orama
git commit -m "Update orama"

Tips:

• This repo commits the built files under dist/, so consumer repos do not need a build step.
• Optionally pin the submodule to a tag in this repo for stability.

Development workflow (for contributors):

1. Edit only source files (tokens/, base/, components/, utilities/, main.css). DO NOT hand-edit dist/.
2. Build during development:

npm run build

3. Produce release bundle (minified) and commit dist/:

npm run build:prod
git add dist/
git commit -m "chore(dist): rebuild"

4. Verify dist/ is up to date before pushing:

npm run check:dist