@graupl/graupl 1.0.0-alpha.8 → 1.0.0-beta.0

package/src/scss/utilities/order/_index.scss

@@ -0,0 +1,63 @@
+// @graupl/graupl order utilities styles.
+//
+// Responsive class must be within their own loop to prevent specificity issues.
+// This keeps responsive specificity tied to screen size before property order.
+
+@use "../../defaults" as root-defaults;
+@use "../../layout/columns/defaults" as columns-defaults;
+@use "../../layout/flex-columns/defaults" as flex-columns-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  $order-max-count: 0;
+
+  /* stylelint-disable scss/operator-no-newline-after -- Prettier wants to format it this way. */
+  @if (
+    columns-defaults.$columns-max-count >
+      flex-columns-defaults.$flex-columns-max-count
+  ) {
+    $order-max-count: columns-defaults.$columns-max-count;
+  } @else {
+    $order-max-count: flex-columns-defaults.$flex-columns-max-count;
+  }
+  /* stylelint-enable  scss/operator-no-newline-after */
+
+  @each $order-property, $order-value in defaults.$order-properties {
+    @include utility.create(
+      ".#{defaults.$order-class-prefix}#{$order-property}",
+      order,
+      $order-value
+    );
+  }
+
+  @for $i from 1 through $order-max-count {
+    @include utility.create(".#{defaults.$order-class-prefix}#{$i}", order, $i);
+  }
+
+  // Generate responsive utilities.
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      @each $order-property, $order-value in defaults.$order-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$order-class-prefix}#{$order-property}",
+          order,
+          $order-value,
+          $screen-size
+        );
+      }
+
+      @for $i from 1 through $order-max-count {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$order-class-prefix}#{$i}",
+          order,
+          $i,
+          $screen-size
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/order/_variables.scss

@@ -0,0 +1,6 @@
+// @graupl/graupl order utilities variables.
+//
+// These values are to be used to directly style components and provide a
+// cleaner way to reference custom properties.
+
+@use "defaults";

package/src/scss/utilities/position/_defaults.scss

@@ -0,0 +1,26 @@
+// @graupl/graupl position utilities default values.
+//
+// Generally, these should not be used directly when styling components unless a static value is needed.
+// They are mainly used to provide class selectors, fallbacks for custom properties, or loop values.
+//
+// They should not be used to define direct property values (i.e. font-size, color, etc.).
+// Those should be defined as custom properties in the `_variables.scss` file.
+
+@use "sass:map";
+
+$position-class-prefix: "position-" !default;
+$base-position-properties: (
+  static: static,
+  fixed: fixed,
+  absolute: absolute,
+  relative: relative,
+  sticky: sticky,
+);
+$custom-position-properties: () !default;
+$position-properties: map.merge(
+  $base-position-properties,
+  $custom-position-properties
+);
+
+// Responsive utility flag.
+$responsive: false !default;

package/src/scss/utilities/position/_index.scss

@@ -0,0 +1,37 @@
+// @graupl/graupl position utilities styles.
+//
+// Responsive class must be within their own loop to prevent specificity issues.
+// This keeps responsive specificity tied to screen size before property order.
+
+@use "../../defaults" as root-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  // For each position property, create a utility class.
+  @each $name, $property in defaults.$position-properties {
+    @include utility.create(
+      ".#{defaults.$position-class-prefix}#{$name}",
+      position,
+      $property
+    );
+  }
+
+  // Generate responsive utilities.
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      // For each position property, create a utility class.
+      @each $name, $property in defaults.$position-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$position-class-prefix}#{$name}",
+          position,
+          $property,
+          $screen-size
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/position/_variables.scss

@@ -0,0 +1,6 @@
+// @graupl/graupl position utilities variables.
+//
+// These values are to be used to directly style components and provide a
+// cleaner way to reference custom properties.
+
+@use "defaults";

package/src/scss/utilities/ratio/_defaults.scss

@@ -0,0 +1,28 @@
+// @graupl/graupl ratio utilities default values.
+//
+// Generally, these should not be used directly when styling components unless a static value is needed.
+// They are mainly used to provide class selectors, fallbacks for custom properties, or loop values.
+//
+// They should not be used to define direct property values (i.e. font-size, color, etc.).
+// Those should be defined as custom properties in the `_variables.scss` file.
+
+@use "sass:map";
+
+// Ratio utilities.
+$ratio-class: "ratio" !default;
+$ratio-variant-class-prefix: "" !default;
+$force-ratio-class: "force-ratio" !default;
+$base-ratios: (
+  "one-by-one": 100%,
+  "two-by-one": 50%,
+  "four-by-three": 75%,
+  "four-by-one": 25%,
+  "sixteen-by-nine": calc(9 / 16 * 100%),
+  "three-by-two": calc(2 / 3 * 100%),
+  "eight-by-five": calc(5 / 8 * 100%),
+);
+$custom-ratios: () !default;
+$ratios: map.merge($base-ratios, $custom-ratios);
+
+// Responsive utility flag.
+$responsive: false !default;

package/src/scss/utilities/ratio/_index.scss

@@ -0,0 +1,52 @@
+// @graupl/graupl ratio utilities styles.
+//
+// Responsive class must be within their own loop to prevent specificity issues.
+// This keeps responsive specificity tied to screen size before property order.
+
+@use "../../defaults" as root-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/screen";
+@use "../../mixins/utility";
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  .#{defaults.$ratio-class} {
+    position: relative;
+    width: 100%;
+
+    &::before {
+      content: "";
+      display: block;
+      padding-top: $ratio;
+    }
+
+    .#{defaults.$force-ratio-class} {
+      position: absolute;
+      inset: 0;
+      width: 100%;
+      height: 100%;
+      object-fit: cover;
+    }
+  }
+
+  @each $ratio-class, $value in defaults.$ratios {
+    .#{defaults.$ratio-variant-class-prefix}#{$ratio-class} {
+      --#{root-defaults.$prefix}-ratio: #{$value};
+    }
+  }
+
+  // Generate responsive utilities.
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      @each $ratio-class, $value in defaults.$ratios {
+        .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$ratio-variant-class-prefix}#{$ratio-class} {
+          @include screen.up($screen-size) {
+            --#{root-defaults.$prefix}-ratio: #{$value};
+          }
+        }
+      }
+    }
+  }
+}

package/src/scss/utilities/ratio/_variables.scss

@@ -0,0 +1,9 @@
+// @graupl/graupl ratio utilities variables.
+//
+// These values are to be used to directly style components and provide a
+// cleaner way to reference custom properties.
+
+@use "defaults";
+@use "../../defaults" as root-defaults;
+
+$ratio: var(--#{root-defaults.$prefix}-ratio);

package/src/scss/utilities/spacing/_defaults.scss

@@ -1,8 +1,10 @@
-// Default values for Graupl.
+// @graupl/graupl spacing utilities default values.
 //
-// Generally, these should not be used directly when styling components.
-// They are mainly used to provide default fallbacks for custom properties
-// which can be found in the `variables.scss` file.
+// Generally, these should not be used directly when styling components unless a static value is needed.
+// They are mainly used to provide class selectors, fallbacks for custom properties, or loop values.
+//
+// They should not be used to define direct property values (i.e. font-size, color, etc.).
+// Those should be defined as custom properties in the `_variables.scss` file.
 
 @use "sass:map";
 
@@ -42,3 +44,6 @@ $spacing-properties: map.merge(
   $base-spacing-properties,
   $custom-spacing-properties
 );
+
+// Responsive utility flag.
+$responsive: true !default;

package/src/scss/utilities/spacing/_index.scss

@@ -1,21 +1,30 @@
-// Graupl spacing utilities.
+// @graupl/graupl spacing utilities styles.
+//
+// Responsive class must be within their own loop to prevent specificity issues.
+// This keeps responsive specificity tied to screen size before property order.
 
-@use "variables" as *;
-@use "defaults" as defaults;
-@use "../../mixins/layer" as *;
+@use "../../defaults" as root-defaults;
 @use "../../functions/important";
+@use "../../layout/columns/defaults" as columns-defaults;
+@use "../../layout/flex-columns/defaults" as flex-columns-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
 @use "../../variables" as root-variables;
-@use "../../defaults" as root-defaults;
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
 
 @include layer(utilities) {
   // For each spacing property, create a utility class.
   @each $name, $property in defaults.$spacing-properties {
     @each $key, $value in root-variables.$spacers {
-      .#{$name}-#{$key} {
-        // If we're dealing with gap, column-gap, or row-gap inside of .columns, we should update
-        // the columns-column-gap property instead of the raw property.
-        @if $name == "g" {
-          &.columns {
+      $selector: ".#{$name}-#{$key}";
+
+      // If we're dealing with gap, column-gap, or row-gap inside of #{columns-defaults.$columns-selector}, we should update
+      // the columns-column-gap property instead of the raw property.
+      @if $name == "g" {
+        @include utility.create($selector, $property, $value) {
+          &#{columns-defaults.$columns-selector} {
             --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
                 $value
               )};
@@ -24,40 +33,136 @@
               )};
           }
 
-          &:not(.columns) {
-            @each $prop in $property {
-              #{$prop}: important.insert($value);
-            }
+          &#{flex-columns-defaults.$flex-columns-selector} {
+            --#{root-defaults.$prefix}-flex-columns-column-gap: #{important.insert(
+                $value
+              )};
+            --#{root-defaults.$prefix}-flex-columns-row-gap: #{important.insert(
+                $value
+              )};
           }
-        } @else if $name == "cg" {
-          &.columns {
+        }
+      } @else if $name == "cg" {
+        @include utility.create($selector, $property, $value) {
+          &#{columns-defaults.$columns-selector} {
             --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
                 $value
               )};
           }
 
-          &:not(.columns) {
-            @each $prop in $property {
-              #{$prop}: important.insert($value);
-            }
+          &#{flex-columns-defaults.$flex-columns-selector} {
+            --#{root-defaults.$prefix}-flex-columns-column-gap: #{important.insert(
+                $value
+              )};
           }
-        } @else if $name == "rg" {
-          &.columns {
+        }
+      } @else if $name == "rg" {
+        @include utility.create($selector, $property, $value) {
+          &#{columns-defaults.$columns-selector} {
             --#{root-defaults.$prefix}-columns-row-gap: #{important.insert(
                 $value
               )};
           }
 
-          &:not(.columns) {
-            @each $prop in $property {
-              #{$prop}: important.insert($value);
-            }
+          &#{flex-columns-defaults.$flex-columns-selector} {
+            --#{root-defaults.$prefix}-flex-columns-row-gap: #{important.insert(
+                $value
+              )};
           }
-        } @else {
-          @each $prop in $property {
-            #{$prop}: important.insert($value);
+        }
+      } @else {
+        @include utility.create($selector, $property, $value);
+      }
+    }
+
+    // Create the "auto" utility class.
+    @include utility.create("#{$name}-auto", $property, auto);
+  }
+
+  // Generate responsive utilities.
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      @each $name, $property in defaults.$spacing-properties {
+        @each $key, $value in root-variables.$spacers {
+          $selector: ".#{$screen-size}#{root-defaults.$responsive-separator}#{$name}-#{$key}";
+
+          // If we're dealing with gap, column-gap, or row-gap inside of #{columns-defaults.$columns-selector}, we should update
+          // the columns-column-gap property instead of the raw property.
+          @if $name == "g" {
+            @include utility.create(
+              $selector,
+              $property,
+              $value,
+              $screen-size
+            ) {
+              &#{columns-defaults.$columns-selector} {
+                --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
+                    $value
+                  )};
+                --#{root-defaults.$prefix}-columns-row-gap: #{important.insert(
+                    $value
+                  )};
+              }
+
+              &#{flex-columns-defaults.$flex-columns-selector} {
+                --#{root-defaults.$prefix}-flex-columns-column-gap: #{important.insert(
+                    $value
+                  )};
+                --#{root-defaults.$prefix}-flex-columns-row-gap: #{important.insert(
+                    $value
+                  )};
+              }
+            }
+          } @else if $name == "cg" {
+            @include utility.create(
+              $selector,
+              $property,
+              $value,
+              $screen-size
+            ) {
+              &#{columns-defaults.$columns-selector} {
+                --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
+                    $value
+                  )};
+              }
+
+              &#{flex-columns-defaults.$flex-columns-selector} {
+                --#{root-defaults.$prefix}-flex-columns-column-gap: #{important.insert(
+                    $value
+                  )};
+              }
+            }
+          } @else if $name == "rg" {
+            @include utility.create(
+              $selector,
+              $property,
+              $value,
+              $screen-size
+            ) {
+              &#{columns-defaults.$columns-selector} {
+                --#{root-defaults.$prefix}-columns-row-gap: #{important.insert(
+                    $value
+                  )};
+              }
+
+              &#{flex-columns-defaults.$flex-columns-selector} {
+                --#{root-defaults.$prefix}-flex-columns-row-gap: #{important.insert(
+                    $value
+                  )};
+              }
+            }
+          } @else {
+            @include utility.create($selector, $property, $value, $screen-size);
           }
         }
+
+        // Create the "auto" utility class.
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{$name}-auto",
+          $property,
+          auto,
+          $screen-size
+        );
       }
     }
   }

package/src/scss/utilities/spacing/_variables.scss

@@ -1,3 +1,6 @@
-// Variables referencing custom properties.
+// @graupl/graupl spacing utilities variables.
+//
+// These values are to be used to directly style components and provide a
+// cleaner way to reference custom properties.
 
-@forward "defaults";
+@use "defaults";

package/src/scss/utilities/typography/_defaults.scss

@@ -1,5 +1,30 @@
-// Default values for Graupl.
+// @graupl/graupl typography utilities default values.
 //
-// Generally, these should not be used directly when styling components.
-// They are mainly used to provide default fallbacks for custom properties
-// which can be found in the `variables.scss` file.
+// Generally, these should not be used directly when styling components unless a static value is needed.
+// They are mainly used to provide class selectors, fallbacks for custom properties, or loop values.
+//
+// They should not be used to define direct property values (i.e. font-size, color, etc.).
+// Those should be defined as custom properties in the `_variables.scss` file.
+
+@use "sass:map";
+
+// Text size properties.
+$text-class-prefix: "text-" !default;
+
+// Font weight properties.
+$font-weight-class-prefix: "font-" !default;
+
+// Font style properties.
+$font-style-class-prefix: "font-" !default;
+$base-font-style-properties: (
+  normal: normal,
+  italic: italic,
+);
+$custom-font-style-properties: () !default;
+$font-style-properties: map.merge(
+  $base-font-style-properties,
+  $custom-font-style-properties
+);
+
+// Responsive utility flag.
+$responsive: false !default;