@graupl/graupl 1.0.0-beta.0 → 1.0.0-beta.10

package/packages/core/src/scss/utilities/color/_index.scss

@@ -0,0 +1,469 @@
+// @graupl/core color utilities styles.
+//
+// This file generates the color utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.bg-primary-100`: Sets the background to Graupl's primary 100 color.
+// - `.bg-primary-200`: Sets the background to Graupl's primary 200 color.
+// - `.bg-primary-300`: Sets the background to Graupl's primary 300 color.
+// - `.bg-primary-400`: Sets the background to Graupl's primary 400 color.
+// - `.bg-primary-500`: Sets the background to Graupl's primary 500 color.
+// - `.bg-primary-600`: Sets the background to Graupl's primary 600 color.
+// - `.bg-primary-700`: Sets the background to Graupl's primary 700 color.
+// - `.bg-primary-800`: Sets the background to Graupl's primary 800 color.
+// - `.bg-primary-900`: Sets the background to Graupl's primary 900 color.
+// - `.bg-secondary-100`: Sets the background to Graupl's secondary 100 color.
+// - `.bg-secondary-200`: Sets the background to Graupl's secondary 200 color.
+// - `.bg-secondary-300`: Sets the background to Graupl's secondary 300 color.
+// - `.bg-secondary-400`: Sets the background to Graupl's secondary 400 color.
+// - `.bg-secondary-500`: Sets the background to Graupl's secondary 500 color.
+// - `.bg-secondary-600`: Sets the background to Graupl's secondary 600 color.
+// - `.bg-secondary-700`: Sets the background to Graupl's secondary 700 color.
+// - `.bg-secondary-800`: Sets the background to Graupl's secondary 800 color.
+// - `.bg-secondary-900`: Sets the background to Graupl's secondary 900 color.
+// - `.bg-tertiary-100`: Sets the background to Graupl's tertiary 100 color.
+// - `.bg-tertiary-200`: Sets the background to Graupl's tertiary 200 color.
+// - `.bg-tertiary-300`: Sets the background to Graupl's tertiary 300 color.
+// - `.bg-tertiary-400`: Sets the background to Graupl's tertiary 400 color.
+// - `.bg-tertiary-500`: Sets the background to Graupl's tertiary 500 color.
+// - `.bg-tertiary-600`: Sets the background to Graupl's tertiary 600 color.
+// - `.bg-tertiary-700`: Sets the background to Graupl's tertiary 700 color.
+// - `.bg-tertiary-800`: Sets the background to Graupl's tertiary 800 color.
+// - `.bg-tertiary-900`: Sets the background to Graupl's tertiary 900 color.
+// - `.bg-inherit`: Sets the background to `inherit`.
+// - `.bg-current`: Sets the background to `currentcolor`.
+// - `.bg-transparent`: Sets the background to `transparent`.
+// - `.text-primary-100`: Sets the text color to Graupl's primary 100 color.
+// - `.text-primary-200`: Sets the text color to Graupl's primary 200 color.
+// - `.text-primary-300`: Sets the text color to Graupl's primary 300 color.
+// - `.text-primary-400`: Sets the text color to Graupl's primary 400 color.
+// - `.text-primary-500`: Sets the text color to Graupl's primary 500 color.
+// - `.text-primary-600`: Sets the text color to Graupl's primary 600 color.
+// - `.text-primary-700`: Sets the text color to Graupl's primary 700 color.
+// - `.text-primary-800`: Sets the text color to Graupl's primary 800 color.
+// - `.text-primary-900`: Sets the text color to Graupl's primary 900 color.
+// - `.text-secondary-100`: Sets the text color to Graupl's secondary 100 color.
+// - `.text-secondary-200`: Sets the text color to Graupl's secondary 200 color.
+// - `.text-secondary-300`: Sets the text color to Graupl's secondary 300 color.
+// - `.text-secondary-400`: Sets the text color to Graupl's secondary 400 color.
+// - `.text-secondary-500`: Sets the text color to Graupl's secondary 500 color.
+// - `.text-secondary-600`: Sets the text color to Graupl's secondary 600 color.
+// - `.text-secondary-700`: Sets the text color to Graupl's secondary 700 color.
+// - `.text-secondary-800`: Sets the text color to Graupl's secondary 800 color.
+// - `.text-secondary-900`: Sets the text color to Graupl's secondary 900 color.
+// - `.text-tertiary-100`: Sets the text color to Graupl's tertiary 100 color.
+// - `.text-tertiary-200`: Sets the text color to Graupl's tertiary 200 color.
+// - `.text-tertiary-300`: Sets the text color to Graupl's tertiary 300 color.
+// - `.text-tertiary-400`: Sets the text color to Graupl's tertiary 400 color.
+// - `.text-tertiary-500`: Sets the text color to Graupl's tertiary 500 color.
+// - `.text-tertiary-600`: Sets the text color to Graupl's tertiary 600 color.
+// - `.text-tertiary-700`: Sets the text color to Graupl's tertiary 700 color.
+// - `.text-tertiary-800`: Sets the text color to Graupl's tertiary 800 color.
+// - `.text-tertiary-900`: Sets the text color to Graupl's tertiary 900 color.
+// - `.text-inherit`: Sets the text color to `inherit`.
+// - `.text-current`: Sets the text color to `currentcolor`.
+// - `.text-transparent`: Sets the text color to `transparent`.
+//
+// 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.
+// - `$background-selector-prefix`: The prefix for the background utility classes.
+// - `$base-background-properties`: The base properties and values for the background utility classes.
+// - `$custom-background-properties`: The custom properties and values for the background utility classes.
+// - `$background-properties`: The merged properties and values for the background utility classes.
+// - `$text-selector-prefix`: The prefix for the text utility classes.
+// - `$base-text-properties`: The base properties and values for text utility classes.
+// - `$custom-text-properties`: The custom properties and values for text utility classes.
+// - `$text-properties`: The merged properties and values for text utility classes.
+//
+// Generating responsive utility classes can be done by setting `$screen-aware`, `$theme-aware`, or `$state-aware` to `true`.
+// By default, theme-aware and state-aware 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:bg-primary-100` will set the `background` property to Graupl's primary 100 color 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:bg-primary-100` will set the `background` property to Graupl's primary 100 color 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:bg-primary-100` will set the `background` property to Graupl's primary 100 color 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:bg-primary-100` will set the `background` property to Graupl's primary 100 color when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//   <div class="bg-primary-100">
+//      <span class="text-primary-900">This is primary 900 text with a primary 100 background.</span>
+//   </div>
+//
+// @example
+//   <div class="bg-primary-100 hover:bg-primary-200">This background will change to primary 200 when hovered.</div>
+//
+// @example
+//   <div class="bg-primary-100 dark:bg-primary-900">This background will change to primary 900 when the dark theme is active.</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 theme colour, create a utility class for background and color.
+  @each $color, $map in map.get(color.$themes, active) {
+    @each $shade, $value in $map {
+      // e.g. `.bg-primary-500` or `.bg-secondary-700`
+      $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$color}-#{$shade};
+
+      @include utility.create-mapped(
+        $selector,
+        (
+          --#{root-defaults.$prefix}background: #{$value},
+          background: #{color.$background}
+        ),
+        $important: defaults.$use-important
+      );
+
+      // e.g. `.text-primary-500` or `.text-secondary-700`
+      $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$color}-#{$shade};
+
+      @include utility.create-mapped(
+        $selector,
+        (--#{root-defaults.$prefix}color: #{$value}, color: #{color.$color}),
+        $important: defaults.$use-important
+      );
+    }
+  }
+
+  // For each background property, create a utility class.
+  @each $name, $value in defaults.$background-properties {
+    // e.g. `.bg-inherit` or `.bg-current`
+    $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$name};
+
+    @include utility.create-mapped(
+      $selector,
+      (
+        --#{root-defaults.$prefix}background: #{$value},
+        background: #{color.$background}
+      ),
+      $important: defaults.$use-important
+    );
+  }
+
+  // For each text property, create a utility class.
+  @each $name, $value in defaults.$text-properties {
+    // e.g. `.text-inherit` or `.text-current`
+    $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$name};
+
+    @include utility.create-mapped(
+      $selector,
+      (--#{root-defaults.$prefix}color: #{$value}, color: #{color.$color}),
+      $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 theme colour, create a utility class for background and color.
+      @each $color, $map in map.get(color.$themes, active) {
+        @each $shade, $value in $map {
+          // e.g. `.md:bg-primary-500` or `.lg:bg-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}background: #{$value},
+              background: #{color.$background}
+            ),
+            $important: defaults.$use-important,
+            $screen: $screen-name
+          );
+
+          // e.g. `.md:text-primary-500` or `.lg:text-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}color: #{$value},
+              color: #{color.$color}
+            ),
+            $important: defaults.$use-important,
+            $screen: $screen-name
+          );
+        }
+      }
+
+      // For each background property, create a utility class.
+      @each $name, $value in defaults.$background-properties {
+        // e.g. `.md:bg-inherit` or `.lg:bg-current`
+        $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (
+            --#{root-defaults.$prefix}background: #{$value},
+            background: #{color.$background}
+          ),
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      // For each text property, create a utility class.
+      @each $name, $value in defaults.$text-properties {
+        // e.g. `.md:text-inherit` or `.lg:text-current`
+        $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (--#{root-defaults.$prefix}color: #{$value}, color: #{color.$color}),
+          $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 theme colour, create a utility class for background and color.
+        @each $color, $map in map.get(color.$themes, active) {
+          @each $shade, $value in $map {
+            // e.g. `.dark:bg-primary-500` or `.light:bg-secondary-700`
+            $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$color}-#{$shade};
+
+            @include utility.create-mapped(
+              $selector,
+              (
+                --#{root-defaults.$prefix}background: #{$value},
+                background: #{color.$background}
+              ),
+              $important: defaults.$use-important,
+              $theme: $theme-name
+            );
+
+            // e.g. `.dark:text-primary-500` or `.light:text-secondary-700`
+            $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$color}-#{$shade};
+
+            @include utility.create-mapped(
+              $selector,
+              (
+                --#{root-defaults.$prefix}color: #{$value},
+                color: #{color.$color}
+              ),
+              $important: defaults.$use-important,
+              $theme: $theme-name
+            );
+          }
+        }
+
+        // For each background property, create a utility class.
+        @each $name, $value in defaults.$background-properties {
+          // e.g. `.dark:bg-inherit` or `.light:bg-current`
+          $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$name};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}background: #{$value},
+              background: #{color.$background}
+            ),
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        // For each text property, create a utility class.
+        @each $name, $value in defaults.$text-properties {
+          // e.g. `.dark:text-inherit` or `.light:text-current`
+          $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$name};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}color: #{$value},
+              color: #{color.$color}
+            ),
+            $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 theme colour, create a utility class for background and color.
+      @each $color, $map in map.get(color.$themes, active) {
+        @each $shade, $value in $map {
+          // e.g. `.hover:bg-primary-500` or `.focus:bg-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}background: #{$value},
+              background: #{color.$background}
+            ),
+            $important: defaults.$use-important,
+            $state: $state-name
+          );
+
+          // e.g. `.hover:text-primary-500` or `.focus:text-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}color: #{$value},
+              color: #{color.$color}
+            ),
+            $important: defaults.$use-important,
+            $state: $state-name
+          );
+        }
+      }
+
+      // For each background property, create a utility class.
+      @each $name, $value in defaults.$background-properties {
+        // e.g. `.hover:bg-inherit` or `.focus:bg-current`
+        $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (
+            --#{root-defaults.$prefix}background: #{$value},
+            background: #{color.$background}
+          ),
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      // For each text property, create a utility class.
+      @each $name, $value in defaults.$text-properties {
+        // e.g. `.hover:text-inherit` or `.focus:text-current`
+        $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (--#{root-defaults.$prefix}color: #{$value}, color: #{color.$color}),
+          $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 theme colour, create a utility class for background and color.
+      @each $color, $map in map.get(color.$themes, active) {
+        @each $shade, $value in $map {
+          // e.g. `.md:bg-primary-500` or `.lg:bg-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}background: #{$value},
+              background: #{color.$background}
+            ),
+            $important: defaults.$use-important,
+            $container: $container-name
+          );
+
+          // e.g. `.md:text-primary-500` or `.lg:text-secondary-700`
+          $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$color}-#{$shade};
+
+          @include utility.create-mapped(
+            $selector,
+            (
+              --#{root-defaults.$prefix}color: #{$value},
+              color: #{color.$color}
+            ),
+            $important: defaults.$use-important,
+            $container: $container-name
+          );
+        }
+      }
+
+      // For each background property, create a utility class.
+      @each $name, $value in defaults.$background-properties {
+        // e.g. `.md:bg-inherit` or `.lg:bg-current`
+        $selector: #{$selector-prefix}#{defaults.$background-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (
+            --#{root-defaults.$prefix}background: #{$value},
+            background: #{color.$background}
+          ),
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      // For each text property, create a utility class.
+      @each $name, $value in defaults.$text-properties {
+        // e.g. `.md:text-inherit` or `.lg:text-current`
+        $selector: #{$selector-prefix}#{defaults.$text-selector-prefix}#{$name};
+
+        @include utility.create-mapped(
+          $selector,
+          (--#{root-defaults.$prefix}color: #{$value}, color: #{color.$color}),
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

package/{src/scss/utilities/flex → packages/core/src/scss/utilities/color}/_variables.scss

@@ -1,4 +1,4 @@
-// @graupl/graupl flex utilities variables.
+// @graupl/core color utilities variables.
 //
 // These values are to be used to directly style components and provide a
 // cleaner way to reference custom properties.

package/packages/core/src/scss/utilities/container/_defaults.scss

@@ -0,0 +1,40 @@
+// @graupl/core container 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;
+
+// Container type properties.
+$container-type-selector-prefix: "container-type-" !default;
+$base-container-type-properties: (
+  inline: "inline-size",
+  normal: "normal",
+  size: "size",
+  scroll: "scroll-state",
+);
+$custom-container-type-properties: () !default;
+$container-type-properties: map.merge(
+  $base-container-type-properties,
+  $custom-container-type-properties
+);