Skip to content
Framework-free open source UI toolkit
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
packages refactor(install page): latest version code Mar 18, 2019
.editorconfig Atoms (#183) Feb 18, 2018
.eslintrc.yml refactor(everything): BREAKING: scoped packages Dec 2, 2018
.gitignore
.npmrc
.nvmrc
.prettierignore
.prettierrc.yml
.stylelintrc.yml
.travis.yml ci(gh-btns): added firebase deploy and added config to travis Dec 3, 2018
CODE_OF_CONDUCT.md
CONTRIBUTING.md refactor(everything): add prettier pre-commit hook and prettier ignores Oct 12, 2018
LICENSE
README.md feat(buttons): removal of buttons atom Mar 6, 2019
commitlint.config.js refactor(everything): add prettier pre-commit hook and prettier ignores Oct 12, 2018
jest.config.js
lerna.json ci(package): remove yarn from instructions and ci build steps Oct 16, 2018
package-lock.json
package.json ci(stencil): downgrade version 0.16.1 to 0.16.0 Dec 19, 2018

README.md

Blaze

Blaze is a framework-free open source UI toolkit. It provides great structure for building websites quickly with a scalable and maintainable foundation.

https://www.blazeui.com

ci build status

Local Developer Setup

First of all install NVM.

When that is complete run:

$ nvm use
$ npm i

That's essentially it! Here are some useful commands:

npm run <command> Description
test Lints all the scss files and runs all the tests on the atoms
dev Runs the dev servers with live reloads for both scss and atoms
commit To commit any changes please use npm run commit, more info below

Committing

When committing changes please follow the Conventional Commits format.

The best thing to do is simply run npm run commit and it'll take you through a step-by-step wizard.

Installing the CSS

The easiest way to use the toolkit is via CDN.

<link rel="stylesheet" href="https://unpkg.com/@blaze/css@x.x.x/dist/blaze.css">

The x.x.x is the specific version of the library, you should use specifc versions to prevent against breaking changes.

How to start applying styles

We've designed the toolkit not to interfere with others or your own styles, hence Blaze won't automatically do anything to your site.

The following won't change by simply linking to blaze.css like it would with others such as Bootstrap or Foundation:

<button type="button">Button</button>

You need to apply our button classes:

<button class="c-button" type="button">Button</button>

This means you have to add classes to each part of your site where you want Blaze to apply. Take a look at the documentation for our objects, components, typography etc. and you'll see how intuitive it is to use.

Installing the JavaScript Components

Link to it by adding the following to your <head></head>.

<script src="https://unpkg.com/@blaze/atoms@x.x.x/dist/blaze-atoms.js"></script>

The x.x.x is the specific version of the library, you should use specifc versions to prevent against breaking changes.

That's it! Start using the components in your HTML.

Integrating with a Framework

Blaze uses Stencil to compile our components into Web Components. And since they can be used within frameworks or in standard HTML websites the best resource to read is the Stencil documentation regarding framework integration.

You can’t perform that action at this time.