@bolt/settings-global

0.9.0 • Public • Published

bolt/settings-global

Global settings. Part of the Bolt “Core” CSS framework that powers the Bolt Design System.


Table of Contents

Cheat Sheet

Install via NPM

npm install @bolt/settings-global

Global Chart*

Block Elements

  • p
  • pre
  • blockquote
  • table
  • ol
  • ul
  • dl
  • fieldset
  • legend
  • details
  • summary
  • hr
  • address

Heading Elements

  • h1
  • h2
  • h3
  • h4
  • h5
  • h6

Getting Started

The best way to start using Bolt is via the Bolt Starterkit (coming soon), a pre-assembled front-end boilerplate designed to get you up and running as quickly as possible.

You can also use the full Bolt Core CSS framework on its own, or, install just the parts you need and fold the different ITCSS layers of Bolt into your existing codebase.

Installing Bolt’s global settings is as easy as running NPM install:

npm install @bolt/settings-global

TIP:: Don’t have a package.json file? Need a little help getting started? Check out our Getting Started guide for some tips to help get you up to speed.

Usage

Once installed, you should @import the main Sass partial into your project’s main .scss file to make the included variables available to the rest of your code.

// Settings
@import ‘@bolt/settings-global’
...

// Tools
@import ‘@bolt/tools-...’

Since Bolt's CSS architecture is based on ITCSS (Inverted Triangle CSS)1, what Sass partials you import, and in what order, makes a whole world of difference. That’s why importing any Settings packages from Bolt in your project’s Settings layer (prior to any Sass mixins, resets, base HTML element styles, etc) is so important.

Compiling

We recommend using Bolt’s Gulp-based front-end build tools to compile your Sass as we're pre-packaging many of the latest tools and add-ons to help you write your very best: LibSass, Autoprefixer, PostCSS, CleanCSS, Sassdoc, Stylelint, Gulp Plumber, npm-sass, and BrowserSync live reloading.


Global Features

Using Block Elements Variable

#{$bolt-all-block-elements} {
  ...
}

Using Heading Elements Variable

#{$bolt-all-heading-elements} {
  ...
}

Further Reading:

1. Learn more about ITCSS

Package Sidebar

Install

npm i @bolt/settings-global

Weekly Downloads

2

Version

0.9.0

License

MIT

Last publish

Collaborators

  • colbycook
  • dmorse
  • mikemai2awesome
  • evanlovely
  • remydenton