grid-coordinates 1.1.0 → 1.1.1

data/README.mdown

@@ -1,71 +1,88 @@
-# Grid Coordinates - Sass CSS Grid Framework Generator (Compass Extension)
+# Grid Coordinates
 
-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.
+## Sass based CSS Grid Framework Generator (Compass Extension)
 
-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.
+Grid Coordinates is a Highly configurable [Sass](http://sass-lang.com/) based CSS Grid Framework Generator delivered as a [Compass](http://compass-style.org/) extension inspired by the [1kb CSS Grid](http://1kbgrid.com/) project by [Tyler Tate](http://twitter.com/tylertate).
+
+## Just the grid please.
+
+Grid Coordinates is quite simple. It's just a grid. And it is able to generate styles for grids of any size - you control the coordinates and it generates the styles.
+
+It fully leverages classes, extends and mixins (if that's your preference) to set up the styles for your grid. It supports nested grids, prefix and suffix grid features as well as push and pull grid features.
 
 ## Installation
 
-`sudo gem install grid-coordinates`
+`gem install grid-coordinates`
 
-Add `require 'grid-coordinates'` to your Compass config file.
+Then 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.
+Grid-coordinates defaults to create a 960 pixel grid with 12 columns and a 60px gutter. You can override these defaults 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.
+Use [1kbgrid.com](http://1kbgrid.com) or another grid generator for guidance on configuring your grid's settings.
 
-See `templates/project/screen.sass` for an example.
+Take a peek at [grid-coordinates.com/.../demo.sass](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/sass/demo.sass) for a demonstration of how to use Grid Coordinates as well its [output CSS](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/public/grid-coordinates/css/demo.css).
 
 ### 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
+    $grid-columns: 24
+    $grid-width: 60px
+    $grid-gutter-width: 10px
+    // Set to true by default
+    $overflow-allowed: false
     
     @import grid-coordinates
     
-    // Only needed if you're using the classes instead of the mixins
-    @include grid-coordinates
+    // Only needed if you're using the classes and `@extend` instead of the mixins (suggested)
+    +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.
+The `$overflow-allowed` setting controls which of Compass' two clearfix mixins to be used, `+clearfix` or `+pie-clearfix`. The default setting is set to `true` and will not clip any content that overflows a grid block. If for some reason you need to clip overflowing content update this setting to `false`.
 
-### Using the Mixins
+### Using classes and `@extend`
+
+When you use the mixin `+grid-coordinates` you are able to leverage the classes in your HTML or use the Sass `extend` option to "extend" the classes in your Sass stylesheets.
 
-Use these mixins in your Sass stylesheets. For an example of this in use, see `templates/project`.
+For an example of this in use, take a peek at [grid-coordinates.com/.../demo.sass](https://github.com/adamstac/grid-coordinates.com/blob/master/themes/grid-coordinates/sass/demo.sass).
 
-`@include grid-container`
+`@extend grid-container`
 
-`@include nested-grid-container`
+`@extend nested-grid-container`
 
-`@include grid(4)`
+`@extend grid([columns])`
 
-`@include grid-prefix(4)`
+`@extend grid-prefix([columns])`
 
-`@include grid-suffix(4)`
+`@extend grid-suffix([columns])`
+
+`@extend grid-push([columns])`
+
+`@extend grid-pull([columns])`
+
+`@extend grid-full`
+
+### Using the Mixins
 
-`@include grid-full`
+Use these mixins in your Sass stylesheets. Keep in mind that when you go the route of using mixins you are replicated much code in your output CSS. It's advised that you to learn the [Sass extend concept](http://sass-lang.com/docs/yardoc/file.SASS_REFERENCE.html#extend) and use that method vs mixins. Your output CSS code with thank you.
 
-### Using the Classes
+`+grid-container`
 
-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`.
+`+nested-grid-container`
 
-`@extend .grid-container`
+`+grid([columns])`
 
-`@extend .nested-grid-container`
+`+grid-prefix([columns])`
 
-`@extend .grid-4`
+`+grid-suffix([columns])`
 
-`@extend .grid-prefix-4`
+`+grid-push([columns])`
 
-`@extend .grid-suffix-4`
+`+grid-pull([columns])`
 
-`@extend .grid-full`
+`+grid-full`
 
 ## License
 

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/lib/grid-coordinates.rb

@@ -5,6 +5,6 @@ Compass::Frameworks.register("grid-coordinates", :path => "#{File.dirname(__FILE
 
 module GridCoordinates
   
-  VERSION = "1.1.0".freeze
+  VERSION = "1.1.1".freeze
 
 end

data/stylesheets/_grid-coordinates.sass

@@ -4,7 +4,7 @@
 $grid-columns: 12 !default
 $grid-width: 60px !default
 $grid-gutter-width: 20px !default
-$overflow-allowed: false !default
+$overflow-allowed: true !default
 
 =grid-coordinates
   .grid-container
@@ -24,47 +24,51 @@ $overflow-allowed: false !default
   @for $i from 1 through $grid-columns - 1
     .grid-suffix-#{$i}
       +grid-suffix($i)
+  @for $i from 1 through $grid-columns - 1
+    .grid-push-#{$i}
+      +grid-push($i)
+  @for $i from 1 through $grid-columns - 1
+    .grid-pull-#{$i}
+      +grid-pull($i)
 
-=grid-container
-  margin: 0 auto
-  @if $overflow-allowed
+=overflow-allowed($boolean: $overflow-allowed)
+  @if $boolean
     +pie-clearfix
   @else
     +clearfix
+
+=grid-container
+  +overflow-allowed
+  margin: 0 auto
   width: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width
 
 =nested-grid-container
+  +overflow-allowed
   display: inline-block
   margin:
     left: -$grid-gutter-width / 2
     right: -$grid-gutter-width / 2
-  @if $overflow-allowed
-    +pie-clearfix
-  @else
-    +clearfix
   width: auto
 
 =grid-block
   +float-left
-  @if $overflow-allowed
-    +pie-clearfix
-  @else
-    +clearfix
+  +overflow-allowed
   margin: 0 $grid-gutter-width / 2
 
 =grid($grid-columns)
+  position: relative
   +grid-width($grid-columns)
   +grid-block
 
+=grid-full
+  +grid($grid-columns)
+
 =grid-width($grid-columns)
   @if $grid-columns == 1
     width: $grid-width
   @else
     width: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width - $grid-gutter-width
 
-=grid-full
-  +grid($grid-columns)
-
 =grid-prefix($grid-columns)
   @if $grid-columns == 1
     padding-left: $grid-width + $grid-gutter-width
@@ -76,3 +80,15 @@ $overflow-allowed: false !default
     padding-right: $grid-width + $grid-gutter-width
   @else
     padding-right: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width
+
+=grid-push($grid-columns)
+  @if $grid-columns == 1
+    left: $grid-width + $grid-gutter-width
+  @else
+    left: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width
+
+=grid-pull($grid-columns)
+  @if $grid-columns == 1
+    left: -$grid-width + $grid-gutter-width
+  @else
+    left: -$grid-columns * $grid-width + $grid-columns * $grid-gutter-width

data/stylesheets/_grid-coordinates.scss

@@ -4,7 +4,7 @@
 $grid-columns: 12 !default;
 $grid-width: 60px !default;
 $grid-gutter-width: 20px !default;
-$overflow-allowed: false !default;
+$overflow-allowed: true !default;
 
 @mixin grid-coordinates {
   .grid-container {
@@ -23,48 +23,52 @@ $overflow-allowed: false !default;
       @include grid-prefix($i); } }
   @for $i from 1 through $grid-columns - 1 {
     .grid-suffix-#{$i} {
-      @include grid-suffix($i); } } }
+      @include grid-suffix($i); } }
+  @for $i from 1 through $grid-columns - 1 {
+    .grid-push-#{$i} {
+      @include grid-push($i); } }
+  @for $i from 1 through $grid-columns - 1 {
+    .grid-pull-#{$i} {
+      @include grid-pull($i); } } }
 
-@mixin grid-container {
-  margin: 0 auto;
-  @if $overflow-allowed {
+@mixin overflow-allowed($boolean: $overflow-allowed) {
+  @if $boolean {
     @include pie-clearfix; }
   @else {
-    @include clearfix; }
+    @include clearfix; } }
+
+@mixin grid-container {
+  @include overflow-allowed;
+  margin: 0 auto;
   width: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width; }
 
 @mixin nested-grid-container {
+  @include overflow-allowed;
   display: inline-block;
   margin: {
     left: -$grid-gutter-width / 2;
     right: -$grid-gutter-width / 2; };
-  @if $overflow-allowed {
-    @include pie-clearfix; }
-  @else {
-    @include clearfix; }
   width: auto; }
 
 @mixin grid-block {
   @include float-left;
-  @if $overflow-allowed {
-    @include pie-clearfix; }
-  @else {
-    @include clearfix; }
+  @include overflow-allowed;
   margin: 0 $grid-gutter-width / 2; }
 
 @mixin grid($grid-columns) {
+  position: relative;
   @include grid-width($grid-columns);
   @include grid-block; }
 
+@mixin grid-full {
+  @include grid($grid-columns); }
+
 @mixin grid-width($grid-columns) {
   @if $grid-columns == 1 {
     width: $grid-width; }
   @else {
     width: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width - $grid-gutter-width; } }
 
-@mixin grid-full {
-  @include grid($grid-columns); }
-
 @mixin grid-prefix($grid-columns) {
   @if $grid-columns == 1 {
     padding-left: $grid-width + $grid-gutter-width; }
@@ -76,3 +80,15 @@ $overflow-allowed: false !default;
     padding-right: $grid-width + $grid-gutter-width; }
   @else {
     padding-right: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width; } }
+
+@mixin grid-push($grid-columns) {
+  @if $grid-columns == 1 {
+    left: $grid-width + $grid-gutter-width; }
+  @else {
+    left: $grid-columns * $grid-width + $grid-columns * $grid-gutter-width; } }
+
+@mixin grid-pull($grid-columns) {
+  @if $grid-columns == 1 {
+    left: -$grid-width + $grid-gutter-width; }
+  @else {
+    left: -$grid-columns * $grid-width + $grid-columns * $grid-gutter-width; } }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: grid-coordinates
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 1
-  - 0
-  version: 1.1.0
+  - 1
+  version: 1.1.1
 platform: ruby
 authors: 
 - Adam Stacoviak