type-heading 0.0.14 → 0.0.16

data/stylesheets/type-heading/mixins/_property.scss

@@ -41,67 +41,21 @@
 ///   )
 
 @mixin th-property(
-  $heading,
   $property-name,
+  $heading,
   $breakpoint: false,
   $convert: true,
   $base-font-size: $th-base-font-size
 ){
   @if font-size != $property-name {
-    $base-font-size: _th-property-base($heading, $breakpoint, $base-font-size);
-  }
-  @if th-list-has($_th-core-properties, $property-name) {
-    $breakpoint: _th-core-breakpoint-context($breakpoint);
-    #{$property-name}: call(th-property-#{$property-name},
-      $heading: $heading,
-      $breakpoint: $breakpoint,
-      $convert: $convert,
-      $base-font-size: $base-font-size
+    $base-font-size: _th-property-base(
+      $heading,
+      $breakpoint,
+      $base-font-size
     );
   }
-}
-
-//  th-property-font-size()
-/// Output heading font size styles.
-///
-/// @since 0.0.10
-///
-/// @param {string} $heading - A heading map key.
-/// @param {number | boolean} $breakpoint [false] - A heading list breakpoint.
-/// @param {boolean | string} $convert [true] - (false | px | em | rem | rel | percent) - If returned value should be unit converted or overridden.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
-///
-/// @example scss - Output h1 font size styles.
-///   @include th-property-font-size(h1)
-/// @example scss - Output h1 font size styles with 768px breakpoint.
-///   @include th-property-font-size(
-///     $heading: h1,
-///     $breakpoint: 768px
-///   )
-/// @example scss - Output h1 font size styles without unit conversion.
-///   @include th-property-font-size(
-///     $heading: h1,
-///     $convert: false
-///   )
-/// @example scss - Output h1 font size styles and unit override to percent.
-///   @include th-property-font-size(
-///     $heading: h1,
-///     $convert: percent
-///   )
-/// @example scss - Output h1 font size with a base font size of 24px.
-///   @include th-property-font-size(
-///     $heading: h1,
-///     $base-font-size: 24px
-///   )
-
-@mixin th-property-font-size(
-  $heading,
-  $breakpoint: false,
-  $convert: true,
-  $base-font-size: $th-base-font-size
-){
-  @include th-property(
-    $property-name: font-size,
+  #{$property-name}: th-property(
+    $property-name: $property-name,
     $heading: $heading,
     $breakpoint: $breakpoint,
     $convert: $convert,
@@ -109,146 +63,20 @@
   );
 }
 
-//  th-property-line-height()
-/// Output heading line height styles.
-///
-/// @since 0.0.10
-///
-/// @param {string} $heading - A heading map key.
-/// @param {number | boolean} $breakpoint [false] - A heading list breakpoint.
-/// @param {boolean | string} $convert [true] - (false | px | em | rem | rel | percent) If returned value should be unit converted or overridden.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
+//  th-p()
+/// Alias to th-property() mixin.
 ///
-/// @example scss - Output h1 line height styles.
-///   @include th-property-line-height(h1)
-/// @example scss - Output h1 line height styles with 768px breakpoint.
-///   @include th-property-line-height(
-///     $heading: h1,
-///     $breakpoint: 768px
-///   )
-/// @example scss - Output h1 line height styles without unit conversion.
-///   @include th-property-line-height(
-///     $heading: h1,
-///     $convert: false
-///   )
-/// @example scss - Output h1 line height styles and unit override to percent.
-///   @include th-property-line-height(
-///     $heading: h1,
-///     $convert: percent
-///   )
-/// @example scss - Output h1 line height with a base font size of 24px.
-///   @include th-property-line-height(
-///     $heading: h1,
-///     $base-font-size: 24px
-///   )
+/// @since 0.0.15
 
-@mixin th-property-line-height(
-  $heading,
-  $breakpoint: false,
-  $convert: true,
-  $base-font-size: $th-base-font-size
-){
-  $base-font-size: _th-property-base($heading, $breakpoint, $base-font-size);
-  @include th-property(
-    $property-name: line-height,
-    $heading: $heading,
-    $breakpoint: $breakpoint,
-    $convert: $convert,
-    $base-font-size: $base-font-size
-  );
-}
-
-//  th-property-margin-top()
-/// Output heading margin top styles.
-///
-/// @since 0.0.10
-///
-/// @param {string} $heading - A heading map key.
-/// @param {number | boolean} $breakpoint [false] - A heading list breakpoint.
-/// @param {boolean | string} $convert [true] - (false | px | em | rem | rel | percent) If returned value should be unit converted or overridden.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
-///
-/// @example scss - Output h1 margin top styles.
-///   @include th-property-margin-top(h1)
-/// @example scss - Output h1 margin top styles with 768px breakpoint.
-///   @include th-property-margin-top(
-///     $heading: h1,
-///     $breakpoint: 768px
-///   )
-/// @example scss - Output h1 margin top styles without unit conversion.
-///   @include th-property-margin-top(
-///     $heading: h1,
-///     $convert: false
-///   )
-/// @example scss - Output h1 margin top styles and unit override to percent.
-///   @include th-property-margin-top(
-///     $heading: h1,
-///     $convert: percent
-///   )
-/// @example scss - Output h1 margin top with a base font size of 24px.
-///   @include th-property-margin-top(
-///     $heading: h1,
-///     $base-font-size: 24px
-///   )
-
-@mixin th-property-margin-top(
-  $heading,
-  $breakpoint: false,
-  $convert: true,
-  $base-font-size: $th-base-font-size
-){
-  $base-font-size: _th-property-base($heading, $breakpoint, $base-font-size);
-  @include th-property(
-    $property-name: margin-top,
-    $heading: $heading,
-    $breakpoint: $breakpoint,
-    $convert: $convert,
-    $base-font-size: $base-font-size
-  );
-}
-
-//  th-property-margin-bottom()
-/// Output heading margin bottom styles.
-///
-/// @since 0.0.10
-///
-/// @param {string} $heading - A heading map key.
-/// @param {number | boolean} $breakpoint [false] - A heading list breakpoint.
-/// @param {boolean | string} $convert [true] - (false | px | em | rem | rel | percent) If returned value should be unit converted or overridden.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
-///
-/// @example scss - Output h1 margin bottom styles.
-///   @include th-property-margin-bottom(h1)
-/// @example scss - Output h1 margin bottom styles with 768px breakpoint.
-///   @include th-property-margin-bottom(
-///     $heading: h1,
-///     $breakpoint: 768px
-///   )
-/// @example scss - Output h1 margin bottom styles without unit conversion.
-///   @include th-property-margin-bottom(
-///     $heading: h1,
-///     $convert: false
-///   )
-/// @example scss - Output h1 margin bottom styles and unit override to percent.
-///   @include th-property-margin-bottom(
-///     $heading: h1,
-///     $convert: percent
-///   )
-/// @example scss - Output h1 margin bottom with a base font size of 24px.
-///   @include th-property-margin-bottom(
-///     $heading: h1,
-///     $base-font-size: 24px
-///   )
-
-@mixin th-property-margin-bottom(
+@mixin th-p(
+  $property-name,
   $heading,
   $breakpoint: false,
   $convert: true,
   $base-font-size: $th-base-font-size
 ){
-  $base-font-size: _th-property-base($heading, $breakpoint, $base-font-size);
   @include th-property(
-    $property-name: margin-bottom,
+    $property-name: $property-name,
     $heading: $heading,
     $breakpoint: $breakpoint,
     $convert: $convert,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: type-heading
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.16
 platform: ruby
 authors:
 - Elliot Mitchum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-23 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -62,12 +62,12 @@ files:
 - lib/type-heading.rb
 - stylesheets/_type-heading.scss
 - stylesheets/type-heading/_settings.scss
-- stylesheets/type-heading/functions/_core.scss
+- stylesheets/type-heading/api/_core.scss
+- stylesheets/type-heading/api/_deprecated.scss
+- stylesheets/type-heading/api/_helpers.scss
 - stylesheets/type-heading/functions/_heading.scss
-- stylesheets/type-heading/functions/_helpers.scss
 - stylesheets/type-heading/functions/_property.scss
 - stylesheets/type-heading/mixins/_breakpoint.scss
-- stylesheets/type-heading/mixins/_core.scss
 - stylesheets/type-heading/mixins/_heading.scss
 - stylesheets/type-heading/mixins/_property.scss
 - templates/project/manifest.rb

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

@@ -1,73 +0,0 @@
-////
-/// Core
-/// @group Core
-////
-
-//  $_th-core-breakpoint-context
-/// Global breakpoint variable for various mixins and functions.
-///
-/// @since 0.0.12
-/// @type Bool | Number
-/// @access private
-
-$_th-core-breakpoint-context: false !default;
-
-//  $_th-core-with
-/// Map of heading property values within a th-with loop.
-///
-/// @since 0.0.14
-/// @see {function} th-with
-/// @type Map
-/// @access private
-
-$_th-core-with: () !default;
-
-//  $_th-core-properties
-/// List of available heading property names.
-///
-/// @since 0.0.14
-/// @type List
-/// @access private
-
-$_th-core-properties: (margin-top margin-bottom font-size line-height);
-
-//  _th-core-breakpoint-context()
-/// Return either contextual breakpoint if set or current breakpoint value.
-///
-/// @since 0.0.12
-/// @return {number} Current or contextual breakpoint.
-///
-/// @param {number} $breakpoint - A heading breakpoint.
-
-@function _th-core-breakpoint-context(
-  $breakpoint
-){
-  @if global-variable-exists('_th-core-breakpoint-context') and $_th-core-breakpoint-context {
-    @return $_th-core-breakpoint-context;
-  } @else {
-    @return $breakpoint;
-  }
-}
-
-//  th-with-get()
-/// Return a heading property value within a th-with loop.
-///
-/// @since 0.0.14
-/// @see {mixin} th-with
-/// @return {number} Heading property value.
-///
-/// @param {string} $property-name - Name of the heading property to return.
-///
-/// @example scss - Return font size from within a th-with loop.
-///  @include th-with(h1) {
-///    font-size: th-with-get(font-size);
-///  }
-///  // font-size: 18px;
-
-@function th-with-get(
-  $property-name
-){
-  @if $_th-core-with {
-    @return map-get($_th-core-with, $property-name);
-  }
-}

data/stylesheets/type-heading/mixins/_core.scss

@@ -1,154 +0,0 @@
-////
-/// Core
-/// @group Core
-////
-
-// _th-core-breakpoint-context
-/// Global breakpoint variable for various mixins and functions.
-///
-/// @since 0.0.12
-/// @type Bool | Number
-/// @access private
-
-$_th-core-breakpoint-context: false !default;
-
-// _th-core-with
-/// Map of heading property values within a th-with loop.
-///
-/// @since 0.0.14
-/// @see {function} th-with
-/// @type Map
-/// @access private
-
-$_th-core-with: () !default;
-
-// th-with-breakpoint()
-/// Use a breakpoint for a section of code.
-///
-/// @since 0.0.12
-/// @content
-///
-/// @param {number} $breakpoint - A heading list breakpoint.
-///
-/// @example scss - Output a heading with a 768px breakpoint.
-///   @include th-with-breakpoint(768px) {
-///     @include th-heading(h1);
-///   }
-
-@mixin th-with-breakpoint(
-  $breakpoint
-){
-  $cache: $_th-core-breakpoint-context;
-  $_th-core-breakpoint-context: $breakpoint !global;
-  @content;
-  $_th-core-breakpoint-context: $cache !global;
-}
-
-// _th-heading-loop
-/// Loops through a heading map and outputs @content with breakpoint context.
-///
-/// @since 0.0.14
-/// @access private
-/// @content
-///
-/// @param {type} $name
-/// @param {list | string} $heading - A heading map key or list.
-
-@mixin _th-heading-loop(
-  $heading
-){
-  $heading-map: th-heading-get-map($heading);
-  @if _th-heading-has-next($heading-map) {
-    @each $heading-list in $heading-map {
-      $breakpoint: _th-property-get($heading-list, breakpoint);
-      @if $breakpoint {
-        @include th-breakpoint($breakpoint, $breakpoint) {
-          @content;
-        }
-      } @else {
-        @content;
-      }
-    }
-  } @else {
-    @content;
-  }
-}
-
-// _th-with-var-set()
-/// Sets $_th-core-with global variable with contextual heading property values.
-///
-/// @since 0.0.14
-/// @see th-with
-/// @access private
-///
-/// @param {list} $heading-list - A list of heading property values.
-/// @param {boolean} $convert [false] - If returned value should be unit converted.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
-
-@mixin _th-with-var-set(
-  $heading-list,
-  $convert: false,
-  $base-font-size: $th-base-font-size
-){
-  $th-with-vars: ();
-  $font-size: th-property-font-size(
-    $heading: $heading-list,
-    $base-font-size: $base-font-size,
-    $convert: false
-  );
-  @each $property in $_th-core-properties {
-    $base: th-if(font-size == $property, $base-font-size, $font-size);
-    $th-with-vars: map-merge($th-with-vars, (
-      $property: call(th-property-#{$property},
-        $heading: $heading-list,
-        $convert: $convert,
-        $base-font-size: $base
-      ))
-    );
-  }
-  $_th-core-with: $th-with-vars !global;
-}
-
-// _th-with-var-reset()
-/// Resets $th-with-vars global variable.
-///
-/// @since 0.0.14
-/// @access private
-
-@mixin _th-with-var-reset {
-  $_th-core-with: false !global;
-}
-
-// th-with()
-/// Loop through a headings breakpoints with access to it's
-/// property values as a global variable. $th-font-size, $th-line-height,
-/// $th-margin-top, $th-margin-bottom will become available to you within the
-/// mixin.
-///
-/// @since 0.0.14
-/// @see {function} th-with-get
-/// @content [Styles for the contextual heading list]
-///
-/// @param {list | string} $heading - A heading map key or list.
-/// @param {boolean} $convert [false] - If returned value should be unit converted.
-/// @param {number} $base-font-size [$th-base-font-size] - Font size used for relative calculations.
-///
-/// @example scss - Output font-size, line-height, margin-top and margin-bottom properties individually for a heading.
-///   @include th-with(h1) {
-///     margin-top: th-with-get(margin-top);
-///     margin-bottom: th-with-get(margin-bottom);
-///     font-size: th-with-get(font-size);;
-///     line-height: th-with-get(line-height);
-///   }
-
-@mixin th-with(
-  $heading,
-  $convert: false,
-  $base-font-size: $th-base-font-size
-){
-  @include _th-heading-loop($heading) {
-    @include _th-with-var-set($heading, $convert, $base-font-size);
-    @content;
-    @include _th-with-var-reset;
-  }
-}