@graupl/navigation-shelf 1.0.0-beta.16

package/src/scss/utilities/width/_index.scss

@@ -0,0 +1,290 @@
+// @graupl/navigation-shelf width utilities styles.
+//
+// This file generates the width utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.w-shelf-min`: Sets the width property to `--graupl-navigation-shelf-min-width`.
+// - `.w-shelf-max`: Sets the width property to `--graupl-navigation-shelf-max-width`.
+// - `.w-shelf-current`: Sets the width property to `--graupl-navigation-shelf-current-width`.
+// - `.w-shelf-closed`: Sets the width property to `--graupl-navigation-shelf-closed-width`.
+// - `.w-shelf-open`: Sets the width property to `--graupl-navigation-shelf-open-width`.
+// - `.max-w-shelf-min`: Sets the max-width property to `--graupl-navigation-shelf-min-width`.
+// - `.max-w-shelf-max`: Sets the max-width property to `--graupl-navigation-shelf-max-width`.
+// - `.max-w-shelf-current`: Sets the max-width property to `--graupl-navigation-shelf-current-width`.
+// - `.max-w-shelf-closed`: Sets the max-width property to `--graupl-navigation-shelf-closed-width`.
+// - `.max-w-shelf-open`: Sets the max-width property to `--graupl-navigation-shelf-open-width`.
+// - `.min-w-shelf-min`: Sets the min-width property to `--graupl-navigation-shelf-min-width`.
+// - `.min-w-shelf-max`: Sets the min-width property to `--graupl-navigation-shelf-max-width`.
+// - `.min-w-shelf-current`: Sets the min-width property to `--graupl-navigation-shelf-current-width`.
+// - `.min-w-shelf-closed`: Sets the min-width property to `--graupl-navigation-shelf-closed-width`.
+// - `.min-w-shelf-open`: Sets the min-width property to `--graupl-navigation-shelf-open-width`.
+//
+// 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.
+// - `$generate-base-utilities`: A flag to determine if the base utility classes should be generated.
+// - `$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.
+// - `$width-selector-prefix`: The prefix for the width utility classes.
+// - `$max-width-selector-prefix`: The prefix for the max-width utility classes.
+// - `$min-width-selector-prefix`: The prefix for the min-width utility classes.
+// - `$custom-width-values`: [DEPRECATED] The custom properties and values for the width utility classes.
+// - `$width-values`: The combined properties and values for the width 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:w-shelf-min` will set the `width` property to `--graupl-navigation-shelf-min-width` 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:w-shelf-min` will set the `width` property to `--graupl-navigation-shelf-min-width` 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:w-shelf-min` will set the `width` property to `--graupl-navigation-shelf-min-width` 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:w-shelf-min` will set the `width` property to `--graupl-navigation-shelf-min-width` when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//   <div class="w-5">This element has a width equal to Graupl's spacer 5 value.</div>
+
+@use "defaults";
+@use "pkg:@graupl/core/src/defaults" as root-defaults;
+@use "pkg:@graupl/core/src/mixins/layer" as *;
+@use "pkg:@graupl/core/src/mixins/utility";
+@use "pkg:@graupl/core/src/theme/color/variables" as color;
+@use "pkg:@graupl/core/src/variables" as root-variables;
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(utilities) {
+  // `.`
+  $selector-prefix: defaults.$selector-base;
+
+  // For each width property, create a utility class.
+  @each $width, $value in defaults.$width-values {
+    // e.g. `.w-shelf-min` or `.w-shelf-open`
+    $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.max-w-shelf-min` or `.max-w-shelf-open`
+    $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      max-width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.min-w-shelf-min` or `.min-w-shelf-open`
+    $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      min-width,
+      $value,
+      $important: defaults.$use-important
+    );
+  }
+
+  // Generate screen-aware utilities.
+  @if defaults.$screen-aware {
+    @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 width property, create a utility class.
+      @each $width, $value in defaults.$width-values {
+        // e.g. `.md:w-shelf-min` or `.lg:w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          width,
+          $value,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+
+        // e.g. `.md:max-w-shelf-min` or `.lg:max-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+
+        // e.g. `.md:min-w-shelf-min` or `.lg:min-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $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 width property, create a utility class.
+        @each $width, $value in defaults.$width-values {
+          // e.g. `.dark:w-shelf-min` or `.light:w-shelf-open`
+          $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+          @include utility.create(
+            $selector,
+            width,
+            $value,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+
+          // e.g. `.dark:max-w-shelf-min` or `.light:max-w-shelf-open`
+          $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+          @include utility.create(
+            $selector,
+            max-width,
+            $value,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+
+          // e.g. `.dark:min-w-shelf-min` or `.light:min-w-shelf-open`
+          $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+          @include utility.create(
+            $selector,
+            min-width,
+            $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 width property, create a utility class.
+      @each $width, $value in defaults.$width-values {
+        // e.g. `.hover:w-shelf-min` or `.focus:w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+        @include utility.create($selector, width, $value, $state: $state-name);
+
+        // e.g. `.hover:max-w-shelf-min` or `.focus:max-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+
+        // e.g. `.hover:min-w-shelf-min` or `.focus:min-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $value,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+    }
+  }
+
+  // Generate container-aware utilities.
+  @if defaults.$container-aware {
+    @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 width property, create a utility class.
+      @each $width, $value in defaults.$width-values {
+        // e.g. `.md:w-shelf-min` or `.lg:w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+
+        // e.g. `.md:max-w-shelf-min` or `.lg:max-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+
+        // e.g. `.md:min-w-shelf-min` or `.lg:min-w-shelf-open`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

package/src/scss/utilities/width/_variables.scss

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