hagrid
v3.1.2
Published
Elegant, mixin-based flexbox SCSS Grid
Downloads
10
Readme
Hagrid 
Contents:
Install:
bower install hagrid
npm install hagrid@import "[path to hagrid]/hagrid";Use:
// * Initialize a basic grid
.parent {
@include g;
// * Initialize a grid with a set of modifiers
// * Modifiers are applied to all items of one grid
@include g(full, rev);
// * Alt. Syntax
@include grid(full, rev);
}
// * Initialize a grid-item with a set of responsive widths
.item {
// * The general width is set without a breakpoint-keyword (e.g. md)
// * Responsive widths are set in the config-map $hagrid-breakpoints
@include i(1/2, 1/3 md, 1/4 lg);
// * If you initialize an item without arguments or a general width, it defaults to 100% (mobile first)
@include i;
@include i(2/3 md, 3/4 lg);
// * You can use whatever you want as values
// * Fractions work great for grids and allow for complex grids without doing math
// * Passing in false will prevent @i from setting any general width
// * Recommended
@include i(1/2, 1/3 md, 1/4 lg);
//* Possible
@include i(false, lg 50%);
// * You can use custom breakpoints in Hagrid. Those should be quoted
// * Breakpoints pointing at $hagrid-breakpoints should not be quoted
@include i(2/3 "(min-width: 580px)", 1/3 lg);
// * Alt. Syntax
@include item();
}Options:
// * Specify gutters between items. They are used like modifiers or applied to all grids
// * If $layout-gutters exists it will be used instead (so you don't have to modify this file directly)
$hagrid-gutters: (
default: 1.5rem,
full: 0,
narrow: 0.5rem,
wide: 3rem
) !default;
// * Set common breakpoints used in your project. Can be used in the @bp-mixin (see below)
// * If $layout-breakpoints exists it will be used instead (so you don't have to modify this file directly)
$hagrid-breakpoints: (
sm: "(min-width: 35.5em)",
md: "(min-width: 48em)",
lg: "(min-width: 64em)",
xl: "(min-width: 80em)"
) !default;
// * Gutters and modifiers are applied to all items of each grid-container
// * By default, the selector `> *` is used. If you use a consistent selector for grid-items, you can set it here
$hagrid-item-selector: "> *" !default;Modifiers:
// * Modifiers are set on grids
@include g(center, middle, full);
x-axis Alignment:
- right: Align grid-items to the right in partially filled rows.
- center: Center grid-items in partially filled rows.
- space-around: Distribute items in partially filled rows by using variable space around them.
- space-between: Distribute items in partially filled rows by using variable space between them.
y-axis Alignment:
- bottom: Align items to the bottom of the grid.
- middle: Vertically center grid items.
Spacing:
You can provide custom gutters to the grid via the config-variable
$hagrid-gutters. Use them as you would use a normal modifier. (e.g.@include g(wide))
Direction:
- rev: Reverted grid on x-axis.
- flip: Reverted grid on y-axis.
Mixins:
- bp: Use breakpoints directly in a class.
- stretch: Assign stretch-mixin to a group of grid-items in a grid to stretch-align their contents.
Example (bp):
.item {
// * Single Breakpoint
@include bp(md) {
text-align: left;
}
// * Multiple Breakpoints
@include bp(md, lg) {
text-align: left;
}
// * Specific Breakpoints
@include bp("(min-width: 568px and max-width: 640px)") {
text-align: left;
}
}Example (stretch):
.stretch {
@include g;
> .item {
@include i;
@include stretch;
}
}
// Stretch accepts a selector as parameter, it defaults to "> *"
.stretch {
@include g;
> .item {
@include i;
@include stretch(".stretched-items");
}
}
Auto Grids:
Starting in v3.0.0, you can let flexbox work out the grid for you - on any breakpoint - by passing auto to the i-mixin.
Example (Auto Grids):
// Basic automatic grid
.auto {
@include g;
}
.auto-item {
@include i(auto);
}
// Pinned elements will keep their width - while their surrounding elements change.
.auto-pinned {
@include g;
}
.auto-item--pinned {
@include i(1/3);
}
.auto-item {
@include i(auto);
}
// You can use automatic grids on any breakpoint you like
.auto--responsive {
@include g;
}
.auto-item--responsive {
@include i(1/2, md auto);
}
Browser Support:
- Chrome
- Firefox
- Safari 6.1+
- Android 4.4+
- IE 10+
- Opera 12+
If you need support for older browsers, you can use the 2.x version range of hagrid. You can install it by running:
npm install [email protected]
bower install [email protected]Prefixes:
Hagrid does not generate prefixes (-webkit-,-ms-) as it is designed to be integrated with common SASS workflows in mind (Gulp / Grunt with Autoprefixer). A sample configuration for Autoprefixer is available in the test build-file. Be careful not to set browsers in a way that generates legacy flexbox syntax!
Developing:
You can build the project with the default gulp-task. If you want to use sassdoc, you can build it by running gulp sassdoc.
Credit:
- Started as a fork of csswizardry-grids
- Beard used in the logo by ZQ.
License:
The MIT License (MIT)
Copyright © 2016 Felix Spöttel
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.