# Grid Coordinates - Sass CSS Grid Framework Generator (Compass Extension)

Grid Coordinates is a [Sass](http://sass-lang.com/) CSS Grid Framework Generator delivered as a [Compass](http://compass-style.org/) extension. This project was inspired by Tyler Tate's [1kb CSS Grid](http://1kbgrid.com/) project.

Grid Coordinates is quite simple. It fully leverages both classes and extends to set up the styles for your CSS grid framework. Grid Coordinates even supports nested grids and prefix and suffix features. It's also able to generate styles for grids of any size - you control the coordinates and it generates the styles.

## Installation

`sudo gem install grid-coordinates`

Add `require 'grid-coordinates'` to your Compass config file.

## Usage

Grid-coordinates defaults to the 960px grid with 12 columns (12 columns at 60px with a gutter of 20px). You can override these variables as needed in your project if this grid doesn't suit your needs.

Use [1kbgrid.com](http://1kbgrid.com) or another grid generator for guidance on the various grid coordinates possible.

See `templates/project/screen.sass` for an example.

### Configure as needed and import

    // Configure grid coordinates
    $grid-columns: 12 !default
    $grid-width: 60px !default
    $grid-gutter-width: 20px !default
    $overflow-allowed: false !default
    
    @import grid-coordinates
    
    // Only needed if you're using the classes instead of the mixins
    @include grid-coordinates
    
    ...

The `$overflow-allowed` setting controls which of Compass' two clearfix mixins is used. The default setting, false, will clip any content that overflows a grid block. If you need overflowing content to remain visible (i.e., a drop-down menu inside a grid block) change this setting the true.

### Using the Mixins

Use these mixins in your Sass stylesheets. For an example of this in use, see `templates/project`.

`@include grid-container`

`@include nested-grid-container`

`@include grid(4)`

`@include grid-prefix(4)`

`@include grid-suffix(4)`

`@include grid-full`

### Using the Classes

Use the extend classes in your HTML or use them to extend in your Sass stylesheets. For an example of this in use, see `templates/project`.

`@extend .grid-container`

`@extend .nested-grid-container`

`@extend .grid-4`

`@extend .grid-prefix-4`

`@extend .grid-suffix-4`

`@extend .grid-full`

## License

Copyright (c) 2009 Adam Stacoviak

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.