@graupl/core 1.0.0-beta.10

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

@@ -0,0 +1,525 @@
+// @graupl/core width utilities styles.
+//
+// This file generates the width utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.w-auto`: Sets the width property to `auto`.
+// - `.w-fit-content`: Sets the width property to `fit-content`.
+// - `.w-max-content`: Sets the width property to `max-content`.
+// - `.w-min-content`: Sets the width property to `min-content`.
+// - `.w-stretch`: Sets the width property to `stretch`.
+// - `.w-full`: Sets the width property to `100%`.
+// - `.w-quarter`: Sets the width property to `25%`.
+// - `.w-half`: Sets the width property to `50%`.
+// - `.w-three-quarters`: Sets the width property to `75%`.
+// - `.w-third`: Sets the width property to `calc(100% / 3)`.
+// - `.w-two-thirds`: Sets the width property to `calc(100% / 1.5)`.
+// - `.w-half-screen`: Sets the width property to `50vh`.
+// - `.w-third-screen`: Sets the width property to `calc(100vh / 3)`.
+// - `.w-two-thirds-screen`: Sets the width property to `calc(100vh / 1.5)`.
+// - `.w-quarter-screen`: Sets the width property to `25vh`.
+// - `.w-three-quarters-screen`: Sets the width property to `75vh`.
+// - `.w-full-screen`: Sets the width property to `100vh`.
+// - `.w-0`: Sets the width property to Graupl's spacer 0 value.
+// - `.w-1`: Sets the width property to Graupl's spacer 1 value.
+// - `.w-2`: Sets the width property to Graupl's spacer 2 value.
+// - `.w-3`: Sets the width property to Graupl's spacer 3 value.
+// - `.w-4`: Sets the width property to Graupl's spacer 4 value.
+// - `.w-5`: Sets the width property to Graupl's spacer 5 value.
+// - `.w-6`: Sets the width property to Graupl's spacer 6 value.
+// - `.w-7`: Sets the width property to Graupl's spacer 7 value.
+// - `.w-8`: Sets the width property to Graupl's spacer 8 value.
+// - `.w-9`: Sets the width property to Graupl's spacer 9 value.
+// - `.w-10`: Sets the width property to Graupl's spacer 10 value.
+// - `.max-w-auto`: Sets the max-width property to `auto`.
+// - `.max-w-fit-content`: Sets the max-width property to `fit-content`.
+// - `.max-w-max-content`: Sets the max-width property to `max-content`.
+// - `.max-w-min-content`: Sets the max-width property to `min-content`.
+// - `.max-w-stretch`: Sets the max-width property to `stretch`.
+// - `.max-w-full`: Sets the max-width property to `100%`.
+// - `.max-w-quarter`: Sets the max-width property to `25%`.
+// - `.max-w-half`: Sets the max-width property to `50%`.
+// - `.max-w-three-quarters`: Sets the max-width property to `75%`.
+// - `.max-w-third`: Sets the max-width property to `calc(100% / 3)`.
+// - `.max-w-two-thirds`: Sets the max-width property to `calc(100% / 1.5)`.
+// - `.max-w-half-screen`: Sets the max-width property to `50vh`.
+// - `.max-w-third-screen`: Sets the max-width property to `calc(100vh / 3)`.
+// - `.max-w-two-thirds-screen`: Sets the max-width property to `calc(100vh / 1.5)`.
+// - `.max-w-quarter-screen`: Sets the max-width property to `25vh`.
+// - `.max-w-three-quarters-screen`: Sets the max-width property to `75vh`.
+// - `.max-w-full-screen`: Sets the max-width property to `100vh`.
+// - `.max-w-0`: Sets the max-width property to Graupl's spacer 0 value.
+// - `.max-w-1`: Sets the max-width property to Graupl's spacer 1 value.
+// - `.max-w-2`: Sets the max-width property to Graupl's spacer 2 value.
+// - `.max-w-3`: Sets the max-width property to Graupl's spacer 3 value.
+// - `.max-w-4`: Sets the max-width property to Graupl's spacer 4 value.
+// - `.max-w-5`: Sets the max-width property to Graupl's spacer 5 value.
+// - `.max-w-6`: Sets the max-width property to Graupl's spacer 6 value.
+// - `.max-w-7`: Sets the max-width property to Graupl's spacer 7 value.
+// - `.max-w-8`: Sets the max-width property to Graupl's spacer 8 value.
+// - `.max-w-9`: Sets the max-width property to Graupl's spacer 9 value.
+// - `.max-w-10`: Sets the max-width property to Graupl's spacer 10 value.
+// - `.min-w-auto`: Sets the min-width property to `auto`.
+// - `.min-w-fit-content`: Sets the min-width property to `fit-content`.
+// - `.min-w-max-content`: Sets the min-width property to `max-content`.
+// - `.min-w-min-content`: Sets the min-width property to `min-content`.
+// - `.min-w-stretch`: Sets the min-width property to `stretch`.
+// - `.min-w-full`: Sets the min-width property to `100%`.
+// - `.min-w-quarter`: Sets the min-width property to `25%`.
+// - `.min-w-half`: Sets the min-width property to `50%`.
+// - `.min-w-three-quarters`: Sets the min-width property to `75%`.
+// - `.min-w-third`: Sets the min-width property to `calc(100% / 3)`.
+// - `.min-w-two-thirds`: Sets the min-width property to `calc(100% / 1.5)`.
+// - `.min-w-half-screen`: Sets the min-width property to `50vh`.
+// - `.min-w-third-screen`: Sets the min-width property to `calc(100vh / 3)`.
+// - `.min-w-two-thirds-screen`: Sets the min-width property to `calc(100vh / 1.5)`.
+// - `.min-w-quarter-screen`: Sets the min-width property to `25vh`.
+// - `.min-w-three-quarters-screen`: Sets the min-width property to `75vh`.
+// - `.min-w-full-screen`: Sets the min-width property to `100vh`.
+// - `.min-w-0`: Sets the min-width property to Graupl's spacer 0 value.
+// - `.min-w-1`: Sets the min-width property to Graupl's spacer 1 value.
+// - `.min-w-2`: Sets the min-width property to Graupl's spacer 2 value.
+// - `.min-w-3`: Sets the min-width property to Graupl's spacer 3 value.
+// - `.min-w-4`: Sets the min-width property to Graupl's spacer 4 value.
+// - `.min-w-5`: Sets the min-width property to Graupl's spacer 5 value.
+// - `.min-w-6`: Sets the min-width property to Graupl's spacer 6 value.
+// - `.min-w-7`: Sets the min-width property to Graupl's spacer 7 value.
+// - `.min-w-8`: Sets the min-width property to Graupl's spacer 8 value.
+// - `.min-w-9`: Sets the min-width property to Graupl's spacer 9 value.
+// - `.min-w-10`: Sets the min-width property to Graupl's spacer 10 value.
+//
+// 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.
+// - `$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.
+// - `$base-width-values`: The base properties and values for the width utility classes.
+// - `$custom-width-values`: 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-auto` will set the `width` property to `auto` 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-auto` will set the `width` property to `auto` 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-auto` will set the `width` property to `auto` 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-auto` will set the `width` property to `auto` 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" as root-defaults;
+@use "../../mixins/layer" as *;
+@use "../../mixins/utility";
+@use "../../theme/color/variables" as color;
+@use "../../variables" as root-variables;
+@use "defaults";
+@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-min-content` or `.w-full`
+    $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.max-w-min-content` or `.max-w-full`
+    $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      max-width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.min-w-min-content` or `.min-w-full`
+    $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+    @include utility.create(
+      $selector,
+      min-width,
+      $value,
+      $important: defaults.$use-important
+    );
+  }
+
+  @each $spacer, $value in root-variables.$spacers {
+    // e.g. `.w-1` or `.w-2`
+    $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$spacer};
+
+    @include utility.create(
+      $selector,
+      width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.max-w-1` or `.max-w-2`
+    $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$spacer};
+
+    @include utility.create(
+      $selector,
+      max-width,
+      $value,
+      $important: defaults.$use-important
+    );
+
+    // e.g. `.min-w-1` or `.min-w-2`
+    $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$spacer};
+
+    @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-min-content` or `.lg:w-full`
+        $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-min-content` or `.lg:max-w-full`
+        $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-min-content` or `.lg:min-w-full`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $value,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      @each $spacer, $value in root-variables.$spacers {
+        // e.g. `.md:w-1` or `.lg:w-2`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$spacer};
+
+        @include utility.create(
+          $selector,
+          width,
+          $value,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+
+        // e.g. `.md:max-w-1` or `.lg:max-w-2`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$spacer};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+
+        // e.g. `.md:min-w-1` or `.lg:min-w-2`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$spacer};
+
+        @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-min-content` or `.light:w-full`
+          $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-min-content` or `.light:max-w-full`
+          $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-min-content` or `.light:min-w-full`
+          $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+          @include utility.create(
+            $selector,
+            min-width,
+            $value,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        @each $spacer, $value in root-variables.$spacers {
+          // e.g. `.dark:w-1` or `.light:w-2`
+          $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$spacer};
+
+          @include utility.create(
+            $selector,
+            width,
+            $value,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+
+          // e.g. `.dark:max-w-1` or `.light:max-w-2`
+          $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$spacer};
+
+          @include utility.create(
+            $selector,
+            max-width,
+            $value,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+
+          // e.g. `.dark:min-w-1` or `.light:min-w-2`
+          $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$spacer};
+
+          @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-min-content` or `.focus:w-full`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$width};
+
+        @include utility.create($selector, width, $value, $state: $state-name);
+
+        // e.g. `.hover:max-w-min-content` or `.focus:max-w-full`
+        $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-min-content` or `.focus:min-w-full`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $value,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      @each $spacer, $value in root-variables.$spacers {
+        // e.g. `.hover:w-1` or `.focus:w-2`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$spacer};
+
+        @include utility.create($selector, width, $value, $state: $state-name);
+
+        // e.g. `.hover:max-w-1` or `.focus:max-w-2`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$spacer};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+
+        // e.g. `.hover:min-w-1` or `.focus:min-w-2`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$spacer};
+
+        @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-min-content` or `.lg:w-full`
+        $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-min-content` or `.lg:max-w-full`
+        $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-min-content` or `.lg:min-w-full`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$width};
+
+        @include utility.create(
+          $selector,
+          min-width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      @each $spacer, $value in root-variables.$spacers {
+        // e.g. `.md:w-1` or `.lg:w-2`
+        $selector: #{$selector-prefix}#{defaults.$width-selector-prefix}#{$spacer};
+
+        @include utility.create(
+          $selector,
+          width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+
+        // e.g. `.md:max-w-1` or `.lg:max-w-2`
+        $selector: #{$selector-prefix}#{defaults.$max-width-selector-prefix}#{$spacer};
+
+        @include utility.create(
+          $selector,
+          max-width,
+          $value,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+
+        // e.g. `.md:min-w-1` or `.lg:min-w-2`
+        $selector: #{$selector-prefix}#{defaults.$min-width-selector-prefix}#{$spacer};
+
+        @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/core width 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/z-index/_defaults.scss

@@ -0,0 +1,40 @@
+// @graupl/core z-index 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 "../../defaults" as root-defaults;
+@use "sass:map";
+
+// Utility modifiers.
+$selector-base: root-defaults.$utility-selector-base !default;
+$use-important: root-defaults.$use-important !default;
+$screen-aware: false !default;
+$theme-aware: false !default;
+$state-aware: false !default;
+$container-aware: false !default;
+$screen-aware-separator: root-defaults.$utility-screen-aware-separator !default;
+$theme-aware-separator: root-defaults.$utility-theme-aware-separator !default;
+$state-aware-separator: root-defaults.$utility-state-aware-separator !default;
+$container-aware-separator: root-defaults.$utility-container-aware-separator !default;
+$screen-aware-selector-prefix: root-defaults.$utility-screen-aware-selector-prefix !default;
+$theme-aware-selector-prefix: root-defaults.$utility-theme-aware-selector-prefix !default;
+$state-aware-selector-prefix: root-defaults.$utility-state-aware-selector-prefix !default;
+$container-aware-selector-prefix: root-defaults.$utility-container-aware-selector-prefix !default;
+
+// Z-index properties.
+
+$z-index-selector-prefix: "z-" !default;
+$base-z-index-properties: (
+  "n1": -1,
+  0: 0,
+  1: 1,
+);
+$custom-z-index-properties: () !default;
+$z-index-properties: map.merge(
+  $base-z-index-properties,
+  $custom-z-index-properties
+);