Blaze has moved to scoped packages under @blaze.
This makes it easier for you to install only what you need and allows us to name and organise our packages how we'd like.
Blaze is a framework-free open source UI toolkit. It provides great structure for building websites quickly with a scalable and maintainable foundation.
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 |
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.
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.
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.
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.
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.
FAQs
Open Source UI Toolkit
We found that blaze-css demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TypeScript is porting its compiler to Go, delivering 10x faster builds, lower memory usage, and improved editor performance for a smoother developer experience.
Research
Security News
The Socket Research Team has discovered six new malicious npm packages linked to North Korea’s Lazarus Group, designed to steal credentials and deploy backdoors.
Security News
Socket CEO Feross Aboukhadijeh discusses the open web, open source security, and how Socket tackles software supply chain attacks on The Pair Program podcast.