@graupl/core 1.0.0-beta.10

package/src/scss/utilities/z-index/_index.scss

@@ -0,0 +1,173 @@
+// @graupl/core z-index utilities styles.
+//
+// This file generates the z-index utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.z-n1`: Sets the z-index to -1.
+// - `.z-0`: Sets the z-index to 0.
+// - `.z-1`: Sets the z-index to 1.
+//
+// The following custom properties control the generated classes:
+// - N/A.
+//
+// The following variables control the generated classes:
+// - `$selector-base`: The base selector for the utility classes.
+// - `$use-important`: A flag to determine if the `!important` flag should be added to the utility classes.
+// - `$screen-aware`: A flag to generate screen-aware utility classes.
+// - `$theme-aware`: A flag to generate theme-aware utility classes.
+// - `$state-aware`: A flag to generate state-aware utility classes.
+// - `$container-aware`: A flag to generate container-aware utility classes.
+// - `$screen-aware-separator`: The separator for screen-aware utility classes.
+// - `$theme-aware-separator`: The separator for theme-aware utility classes.
+// - `$state-aware-separator`: The separator for state-aware utility classes.
+// - `$container-aware-separator`: The separator for container-aware utility classes.
+// - `$screen-aware-selector-prefix`: The prefix for screen-aware utility classes.
+// - `$theme-aware-selector-prefix`: The prefix for theme-aware utility classes.
+// - `$state-aware-selector-prefix`: The prefix for state-aware utility classes.
+// - `$container-aware-selector-prefix`: The prefix for container-aware utility classes.
+// - `$z-index-selector-prefix`: The prefix for the utility classes.
+// - `$base-z-index-properties`: The base properties and values for the z-index utility classes.
+// - `$custom-z-index-properties`: The custom properties and values for the z-index utility classes.
+// - `$z-index-properties`: The merged properties and values for the z-index utility classes.
+//
+// Generating responsive utility classes can be done by setting `$screen-aware`, `$theme-aware`, or `$state-aware` to `true`.
+// By default, no responsive utility classes are generated.
+//
+// When set to true, screen-aware utility classes will be generated for each screen size in the following pattern:
+// - `.{screen-prefix}{screen-name}:{prefix}{value}`
+//
+// e.g. `.sm:z-0` will set the `z-index` property to `0` on screens equal to or larger than the `sm` breakpoint.
+//
+// When set to true, theme-aware utility classes will be generated for each theme in the following pattern:
+// - `.{theme-prefix}{theme-name}:{prefix}{value}`
+//
+// e.g. `.dark:z-0` will set the `z-index` property to `0` when the `dark` theme is active.
+//
+// When set to true, state-aware utility classes will be generated for each state in the following pattern:
+// - `.{state-prefix}{state-name}:{prefix}{value}`
+//
+// e.g. `.hover:z-0` will set the  `z-index` property to `0` when the element is hovered.
+//
+// When set to true, container-aware utility classes will be generated for each container in the following pattern:
+// - `.{container-prefix}{container-name}:{prefix}{value}`
+//
+// e.g. `.cq:md:z-0` will set the `z-index` property to `0` when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//   <div class="z-0">This element has a z-index of 0.</div>
+
+@use "../../defaults" as root-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
+@use "../../theme/color/variables" as color;
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  // `.`
+  $selector-prefix: defaults.$selector-base;
+
+  // For each z-index property, create a utility class.
+  @each $name, $value in defaults.$z-index-properties {
+    // e.g. `.z-0`
+    $selector: #{$selector-prefix}#{defaults.$z-index-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      z-index,
+      $value,
+      $important: #{defaults.$use-important}
+    );
+  }
+
+  // Generate screen-aware utilities.
+  @if defaults.$screen-aware and root-defaults.$screen-aware-utilities {
+    @each $screen-name in map.keys(root-defaults.$screen-sizes) {
+      // e.g. `.md:` or `.lg:`
+      $selector-prefix: #{defaults.$selector-base}#{defaults.$screen-aware-selector-prefix}#{$screen-name}#{defaults.$screen-aware-separator};
+
+      // For each template property, create a utility class.
+      @each $name, $value in defaults.$z-index-properties {
+        // e.g. `.md:z-0`
+        $selector: #{$selector-prefix}#{defaults.$z-index-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          z-index,
+          $value,
+          $important: #{defaults.$use-important},
+          $screen: $screen-name
+        );
+      }
+    }
+  }
+
+  // Generate theme-aware utilities.
+  @if defaults.$theme-aware and root-defaults.$theme-aware-utilities {
+    @each $theme-name, $colors in color.$themes {
+      @if $theme-name != active {
+        // e.g. `.dark:` or `.light:`
+        $selector-prefix: #{defaults.$selector-base}#{defaults.$theme-aware-selector-prefix}#{$theme-name}#{defaults.$theme-aware-separator};
+
+        // For each template property, create a utility class.
+        @each $name, $value in defaults.$z-index-properties {
+          // e.g. `.dark:z-0` or `.light:z-n1`
+          $selector: #{$selector-prefix}#{defaults.$z-index-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            z-index,
+            $value,
+            $important: #{defaults.$use-important},
+            $theme: $theme-name
+          );
+        }
+      }
+    }
+  }
+
+  // Generate state-aware utilities.
+  @if defaults.$state-aware and root-defaults.$state-aware-utilities {
+    @each $state-name, $value in root-defaults.$state-selectors {
+      // e.g. `.hover:` or `.focus:`
+      $selector-prefix: #{defaults.$selector-base}#{defaults.$state-aware-selector-prefix}#{$state-name}#{defaults.$state-aware-separator};
+
+      // For each template property, create a utility class.
+      @each $name, $value in defaults.$z-index-properties {
+        // e.g. `.hover:z-0` or `.focus:z-n1`
+        $selector: #{$selector-prefix}#{defaults.$z-index-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          z-index,
+          $value,
+          $important: #{defaults.$use-important},
+          $state: $state-name
+        );
+      }
+    }
+  }
+
+  // Generate container-aware utilities.
+  @if defaults.$container-aware and root-defaults.$container-aware-utilities {
+    @each $container-name in map.keys(root-defaults.$container-sizes) {
+      // e.g. `.md:` or `.lg:`
+      $selector-prefix: #{defaults.$selector-base}#{defaults.$container-aware-selector-prefix}#{$container-name}#{defaults.$container-aware-separator};
+
+      // For each template property, create a utility class.
+      @each $name, $value in defaults.$z-index-properties {
+        // e.g. `.md:z-0`
+        $selector: #{$selector-prefix}#{defaults.$z-index-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          z-index,
+          $value,
+          $important: #{defaults.$use-important},
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/z-index/_variables.scss

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