✨ (card-pattern, proportional-box) adds card pattern, error messages

Bumps version to 0.3.0

README.md

@@ -17,6 +17,15 @@ Resources:
 yarn add @evanshunt/derekstrap;
 ```
 
+# Development
+
+If making any javascript changes, a `yarn build` needs to be run before commit. To install the included pre-commit hook, run the following from the project root:
+
+```
+cp pre-commit.sh .git/hooks/pre-commit
+chmod +x .git/hooks/pre-commit
+```
+
 ## Usage
 
 ### With @import
@@ -55,13 +64,14 @@ Breakpoints.init(breakpointList);
 
 SubModules
 
-* [Breakpoints](#Breakpoints)
+* [Breakpoints](#breakpoints)
 * [debounce.js](#debounce-js)
-* [Proportional Box](#Proportional-Box)
-* [Proportional Text](#Proportional--Text)
-* [setUserAgent.js](#setUserAgent-js)
-* [Spacing](#Spacing)
-* [Text Sizing](#Text-Sizing)
+* [Proportional Box](#proportional-box)
+* [Proportional Text](#proportional-text)
+* [setUserAgent.js](#setuseragent-js)
+* [Spacing](#spacing)
+* [Text Sizing](#text-sizing)
+* [Card Pattern](#card-pattern)
 
 JS features
 
@@ -172,11 +182,12 @@ See [src/Breakpoints.js](src/Breakpoints.js) for another example.
 
 The proportional box module is intended to allow you to define an aspect ratio for an element. Often useful for elements which have a background image. The module consists of 3 mixins, two of which are helper methods for `proportional-box()` which is the one you will most likely use in your project.
 
-The method takes 3 arguments. The `$view-width` and `$offset` arguments are optional and will depend on other styles applied to the element in order to function properly. By default the mixin assumes a full-bleed element. The opional arguments are there to configure an element that is not full bleed.
+The method takes 3 arguments. All arguments except `$aspect-ratio` are optional and will depend on other styles applied to the element in order to function properly. By default the mixin assumes a full-bleed element. The opional arguments are there to configure an element that is not full bleed.
+
+All arguments will accept a single value or a breakpoint map. If passing a breakpoint map to more than one argument ensure all breakpoint maps include the exact same breakpoints.
 
 * `$aspect-ratio`: Width / height, probably best written as an expression which evaluates to a number, e.g. `16 / 9` rather than `1.77777`. (required)
-* `$view-width`: Defaults to `100vw`. This argument should be the proportion of the viewport widht the element takes up, excluding fixed margins. If the element takes up 100% of the viewport except for a 50px margin on each side, the value here should still be `100vw`. Only pass a different value here if the image is not proportional to the entire viewport. If it should be `50vw` wide (excluding fixed margins) then pass `50vw`. (optional)
-* `$offset`: Defaults to `0px`. This is the place to define fixed width margins. The value passed should reflect the margin _on one side_ of the element. It will be multiplied by 2 in the mixin. This logic assumes identical left and right margins. If that is not the case the offset value should be (left margin + right margin) / 2.
+* `$view-width`: Defaults to `100vw`. This argument should be the proportion of the viewport widht the element (or it's parent) takes up, excluding fixed margins. If the element takes up 100% of the viewport except for a 50px margin on each side, the value here should still be `100vw`. Only pass a different value here if the image is not proportional to the entire viewport. If it should be `50vw` wide (excluding fixed margins) then pass `50vw`. (optional)
 
 The following background image properties are added to the element using this mixin:
 
@@ -186,6 +197,7 @@ background-repeat: no-repeat;
 background-position: center;
 ```
 
+<!-- @TODO: add multi-breakpoint examples -->
 #### Example usage
 
 ```
@@ -273,4 +285,45 @@ Note that when the spacing is applied to only one side the element, the opposite
     @include derekstrap.horizontal-spacing($regular-margins, 'left');
     @include derekstrap.vertical-spacing($section-spacing, 'top');
 }
-```
+```
+
+### Card Pattern
+
+The card pattern module includes a mixin to quickly generate a common card layout pattern using flexbox. It sets the size and margins of both parent and child elements and allows passing breakpoint maps for arguments to create a responsive layout. If you pass more than one breakpoint map as an argument, ensure they contain the exact same breakpoints and that all included breakpoints have been configured in the $breakpointList variable.
+
+### Example Usage 
+
+```
+@use '~@evanshunt/derekstrap';
+
+// This will create a 4 column layout with a 2rem gutter and 3rem space between rows
+.parent-element {
+    @include derekstrap.card-pattern('.child-selector', 4, 2rem, 3rem);
+}
+
+// This will create a layout with a varying number of columns depending on breakpoint
+.parent-element {
+    @include derekstrap.card-pattern('.child-selector', (
+        'base': 1,
+        'tablet': 2,
+        'desktop': 3
+    ), 2rem, 3rem);
+}
+
+// This will create a layout with varying columns and gutter size
+.parent-element {
+    @include derekstrap.card-pattern(
+        '.child-selector',
+        (
+            'base': 1,
+            'tablet': 2,
+            'desktop': 3
+        ),
+        (
+            'base': 2rem,
+            'tablet': 1rem,
+            'desktop': 0.5rem
+        ),
+        3rem
+    );
+}

_index.scss

@@ -1,5 +1,7 @@
+// The order is importent here to avoid errors on compile
 @forward 'breakpoints/index';
 @forward 'text-sizing/index';
+@forward 'proportional-box/index';
 @forward 'proportional-text/index';
 @forward 'spacing/index';
-@forward 'proportional-box/index';
+@forward 'card-pattern/index';

card-pattern/_index.scss

@@ -0,0 +1 @@
+@forward 'mixins';

card-pattern/_mixins.scss

@@ -0,0 +1,66 @@
+@use 'sass:meta';
+@use 'sass:map';
+@use '~breakpoint-sass/stylesheets/breakpoint' as *;
+@use '../breakpoints/index' as *;
+
+@mixin card-pattern($child-selector, $columns, $gutter: 0, $row-space: 0) {
+    @if (meta.type-of($columns) == 'map') {
+        @include card-pattern-responsive($columns, $child-selector, $columns, $gutter, $row-space);
+    } @else if (meta.type-of($gutter) == 'map') {
+        @include card-pattern-responsive($gutter, $child-selector, $columns, $gutter, $row-space);
+    } @else if (meta.type-of($row-space) == 'map') {
+        @include card-pattern-responsive($row-space, $child-selector, $columns, $gutter, $row-space);
+    } @else {
+        @include card-layout($child-selector, $columns, $gutter, $row-space)
+    }
+}
+
+@mixin card-pattern-responsive($sizes, $child-selector, $columns, $gutter, $row-space) {
+    @each $breakpoint, $size in $sizes {
+        $bp-columns: $columns;
+        @if (meta.type-of($columns) == 'map') {
+            $bp-columns: map.get($columns, $breakpoint)
+        }
+
+        $bp-gutter: $gutter;
+        @if (meta.type-of($gutter) == 'map') {
+            $bp-gutter: map.get($gutter, $breakpoint)
+        }
+
+        $bp-row-space: $row-space;
+        @if (meta.type-of($row-space) == 'map') {
+            $bp-row-space: map.get($row-space, $breakpoint)$child-selector,
+        }
+
+        @if $breakpoint == 'base' {
+            @include card-layout($child-selector, $bp-columns, $bp-gutter, $bp-row-space);
+        } @else {
+            @include breakpoint(map-get($breakpointList, $breakpoint)) {
+                @include card-layout($child-selector, $bp-columns, $bp-gutter, $bp-row-space);
+            }
+        }
+    }
+}
+
+@mixin card-layout($child-selector, $columns, $gutter, $row-space) {
+    @if (meta.type-of($columns) == 'null') {
+        @error "$columns undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+    @if (meta.type-of($gutter) == 'null') {
+        @error "$gutter undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+    @if (meta.type-of($row-space) == 'null') {
+        @error "$row-space undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+
+    width: calc(100% + #{$gutter}); // possibly unneccessary
+    padding: 0;
+    margin: (-1 * $row-space / 2) (-1 * $gutter / 2);
+    display: flex;
+    flex-flow: row wrap;
+
+    #{$child-selector} {
+        margin: ($row-space / 2) ($gutter / 2);
+        width: calc(100% / #{$columns} - #{$gutter});
+    }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evanshunt/derekstrap",
-  "version": "0.2.3",
+  "version": "0.3.0",
   "description": "A base layout and styles library by Evans Hunt",
   "main": "dist/main.js",
   "sass": "_index.scss",

pre-commit.sh

@@ -0,0 +1,2 @@
+yarn build;
+git add dist;

proportional-box/_mixins.scss

@@ -23,6 +23,16 @@
 }
 
 @mixin proportional-height($aspect-ratio, $vw, $offset) {
+    @if (meta.type-of($aspect-ratio) == 'null') {
+        @error "$aspect-ratio undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+    @if (meta.type-of($vw) == 'null') {
+        @error "$vw undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+    @if (meta.type-of($offset) == 'null') {
+        @error "$offset undefined. Ensure all maps passed as arguments contain the same breakpoints.";
+    }
+
     height: calc(#{1 / $aspect-ratio} * (#{$vw} - 2 * #{$offset}));
 }