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

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

@@ -0,0 +1,171 @@
+// @graupl/core [_template] utilities styles.
+//
+// This file generates the [_template] utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.template-class`: Applies the base value for the property.
+//
+// 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.
+// - `$template-selector-prefix`: The prefix for the utility classes.
+// - `$base-template-properties`: The base properties and values for the template utility classes.
+// - `$custom-template-properties`: The custom properties and values for the template utility classes.
+// - `$template-properties`: The merged properties and values for the template 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:[template-class]` will set the `template` property to `value` 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:[template-class]` will set the `template` property to `value` 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:[template-class]` will set the `template` property to `value` 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:[template-class]` will set the `template` property to `value` when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//   <div class="template-class">This content showing you how to use this.</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 template property, create a utility class.
+  @each $name, $value in defaults.$template-properties {
+    // e.g. `.template-property-name`
+    $selector: #{$selector-prefix}#{defaults.$template-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      property,
+      $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.$template-properties {
+        // e.g. `.md:template-property-name`
+        $selector: #{$selector-prefix}#{defaults.$template-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          property,
+          $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.$template-properties {
+          // e.g. `.dark:template-property-name` or `.light:template-property-name`
+          $selector: #{$selector-prefix}#{defaults.$template-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            property,
+            $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.$template-properties {
+        // e.g. `.hover:template-property-name` or `.focus:template-property-name`
+        $selector: #{$selector-prefix}#{defaults.$template-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          property,
+          $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.$template-properties {
+        // e.g. `.cq:md:template-property-name`
+        $selector: #{$selector-prefix}#{defaults.$template-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          property,
+          $value,
+          $important: #{defaults.$use-important},
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

package/{src/scss/utilities/alignment → packages/core/src/scss/utilities/_template}/_variables.scss

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

package/{src → packages/core/src}/scss/utilities/alignment/_defaults.scss

@@ -1,4 +1,4 @@
-// @graupl/graupl alignment utilities default values.
+// @graupl/core alignment 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.
@@ -6,10 +6,27 @@
 // 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;
+
 // Align content properties.
-$align-content-class-prefix: "align-content-" !default;
+$align-content-selector-prefix: "align-content-" !default;
 $base-align-content-properties: (
   normal: normal,
   start: flex-start,
@@ -28,7 +45,7 @@ $align-content-properties: map.merge(
 );
 
 // Align items properties.
-$align-items-class-prefix: "align-items-" !default;
+$align-items-selector-prefix: "align-items-" !default;
 $base-align-items-properties: (
   start: start,
   end: end,
@@ -43,7 +60,7 @@ $align-items-properties: map.merge(
 );
 
 // Align self properties.
-$align-self-class-prefix: "align-self-" !default;
+$align-self-selector-prefix: "align-self-" !default;
 $base-align-self-properties: (
   auto: auto,
   start: start,
@@ -57,6 +74,3 @@ $align-self-properties: map.merge(
   $base-align-self-properties,
   $custom-align-self-properties
 );
-
-// Responsive utility flag.
-$responsive: false !default;

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

@@ -0,0 +1,336 @@
+// @graupl/core alignment utilities styles.
+//
+// This file generates the alignment utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.align-content-normal`: Sets the align-content property to `normal`.
+// - `.align-content-start`: Sets the align-content property to `flex-start`.
+// - `.align-content-end`: Sets the align-content property to `flex-end`.
+// - `.align-content-center`: Sets the align-content property to `center`.
+// - `.align-content-between`: Sets the align-content property to `space-between`.
+// - `.align-content-around`: Sets the align-content property to `space-around`.
+// - `.align-content-evenly`: Sets the align-content property to `space-evenly`.
+// - `.align-content-baseline`: Sets the align-content property to `baseline`.
+// - `.align-content-stretch`: Sets the align-content property to `stretch`.
+// - `.align-items-start`: Sets the align-items property to `start`.
+// - `.align-items-end`: Sets the align-items property to `end`.
+// - `.align-items-center`: Sets the align-items property to `center`.
+// - `.align-items-baseline`: Sets the align-items property to `baseline`.
+// - `.align-items-stretch`: Sets the align-items property to `stretch`.
+// - `.align-self-auto`: Sets the align-self property to `auto`.
+// - `.align-self-start`: Sets the align-self property to `start`.
+// - `.align-self-end`: Sets the align-self property to `end`.
+// - `.align-self-center`: Sets the align-self property to `center`.
+// - `.align-self-baseline`: Sets the align-self property to `baseline`.
+// - `.align-self-stretch`: Sets the align-self property to `stretch`.
+//
+// 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.
+// - `$align-content-selector-prefix`: The prefix for the align content utility classes.
+// - `$base-align-content-properties`: The base properties and values for the align content utility classes.
+// - `$custom-align-content-properties`: The custom properties and values for the align content utility classes.
+// - `$align-content-properties`: The combined properties and values for the align content utility classes.
+// - `$align-items-selector-prefix`: The prefix for the align items utility classes.
+// - `$base-align-items-properties`: The base properties and values for the align items utility classes.
+// - `$custom-align-items-properties`: The custom properties and values for the align items utility classes.
+// - `$align-items-properties`: The combined properties and values for the align items utility classes.
+// - `$align-self-selector-prefix`: The prefix for the align self utility classes.
+// - `$base-align-self-properties`: The base properties and values for the align self utility classes.
+// - `$custom-align-self-properties`: The custom properties and values for the align self utility classes.
+// - `$align-self-properties`: The combined properties and values for the align self 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-name}:{prefix}{value}`
+//
+// e.g. `.sm:align-content-normal` will set the `align-content` property to `normal` 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-name}:{prefix}{value}`
+//
+// e.g. `.dark:align-content-normal` will set the `align-content` property to `normal` 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-name}:{prefix}{value}`
+//
+// e.g. `.hover:align-content-normal` will set the `align-content` property to `normal` 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:align-content-normal` will set the `align-content` property to `normal` when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//   <div class="align-content-normal">This content is aligned normally.</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 align content property, create a utility class.
+  @each $name, $value in defaults.$align-content-properties {
+    // e.g. `.align-content-normal` or `.align-content-start`
+    $selector: #{$selector-prefix}#{defaults.$align-content-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      align-content,
+      $value,
+      $important: #{defaults.$use-important}
+    );
+  }
+
+  // For each align items property, create a utility class.
+  @each $name, $value in defaults.$align-items-properties {
+    // e.g. `.align-items-start` or `.align-items-center`
+    $selector: #{$selector-prefix}#{defaults.$align-items-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      align-items,
+      $value,
+      $important: #{defaults.$use-important}
+    );
+  }
+
+  // For each align self property, create a utility class.
+  @each $name, $value in defaults.$align-self-properties {
+    // e.g. `.align-self-auto` or `.align-self-center`
+    $selector: #{$selector-prefix}#{defaults.$align-self-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      align-self,
+      $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 align content property, create a utility class.
+      @each $name, $value in defaults.$align-content-properties {
+        // e.g. `.md:align-content-normal` or `.lg:align-content-start`
+        $selector: #{$selector-prefix}#{defaults.$align-content-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-content,
+          $value,
+          $important: #{defaults.$use-important},
+          $screen: $screen-name
+        );
+      }
+
+      // For each align items property, create a utility class.
+      @each $name, $value in defaults.$align-items-properties {
+        // e.g. `.md:align-items-start` or `.lg:align-items-center`
+        $selector: #{$selector-prefix}#{defaults.$align-items-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-items,
+          $value,
+          $important: #{defaults.$use-important},
+          $screen: $screen-name
+        );
+      }
+
+      // For each align self property, create a utility class.
+      @each $name, $value in defaults.$align-self-properties {
+        // e.g. `.md:align-self-auto` or `.lg:align-self-center`
+        $selector: #{$selector-prefix}#{defaults.$align-self-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-self,
+          $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 align content property, create a utility class.
+        @each $name, $value in defaults.$align-content-properties {
+          // e.g. `.dark:align-content-normal` or `.light:align-content-start`
+          $selector: #{$selector-prefix}#{defaults.$align-content-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            align-content,
+            $value,
+            $important: #{defaults.$use-important},
+            $theme: $theme-name
+          );
+        }
+
+        // For each align items property, create a utility class.
+        @each $name, $value in defaults.$align-items-properties {
+          // e.g. `.dark:align-items-start` or `.light:align-items-center`
+          $selector: #{$selector-prefix}#{defaults.$align-items-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            align-items,
+            $value,
+            $important: #{defaults.$use-important},
+            $theme: $theme-name
+          );
+        }
+
+        // For each align self property, create a utility class.
+        @each $name, $value in defaults.$align-self-properties {
+          // e.g. `.dark:align-self-auto` or `.light:align-self-center`
+          $selector: #{$selector-prefix}#{defaults.$align-self-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            align-self,
+            $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 align content property, create a utility class.
+      @each $name, $value in defaults.$align-content-properties {
+        // e.g. `.hover:align-content-normal` or `.focus:align-content-start`
+        $selector: #{$selector-prefix}#{defaults.$align-content-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-content,
+          $value,
+          $important: #{defaults.$use-important},
+          $state: $state-name
+        );
+      }
+
+      // For each align items property, create a utility class.
+      @each $name, $value in defaults.$align-items-properties {
+        // e.g. `.hover:align-items-start` or `.focus:align-items-center`
+        $selector: #{$selector-prefix}#{defaults.$align-items-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-items,
+          $value,
+          $important: #{defaults.$use-important},
+          $state: $state-name
+        );
+      }
+
+      // For each align self property, create a utility class.
+      @each $name, $value in defaults.$align-self-properties {
+        // e.g. `.hover:align-self-auto` or `.focus:align-self-center`
+        $selector: #{$selector-prefix}#{defaults.$align-self-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-self,
+          $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 align content property, create a utility class.
+      @each $name, $value in defaults.$align-content-properties {
+        // e.g. `.md:align-content-normal` or `.lg:align-content-start`
+        $selector: #{$selector-prefix}#{defaults.$align-content-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-content,
+          $value,
+          $important: #{defaults.$use-important},
+          $container: $container-name
+        );
+      }
+
+      // For each align items property, create a utility class.
+      @each $name, $value in defaults.$align-items-properties {
+        // e.g. `.md:align-items-start` or `.lg:align-items-center`
+        $selector: #{$selector-prefix}#{defaults.$align-items-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-items,
+          $value,
+          $important: #{defaults.$use-important},
+          $container: $container-name
+        );
+      }
+
+      // For each align self property, create a utility class.
+      @each $name, $value in defaults.$align-self-properties {
+        // e.g. `.md:align-self-auto` or `.lg:align-self-center`
+        $selector: #{$selector-prefix}#{defaults.$align-self-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          align-self,
+          $value,
+          $important: #{defaults.$use-important},
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

package/{src/scss/utilities/display → packages/core/src/scss/utilities/alignment}/_variables.scss

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