Jambonz UI

Overview

A minimal, light-weight UI design system for developing frontends for jambonz apps. It's a kit-of-parts including fonts, a small set of CSS styles, a source set of SASS styles and JavaScript components. Whether you're developing a custom dev stack with tools like vite or webpack you should have no issues utilizing the resources available in the Jambonz UI library package.

Jambonz UI aims to provide foundational design materials like colors, fonts and typography as well as atomic design materials like buttons, icons etc. Currently the library is very lean but is expected to grow thoughtfully as jambonz frontend development continues to mature along this line of thinking. A primary goal of the library is to have a small footprint.

View on bundlephobia.

Installation

Installing the package is easy. You can use any typical package manager for frontend stacks.

npm i @jambonz/ui-kit # or yarn add @jambonz/ui-kit

Developing

Clone this repo and run npm i to install packages.

Before you begin pushing code also run npx husky install for pre-commit hooks.

A note on styles

While we use sass with scss syntax it should be stated that the primary objective is to simply write generally pure css. We take advantage of a few nice features of sass like nesting for BEM module style etc. Here's an example of the BEM style we use:

.example {
  // This is the block

  &--modifier {
    // This is a modifier of the block
  }

  &__item {
    // This is an element

    &--modifer {
      // This a modifer of the element
    }
  }
}

Wherever possible we use css custom properties with our variables but there are a few places in which this is not possible so we use the sass vars there instead, namely for @font-face font-family definitions and @media queries.

Our css variables are defined in sass and we use a simple method for providing them as :root custom properties:

@use "vars";

$root-vars: module-variables("vars");

:root {
  @each $key, $val in $root-vars {
    --#{$key}: #{$val};
  }
}

Overall this approach is convenient as it provides the best of both worlds for users:

source sass with variables and mixins for direct import
pure css dist with :root custom properties and available selectors

Storybook

You can run and build storybook with the following.

You can view the storybook static site here.

# run local storybook
npm run storybook

# build local storybook
npm run build-storybook

Publishing

Always follow these steps to publish this package: jambonz-ui.

# build and package
# generates the `pkg` directory
npm run build

# publish the `pkg`
cd pkg && npm publish

Documentation

Best to just check out the jambonz-ui docs for a more in-depth resource.

jambonz/jambonz-ui