@graupl/graupl 1.0.0-alpha.9 → 1.0.0-beta.1

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

@@ -1,63 +1,168 @@
-// 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 {
-            --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
+      $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
               )};
-            --#{root-defaults.$prefix}-columns-row-gap: #{important.insert(
+            --#{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-column-gap: #{important.insert(
+                $value
+              )};
+            --#{root-defaults.$prefix}flex-columns-row-gap: #{important.insert(
+                $value
+              )};
           }
-        } @else if $name == "cg" {
-          &.columns {
-            --#{root-defaults.$prefix}-columns-column-gap: #{important.insert(
+        }
+      } @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" {
+        @include utility.create($selector, $property, $value) {
+          &#{columns-defaults.$columns-selector} {
+            --#{root-defaults.$prefix}columns-row-gap: #{important.insert(
+                $value
+              )};
           }
-        } @else if $name == "rg" {
-          &.columns {
-            --#{root-defaults.$prefix}-columns-row-gap: #{important.insert(
+
+          &#{flex-columns-defaults.$flex-columns-selector} {
+            --#{root-defaults.$prefix}flex-columns-row-gap: #{important.insert(
                 $value
               )};
           }
+        }
+      } @else {
+        @include utility.create($selector, $property, $value);
+      }
+    }
+
+    // Create the "auto" utility class.
+    @include utility.create("#{$name}-auto", $property, auto);
+  }
 
-          &:not(.columns) {
-            @each $prop in $property {
-              #{$prop}: important.insert($value);
+  // 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 {
-          @each $prop in $property {
-            #{$prop}: 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;

package/src/scss/utilities/typography/_index.scss

@@ -1,32 +1,46 @@
-// Graupl typography utilities.
+// @graupl/graupl typography 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 "../../mixins/layer" as *;
+@use "../../defaults" as root-defaults;
 @use "../../functions/important";
+@use "../../mixins/layer" as *;
+@use "../../mixins/screen";
+@use "../../mixins/utility";
 @use "../../theme/typography/variables" as typography;
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
 
 @include layer(utilities) {
+  // For each font size property, create a utility class.
   @each $size, $value in typography.$font-sizes {
-    .text-#{$size} {
-      font-size: important.insert($value);
-    }
+    @include utility.create(
+      ".#{defaults.$text-class-prefix}#{$size}",
+      font-size,
+      $value
+    );
   }
 
-  .text-paragraph {
+  // Create utility classes for each type of text style in Graupl.
+  // These will apply not only the font size, but also the margin, font weight, and line height.
+  // This will allow for a more consistent and maintainable typography system.
+  .#{defaults.$text-class-prefix}paragraph {
     margin: important.insert(typography.$paragraph-margin);
     font-size: important.insert(typography.$paragraph-font-size);
     font-weight: important.insert(typography.$paragraph-font-weight);
     line-height: important.insert(typography.$paragraph-line-height);
   }
 
-  .text-small {
+  .#{defaults.$text-class-prefix}small {
     margin: important.insert(typography.$small-margin);
     font-size: important.insert(typography.$small-font-size);
     font-weight: important.insert(typography.$small-font-weight);
     line-height: important.insert(typography.$small-line-height);
   }
 
-  .text-h1 {
+  .#{defaults.$text-class-prefix}h1 {
     margin: important.insert(typography.$h1-margin);
     font-family: important.insert(typography.$h1-font-family);
     font-size: important.insert(typography.$h1-font-size);
@@ -34,7 +48,7 @@
     line-height: important.insert(typography.$h1-line-height);
   }
 
-  .text-h2 {
+  .#{defaults.$text-class-prefix}h2 {
     margin: important.insert(typography.$h2-margin);
     font-family: important.insert(typography.$h2-font-family);
     font-size: important.insert(typography.$h2-font-size);
@@ -42,7 +56,7 @@
     line-height: important.insert(typography.$h2-line-height);
   }
 
-  .text-h3 {
+  .#{defaults.$text-class-prefix}h3 {
     margin: important.insert(typography.$h3-margin);
     font-family: important.insert(typography.$h3-font-family);
     font-size: important.insert(typography.$h3-font-size);
@@ -50,7 +64,7 @@
     line-height: important.insert(typography.$h3-line-height);
   }
 
-  .text-h4 {
+  .#{defaults.$text-class-prefix}h4 {
     margin: important.insert(typography.$h4-margin);
     font-family: important.insert(typography.$h4-font-family);
     font-size: important.insert(typography.$h4-font-size);
@@ -58,7 +72,7 @@
     line-height: important.insert(typography.$h4-line-height);
   }
 
-  .text-h5 {
+  .#{defaults.$text-class-prefix}h5 {
     margin: important.insert(typography.$h5-margin);
     font-family: important.insert(typography.$h5-font-family);
     font-size: important.insert(typography.$h5-font-size);
@@ -66,7 +80,7 @@
     line-height: important.insert(typography.$h5-line-height);
   }
 
-  .text-h6 {
+  .#{defaults.$text-class-prefix}h6 {
     margin: important.insert(typography.$h6-margin);
     font-family: important.insert(typography.$h6-font-family);
     font-size: important.insert(typography.$h6-font-size);
@@ -74,19 +88,137 @@
     line-height: important.insert(typography.$h6-line-height);
   }
 
-  // Font weight utilities.
+  // For each font weight property, create a utility class.
   @each $size, $value in typography.$font-weights {
-    .font-#{$size} {
-      font-weight: important.insert($value);
-    }
+    @include utility.create(
+      ".#{defaults.$font-weight-class-prefix}#{$size}",
+      font-weight,
+      $value
+    );
   }
 
-  // Font style utilities.
-  .font-italic {
-    font-style: important.insert(italic);
+  // For each font style property, create a utility class.
+  @each $size, $value in defaults.$font-style-properties {
+    @include utility.create(
+      ".#{defaults.$font-style-class-prefix}#{$size}",
+      font-style,
+      $value
+    );
   }
 
-  .font-not-italic {
-    font-style: important.insert(normal);
+  // Generate responsive utilities.
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      // For each font size property, create a utility class.
+      @each $size, $value in typography.$font-sizes {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}#{$size}",
+          font-size,
+          $value,
+          $screen-size
+        );
+      }
+
+      // Create utility classes for each type of text style in Graupl.
+      // These will apply not only the font size, but also the margin, font weight, and line height.
+      // This will allow for a more consistent and maintainable typography system.
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}paragraph {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$paragraph-margin);
+          font-size: important.insert(typography.$paragraph-font-size);
+          font-weight: important.insert(typography.$paragraph-font-weight);
+          line-height: important.insert(typography.$paragraph-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}small {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$small-margin);
+          font-size: important.insert(typography.$small-font-size);
+          font-weight: important.insert(typography.$small-font-weight);
+          line-height: important.insert(typography.$small-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h1 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h1-margin);
+          font-family: important.insert(typography.$h1-font-family);
+          font-size: important.insert(typography.$h1-font-size);
+          font-weight: important.insert(typography.$h1-font-weight);
+          line-height: important.insert(typography.$h1-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h2 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h2-margin);
+          font-family: important.insert(typography.$h2-font-family);
+          font-size: important.insert(typography.$h2-font-size);
+          font-weight: important.insert(typography.$h2-font-weight);
+          line-height: important.insert(typography.$h2-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h3 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h3-margin);
+          font-family: important.insert(typography.$h3-font-family);
+          font-size: important.insert(typography.$h3-font-size);
+          font-weight: important.insert(typography.$h3-font-weight);
+          line-height: important.insert(typography.$h3-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h4 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h4-margin);
+          font-family: important.insert(typography.$h4-font-family);
+          font-size: important.insert(typography.$h4-font-size);
+          font-weight: important.insert(typography.$h4-font-weight);
+          line-height: important.insert(typography.$h4-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h5 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h5-margin);
+          font-family: important.insert(typography.$h5-font-family);
+          font-size: important.insert(typography.$h5-font-size);
+          font-weight: important.insert(typography.$h5-font-weight);
+          line-height: important.insert(typography.$h5-line-height);
+        }
+      }
+
+      .#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$text-class-prefix}h6 {
+        @include screen.up($screen-size) {
+          margin: important.insert(typography.$h6-margin);
+          font-family: important.insert(typography.$h6-font-family);
+          font-size: important.insert(typography.$h6-font-size);
+          font-weight: important.insert(typography.$h6-font-weight);
+          line-height: important.insert(typography.$h6-line-height);
+        }
+      }
+
+      // For each font weight property, create a utility class.
+      @each $size, $value in typography.$font-weights {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$font-weight-class-prefix}#{$size}",
+          font-weight,
+          $value,
+          $screen-size
+        );
+      }
+
+      // For each font style property, create a utility class.
+      @each $size, $value in defaults.$font-style-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$font-style-class-prefix}#{$size}",
+          font-style,
+          $value,
+          $screen-size
+        );
+      }
+    }
   }
 }

package/src/scss/utilities/typography/_variables.scss

@@ -1,3 +1,6 @@
-// Variables referencing custom properties.
+// @graupl/graupl typography 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/visibility/_defaults.scss

@@ -0,0 +1,25 @@
+// @graupl/graupl visibility 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";
+
+// Visibility properties.
+$visibility-class-prefix: "visibility-" !default;
+$base-visibility-properties: (
+  visible: visible,
+  hidden: hidden,
+  collapse: collapse,
+);
+$custom-visibility-properties: () !default;
+$visibility-properties: map.merge(
+  $base-visibility-properties,
+  $custom-visibility-properties
+);
+
+// Responsive utility flag.
+$responsive: true !default;

package/src/scss/utilities/visibility/_index.scss

@@ -0,0 +1,36 @@
+// @graupl/graupl visibility 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 visibility property, create a utility class.
+  @each $name, $value in defaults.$visibility-properties {
+    @include utility.create(
+      ".#{defaults.$visibility-class-prefix}#{$name}",
+      visibility,
+      $value
+    );
+  }
+
+  // Generate responsive utilities.
+  @if defaults.$responsive {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      @each $name, $value in defaults.$visibility-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$visibility-class-prefix}#{$name}",
+          visibility,
+          $value,
+          $screen-size
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/visibility/_variables.scss

@@ -0,0 +1,6 @@
+// @graupl/graupl visibility 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/width/_defaults.scss

@@ -0,0 +1,41 @@
+// @graupl/graupl width 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";
+
+// Width properties.
+$width-class-prefix: "w-" !default;
+$max-width-class-prefix: "max-w-" !default;
+$min-width-class-prefix: "min-w-" !default;
+
+// Width values.
+$base-width-values: (
+  auto: auto,
+  fit-content: fit-content,
+  max-content: max-content,
+  min-content: min-content,
+  stretch: stretch,
+  0: 0,
+  full: 100%,
+  quarter: 25%,
+  half: 50%,
+  three-quarters: 75%,
+  third: calc(100% / 3),
+  two-thirds: calc(100% / 1.5),
+  half-screen: 50vw,
+  third-screen: calc(100vw / 3),
+  two-thirds-screen: calc(100vw / 1.5),
+  quarter-screen: 25vw,
+  three-quarters-screen: 75vw,
+  full-screen: 100vw,
+);
+$custom-width-values: () !default;
+$width-values: map.merge($base-width-values, $custom-width-values);
+
+// Responsive utility flag.
+$responsive: false !default;