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

package/src/scss/utilities/inset/_index.scss

@@ -0,0 +1,37 @@
+// @graupl/graupl inset 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 "../../functions/important";
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  // For each inset property, create a utility class.
+  @each $type, $property in defaults.$inset-properties {
+    @each $name, $value in defaults.$inset-values {
+      @include utility.create(".#{$type}-#{$name}", $property, $value);
+    }
+  }
+
+  @if defaults.$responsive and root-defaults.$responsive-utilities {
+    @each $screen-size in map.keys(root-defaults.$screen-sizes) {
+      // For each inset property, create a utility class.
+      @each $type, $property in defaults.$inset-properties {
+        @each $name, $value in defaults.$inset-values {
+          @include utility.create(
+            ".#{$screen-size}#{root-defaults.$responsive-separator}#{$type}-#{$name}",
+            $property,
+            $value,
+            $screen-size
+          );
+        }
+      }
+    }
+  }
+}

package/src/scss/utilities/inset/_variables.scss

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

@@ -0,0 +1,59 @@
+// @graupl/graupl justification 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";
+
+// Justify content properties.
+$justify-content-class-prefix: "justify-content-" !default;
+$base-justify-content-properties: (
+  normal: normal,
+  start: flex-start,
+  end: flex-end,
+  center: center,
+  between: space-between,
+  around: space-around,
+  evenly: space-evenly,
+  stretch: stretch,
+);
+$custom-justify-content-properties: () !default;
+$justify-content-properties: map.merge(
+  $base-justify-content-properties,
+  $custom-justify-content-properties
+);
+
+// Justify items properties.
+$justify-items-class-prefix: "justify-items-" !default;
+$base-justify-items-properties: (
+  start: start,
+  end: end,
+  center: center,
+  stretch: stretch,
+);
+$custom-justify-items-properties: () !default;
+$justify-items-properties: map.merge(
+  $base-justify-items-properties,
+  $custom-justify-items-properties
+);
+
+// Justify self properties.
+$justify-self-class-prefix: "justify-self-" !default;
+$base-justify-self-properties: (
+  auto: auto,
+  start: start,
+  end: end,
+  center: center,
+  stretch: stretch,
+);
+$custom-justify-self-properties: () !default;
+$justify-self-properties: map.merge(
+  $base-justify-self-properties,
+  $custom-justify-self-properties
+);
+
+// Responsive utility flag.
+$responsive: false !default;

package/src/scss/utilities/justification/_index.scss

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

package/src/scss/utilities/justification/_variables.scss

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

@@ -0,0 +1,39 @@
+// @graupl/graupl list 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";
+
+// List style type properties.
+$list-style-type-class-prefix: "list-style-" !default;
+$base-list-style-type-properties: (
+  none: none,
+  disc: disc,
+  decimal: decimal,
+  circle: circle,
+  square: square,
+);
+$custom-list-style-type-properties: () !default;
+$list-style-type-properties: map.merge(
+  $base-list-style-type-properties,
+  $custom-list-style-type-properties
+);
+
+// List style position properties.
+$list-style-position-class-prefix: "list-style-" !default;
+$base-list-style-position-properties: (
+  inside: inside,
+  outside: outside,
+);
+$custom-list-style-position-properties: () !default;
+$list-style-position-properties: map.merge(
+  $base-list-style-position-properties,
+  $custom-list-style-position-properties
+);
+
+// Responsive utility flag.
+$responsive: false !default;

package/src/scss/utilities/list/_index.scss

@@ -0,0 +1,56 @@
+// @graupl/graupl list 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 list style type property, create a utility class.
+  @each $name, $property in defaults.$list-style-type-properties {
+    @include utility.create(
+      ".#{defaults.$list-style-type-class-prefix}#{$name}",
+      list-style-type,
+      $property
+    );
+  }
+
+  // For each list style position property, create a utility class.
+  @each $name, $property in defaults.$list-style-position-properties {
+    @include utility.create(
+      ".#{defaults.$list-style-position-class-prefix}#{$name}",
+      list-style-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 list style type property, create a utility class.
+      @each $name, $property in defaults.$list-style-type-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$list-style-type-class-prefix}#{$name}",
+          list-style-type,
+          $property,
+          $screen-size
+        );
+      }
+
+      // For each list style position property, create a utility class.
+      @each $name, $property in defaults.$list-style-position-properties {
+        @include utility.create(
+          ".#{$screen-size}#{root-defaults.$responsive-separator}#{defaults.$list-style-position-class-prefix}#{$name}",
+          list-style-position,
+          $property,
+          $screen-size
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/list/_variables.scss

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

@@ -0,0 +1,22 @@
+// @graupl/graupl order 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";
+
+// Order properties.
+$order-class-prefix: "order-" !default;
+$base-order-properties: (
+  "none": 0,
+  "first": -9999,
+  "last": 9999,
+);
+$custom-order-properties: () !default;
+$order-properties: map.merge($base-order-properties, $custom-order-properties);
+
+// Responsive utility flag.
+$responsive: true !default;

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;