HTML CSS TypeScript JavaScript
Clone or download
Permalink
Failed to load latest commit information.
atoms remove css file header Jul 3, 2018
scss remove css file header Jul 3, 2018
.editorconfig Atoms (#183) Feb 18, 2018
.gitignore updated .gitignore Sep 10, 2017
.nvmrc node version May 24, 2018
.travis.yml Atoms (#183) Feb 18, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 9, 2017
CONTRIBUTING.md v3.3.0 (#169) Jul 25, 2017
LICENSE Atoms (#183) Feb 18, 2018
README.md accessiblity 💥 May 24, 2018
package-lock.json v bump Jun 25, 2018
package.json remove css file header Jul 3, 2018
sponsors.png sponsors Sep 10, 2017

README.md

Blaze

Open Source Modular UI Toolkit - utilising BEM conventions to provide great structure for building websites quickly

https://www.blazeui.com

Getting started

Installing the CSS

The easiest way to use the toolkit is via CDN.

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

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

Modules

Each module is also available via CDN in-case you only want bits and pieces of Blaze and not the whole toolkit.

<link rel="stylesheet" href="https://unpkg.com/blaze/scss/dist/generics.global.min.css">
<link rel="stylesheet" href="https://unpkg.com/blaze/scss/dist/objects.grid.min.css">
<link rel="stylesheet" href="https://unpkg.com/blaze/scss/dist/utilities.typography.min.css">
<link rel="stylesheet" href="https://unpkg.com/blaze/scss/dist/components.buttons.min.css">
...etc...

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.min.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@x.x.x/atoms/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.