@graupl/core 1.0.0-beta.15 → 1.0.0-beta.17

package/src/scss/utilities/color/_defaults.scss

@@ -7,11 +7,14 @@
 // Those should be defined as custom properties in the `_variables.scss` file.
 
 @use "../../defaults" as root-defaults;
+@use "../../functions/theme";
+@use "../../theme/color/variables" as color;
 @use "sass:map";
 
 // Utility modifiers.
 $selector-base: root-defaults.$utility-selector-base !default;
 $use-important: root-defaults.$use-important !default;
+$generate-base-utilities: root-defaults.$generate-base-utilities !default;
 $screen-aware: false !default;
 $theme-aware: true !default;
 $state-aware: true !default;
@@ -27,23 +30,68 @@ $container-aware-selector-prefix: root-defaults.$utility-container-aware-selecto
 
 // Background utility properties.
 $background-selector-prefix: "bg-" !default;
-$base-background-properties: (
+$-background-properties: (
   inherit: inherit,
   current: currentcolor,
   transparent: transparent,
 );
 $custom-background-properties: () !default;
-$background-properties: map.merge(
-  $base-background-properties,
-  $custom-background-properties
-);
+$background-properties: () !default;
+
+// @todo remove this once $custom-background-properties is removed
+@if $custom-background-properties != () {
+  @warn "`$custom-background-properties` is deprecated and will be removed in a future release of Graupl. Use `$background-properties` instead.";
+
+  $background-properties: map.merge(
+    $background-properties,
+    $custom-background-properties
+  );
+}
 
 // Text utility properties.
 $text-selector-prefix: "text-" !default;
-$base-text-properties: (
+$-text-properties: (
   inherit: inherit,
   current: currentcolor,
   transparent: transparent,
 );
 $custom-text-properties: () !default;
-$text-properties: map.merge($base-text-properties, $custom-text-properties);
+$text-properties: () !default;
+
+// @todo remove this once $custom-text-properties is removed
+@if $custom-text-properties != () {
+  @warn "`$custom-text-properties` is deprecated and will be removed in a future release of Graupl. Use `$text-properties` instead.";
+
+  $text-properties: map.merge($text-properties, $custom-text-properties);
+}
+
+// Add all of the active theme colours to the text and background base properties.
+@each $color in theme.get-colors() {
+  $map: theme.get-color($color);
+
+  @each $shade, $value in $map {
+    // Handle _default shade vs proper shade mappings.
+    $name: null;
+
+    @if $shade == "_default" {
+      $name: #{$color};
+    } @else {
+      $name: #{$color}-#{$shade};
+    }
+
+    $-background-properties: map.merge(
+      $-background-properties,
+      (#{$name}: #{$value})
+    );
+    $-text-properties: map.merge($-text-properties, (#{$name}: #{$value}));
+  }
+}
+
+// Merge custom properties with base properties if generating base utilities.
+@if $generate-base-utilities {
+  $background-properties: map.merge(
+    $-background-properties,
+    $background-properties
+  );
+  $text-properties: map.merge($-text-properties, $text-properties);
+}

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

@@ -70,6 +70,7 @@
 // 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.
@@ -83,12 +84,10 @@
 // - `$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.
+// - `$custom-background-properties`: [DEPRECATED] 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.
+// - `$custom-text-properties`: [DEPRECATED] 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`.
@@ -138,30 +137,30 @@
   $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
-      );
-    }
-  }
+  // @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 {
@@ -197,35 +196,35 @@
       $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
-          );
-        }
-      }
+      // @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 {
@@ -266,35 +265,35 @@
         $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
-            );
-          }
-        }
+        // @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 {
@@ -338,35 +337,35 @@
       $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
-          );
-        }
-      }
+      // @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 {
@@ -406,35 +405,35 @@
       $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
-          );
-        }
-      }
+      // @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 {

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

@@ -12,6 +12,7 @@
 // Utility modifiers.
 $selector-base: root-defaults.$utility-selector-base !default;
 $use-important: root-defaults.$use-important !default;
+$generate-base-utilities: root-defaults.$generate-base-utilities !default;
 $screen-aware: false !default;
 $theme-aware: false !default;
 $state-aware: false !default;
@@ -27,14 +28,29 @@ $container-aware-selector-prefix: root-defaults.$utility-container-aware-selecto
 
 // Container type properties.
 $container-type-selector-prefix: "container-type-" !default;
-$base-container-type-properties: (
+$-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
-);
+$container-type-properties: () !default;
+
+// @todo remove this once $custom-container-type-properties is removed
+@if $custom-container-type-properties != () {
+  @warn "`$custom-container-type-properties` is deprecated and will be removed in a future release of Graupl. Use `$container-type-properties` instead.";
+
+  $container-type-properties: map.merge(
+    $container-type-properties,
+    $custom-container-type-properties
+  );
+}
+
+// Merge custom properties with base properties if generating base utilities.
+@if $generate-base-utilities {
+  $container-type-properties: map.merge(
+    $-container-type-properties,
+    $container-type-properties
+  );
+}

package/src/scss/utilities/container/_index.scss

@@ -14,6 +14,7 @@
 // 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.
@@ -27,8 +28,7 @@
 // - `$state-aware-selector-prefix`: The prefix for state-aware utility classes.
 // - `$container-aware-selector-prefix`: The prefix for container-aware utility classes.
 // - `$container-type-selector-prefix`: The prefix for the utility classes.
-// - `$base-container-type-properties`: The base properties and values for the container-type utility classes.
-// - `$custom-container-type-properties`: The custom properties and values for the container-type utility classes.
+// - `$custom-container-type-properties`: [DEPRECATED] The custom properties and values for the container-type utility classes.
 // - `$container-type-properties`: The merged properties and values for the container-type utility classes.
 //
 // Generating responsive utility classes can be done by setting `$screen-aware`, `$theme-aware`, or `$state-aware` to `true`.

package/src/scss/utilities/display/_defaults.scss

@@ -12,6 +12,7 @@
 // Utility modifiers.
 $selector-base: root-defaults.$utility-selector-base !default;
 $use-important: root-defaults.$use-important !default;
+$generate-base-utilities: root-defaults.$generate-base-utilities !default;
 $screen-aware: true !default;
 $theme-aware: false !default;
 $state-aware: false !default;
@@ -27,7 +28,7 @@ $container-aware-selector-prefix: root-defaults.$utility-container-aware-selecto
 
 // Display properties.
 $display-selector-prefix: "display-" !default;
-$base-display-properties: (
+$-display-properties: (
   block: block,
   inline-block: inline-block,
   inline: inline,
@@ -41,7 +42,19 @@ $base-display-properties: (
   list-item: list-item,
 );
 $custom-display-properties: () !default;
-$display-properties: map.merge(
-  $base-display-properties,
-  $custom-display-properties
-);
+$display-properties: () !default;
+
+// @todo remove this once $custom-display-properties is removed
+@if $custom-display-properties != () {
+  @warn "`$custom-display-properties` is deprecated and will be removed in a future release of Graupl. Use `$display-properties` instead.";
+
+  $display-properties: map.merge(
+    $display-properties,
+    $custom-display-properties
+  );
+}
+
+// Merge custom properties with base properties if generating base utilities.
+@if $generate-base-utilities {
+  $display-properties: map.merge($-display-properties, $display-properties);
+}

package/src/scss/utilities/display/_index.scss

@@ -21,6 +21,7 @@
 // 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.
@@ -34,8 +35,7 @@
 // - `$state-aware-selector-prefix`: The prefix for state-aware utility classes.
 // - `$container-aware-selector-prefix`: The prefix for container-aware utility classes.
 // - `$display-selector-prefix`: The prefix for the display utility classes.
-// - `$base-display-properties`: The base properties and values for the display utility classes.
-// - `$custom-display-properties`: The custom properties and values for the display utility classes.
+// - `$custom-display-properties`: [DEPRECATED] The custom properties and values for the display utility classes.
 // - `$display-properties`: The merged properties and values for the display utility classes.
 //
 // Generating responsive utility classes can be done by setting `$screen-aware`, `$theme-aware`, or `$state-aware` to `true`.