type-heading 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 00fbaca7ce7ee0da0212f26d431e27a35936e4f8
+  data.tar.gz: b225b572c51e1cc511851194dcebdcae00f9d576
+SHA512:
+  metadata.gz: ed262801c66a5c88fc20bffd4834c843f56784a939de24ca71a75e502a6c225a3e5bb8c1ae9fdff9f93b87d4fbd20e8dd19d0c16a6c38cab10336851f0a7b113
+  data.tar.gz: 5f430dbf16853bb60ea207cdf89db8ac184e58cb687bc4c52f286e1fe8e1bebefd42673ae3694e0b2448059d2dd68545072c9b5bdf044863f40f67d0a2982404

data/README.md

@@ -0,0 +1,22 @@
+[![Gem Version](https://badge.fury.io/rb/type-heading.svg)](http://badge.fury.io/rb/type-heading)
+
+# Type Heading - Alpha
+
+A responsive typography tool.
+
+**Note:** Type heading is currently in [Alpha](http://en.wikipedia.org/wiki/Software_release_life_cycle#Alpha).
+Currently, Type Heading should only be used for testing and/or development, not
+production work.
+
+## Requirements
+
+To use Type Heading, you will need at least:
+
+- Ruby: 2.1.5
+- Sass 3.3.13
+- Compass 1.0.1
+
+## Get Started
+
+* [Github](https://github.com/ellioseven/type-heading)
+* [Documentation](http://ellioseven.github.io/type-heading/)

data/lib/compass-type-heading.rb

@@ -0,0 +1 @@
+require 'type-heading'

data/lib/type-heading.rb

@@ -0,0 +1,14 @@
+base_directory  = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+type_heading_stylesheets_path = File.join(base_directory, 'stylesheets')
+type_heading_templates_path = File.join(base_directory, 'templates')
+
+if (defined? Compass)
+  Compass::Frameworks.register('type-heading', :stylesheets_directory => type_heading_stylesheets_path, :templates_directory => type_heading_templates_path)
+else
+  # compass not found, register on the Sass path via the environment.
+  if ENV.has_key?("SASS_PATH")
+    ENV["SASS_PATH"] = ENV["SASS_PATH"] + File::PATH_SEPARATOR + type_heading_stylesheets_path
+  else
+    ENV["SASS_PATH"] = type_heading_stylesheets_path
+  end
+end

data/stylesheets/_type-heading.scss

@@ -0,0 +1,12 @@
+// Type Heading
+
+// Imports
+// ------------------------------
+
+@import "type-heading/settings";
+@import "type-heading/functions/helpers";
+@import "type-heading/functions/heading";
+@import "type-heading/functions/property";
+@import "type-heading/mixins/breakpoint";
+@import "type-heading/mixins/property";
+@import "type-heading/mixins/heading";

data/stylesheets/type-heading/_settings.scss

@@ -0,0 +1,46 @@
+// Settings
+// 
+// @group Settings
+// @author Elliot Mitchum
+
+// th-base-font-size
+// Font size used for relative calculations.
+//
+// @since 0.0.10
+// @type string
+
+$th-base-font-size: 16px !default;
+
+// th-headings
+// Define headings and their values.
+//
+// @since 0.0.10
+// @type map
+
+$th-headings: () !default;
+
+// th-property-defaults
+// Define default property values.
+//
+// @since 0.0.10
+// @type map
+
+$th-property-defaults: (
+  font-size: 16px,
+  line-height: 24px,
+  margin-top: 20px,
+  margin-bottom: 20px
+) !default;
+
+// th-property-defaults
+// Define units for heading properties.
+//
+// @since 0.0.11
+// @type map
+
+$th-property-units: (
+  font-size: false,
+  line-height: false,
+  margin-top: false,
+  margin-bottom: false
+) !default;

data/stylesheets/type-heading/functions/_heading.scss

@@ -0,0 +1,141 @@
+// Heading
+// 
+// @group Functions / Heading
+// @author Elliot Mitchum
+
+// th-heading
+// Return a heading list.
+//
+// @since 0.0.10
+// @type function
+//
+// @requires {function} th-heading-get-map
+// @requires {function} _th-heading-has-next
+// @requires {function} _th-heading-get-next
+//
+// @param {list | string} $heading A heading map key or list (required).
+// @param {number} $breakpoint A heading list breakpoint.
+//
+// @returns {list} A heading list.
+//
+// @example scss Return a heading list.
+// // // h1: (10px 20px (30px 40px), 50px 60px (70px 80px) 768px)
+// // th-heading(h1)
+// // // 10px 20px (30px 40px)
+// // @example scss Return a heading list with breakpoint.
+// // // h1: (10px 20px (30px 40px), 50px 60px (70px 80px) 768px)
+// // th-heading(h1, 768px)
+// // // 50px 60px (70px 80px) 768px
+
+@function th-heading(
+  $heading,
+  $breakpoint: false
+){
+  $_return: $heading;
+  @if string == type-of($heading) {
+    $_return: th-heading-get-map($heading);
+    @if _th-heading-has-next($_return) {
+      $_return: _th-heading-get-next($_return, $breakpoint);
+    }
+  }
+  @return $_return;
+}
+
+// th-heading-get-map
+// Return a heading map.
+//
+// @since 0.0.10
+// @type function
+//
+// @param {string} $heading A heading map key (required).
+//
+// @returns {list} A heading map.
+//
+// @example scss Return h1 heading map.
+// // // h1: (10px 20px (30px 40px), 50px 60px (70px 80px) 768px)
+// // th-heading-get-map(h1)
+// // // 10px 20px (30px 40px), 50px 60px (70px 80px) 768px
+
+@function th-heading-get-map(
+  $heading
+){
+  $_return: $heading;
+  @if string == type-of($heading) and map-has-key($th-headings, $heading) {
+    $_return: map-get($th-headings, $heading);
+  }
+  @return $_return;
+}
+
+// _th-heading-has-next
+// Check a for multiple heading lists.
+//
+// @since 0.0.10
+// @type function
+// @access private
+// 
+// @requires {function} th-heading-get-map
+//
+// @param {list | string} $heading A heading map key or list (required).
+//
+// @returns {boolean} If heading map contains multiple lists.
+//
+// @example scss Check heading with next.
+// // // h1: (10px 20px (30px 40px), 50px 60px (70px 80px) 768px)
+// // _th-heading-has-next(h1)
+// // // true
+// @example scss Check heading without next.
+// // // h5: (10px 20px (30px 40px))
+// // _th-heading-has-next(h5)
+// // // false
+
+@function _th-heading-has-next(
+  $heading
+){
+  $_return: false;
+  $heading: th-heading-get-map($heading);
+  @if list-separator($heading) == comma { 
+    $_return: true; 
+  }
+  @return $_return;
+}
+
+// _th-heading-get-next
+// Return a heading list by breakpoint.
+//
+// @since 0.0.10
+// @type function
+// @access private
+//
+// @requires {function} th-heading-get-map
+// @requires {function} th-property
+//
+// @param {list | string} $heading A heading map key or list (required).
+// @param {boolean | number} $breakpoint (false) A heading list breakpoint.
+//
+// @returns {list} Heading list.
+//
+// @example scss Return h1 heading map.
+// // // h1: (10px 20px (30px 40px), 50px 60px (70px 80px) 768px)
+// // _th-heading-get-next(h1, 768px)
+// // // 50px 60px (70px 80px) 768px
+
+@function _th-heading-get-next(
+  $heading,
+  $breakpoint: false
+){
+  $_return: $heading;
+  $heading: th-heading-get-map($heading);
+  @if $breakpoint {
+    @each $heading-list in $heading {
+      @if th-property(
+        $heading: $heading-list,
+        $property-name: breakpoint,
+        $convert: false) == $breakpoint {
+        $_return: $heading-list;
+      }
+    }
+  } @else {
+    $_return: nth($heading, 1);
+  }
+  @return $_return;
+}