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

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

@@ -0,0 +1,486 @@
+// @graupl/core flex utilities styles.
+//
+// This file generates the flex utility classes provided by Graupl.
+//
+// The following classes are generated by default:
+// - `.flex-row`: Sets the flex direction property to `row`.
+// - `.flex-row-reverse`: Sets the flex direction property to `row-reverse`.
+// - `.flex-col`: Sets the flex direction property to `column`.
+// - `.flex-col-reverse`: Sets the flex direction property to `column-reverse`.
+// - `.flex-wrap`: Sets the flex wrap property to `wrap`.
+// - `.flex-wrap-reverse`: Sets the flex wrap property to `wrap-reverse`.
+// - `.flex-nowrap`: Sets the flex wrap property to `nowrap`.
+// - `.flex-grow`: Sets the flex grow property to `1`.
+// - `.flex-no-grow`: Sets the flex grow property to `0`.
+// - `.flex-shrink`: Sets the flex shrink property to `1`.
+// - `.flex-no-shrink`: Sets the flex shrink property to `0`.
+// - `.flex-auto`: Sets the flex basis property to `auto`.
+// - `.flex-fit-content`: Sets the flex basis property to `fit-content`.
+// - `.flex-max-content`: Sets the flex basis property to `max-content`.
+// - `.flex-min-content`: Sets the flex basis property to `min-content`.
+// - `.flex-content`: Sets the flex basis property to `content`.
+// - `.flex-0`: Sets the flex basis property to `0`.
+// - `.flex-full`: Sets the flex basis property to `100%`.
+// - `.flex-quarter`: Sets the flex basis property to `25%`.
+// - `.flex-half`: Sets the flex basis property to `50%`.
+// - `.flex-three-quarters`: Sets the flex basis property to `75%`.
+// - `.flex-third: Sets the flex basis property to `33.333333%`.
+// - `.flex-two-thirds: Sets the flex basis property to `66.666667%`.
+//
+// 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.
+// - `$flex-direction-selector-prefix`: The prefix for the flex direction utility classes.
+// - `$base-flex-direction-properties`: The base properties and values for the flex direction utility classes.
+// - `$custom-flex-direction-properties`: The custom properties and values for the flex direction utility classes.
+// - `$flex-direction-properties`: The merged properties and values for the flex direction utility classes.
+// - `$flex-wrap-selector-prefix`: The prefix for the flex wrap utility classes.
+// - `$base-flex-wrap-properties`: The base properties and values for the flex wrap utility classes.
+// - `$custom-flex-wrap-properties`: The custom properties and values for the flex wrap utility classes.
+// - `$flex-wrap-properties`: The merged properties and values for the flex wrap utility classes.
+// - `$flex-grow-selector-prefix`: The prefix for the flex grow utility classes.
+// - `$base-flex-grow-properties`: The base properties and values for the flex grow utility classes.
+// - `$custom-flex-grow-properties`: The custom properties and values for the flex grow utility classes.
+// - `$flex-grow-properties`: The merged properties and values for the flex grow utility classes.
+// - `$flex-shrink-selector-prefix`: The prefix for the flex shrink utility classes.
+// - `$base-flex-shrink-properties`: The base properties and values for the flex shrink utility classes.
+// - `$custom-flex-shrink-properties`: The custom properties and values for the flex shrink utility classes.
+// - `$flex-shrink-properties`: The merged properties and values for the flex shrink utility classes.
+// - `$flex-basis-selector-prefix`: The prefix for the flex basis utility classes.
+// - `$base-flex-basis-properties`: The base properties and values for the flex basis utility classes.
+// - `$custom-flex-basis-properties`: The custom properties and values for the flex basis utility classes.
+// - `$flex-basis-properties`: The merged properties and values for the flex basis 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:flex-row` will set the `flex-direction` property to `row` 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:flex-row` will set the `flex-direction` property to `row` 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:flex-row` will set the `flex-direction` property to `row` 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:flex-row` will set the `flex-direction` property to `row` when the parent container is larger than the `md` breakpoint.
+//
+// @example
+//  <div class="flex-row">This element will have a flex direction of row.</div>
+
+@use "../../defaults" as root-defaults;
+@use "../../functions/important";
+@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 flex direction property, create a utility class.
+  @each $name, $property in defaults.$flex-direction-properties {
+    // e.g. `.flex-row` or `.flex-col`
+    $selector: #{$selector-prefix}#{defaults.$flex-direction-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      flex-direction,
+      $property,
+      $important: defaults.$use-important
+    );
+  }
+
+  // For each flex wrap property, create a utility class.
+  @each $name, $property in defaults.$flex-wrap-properties {
+    // e.g. `.flex-wrap` or `.flex-nowrap`
+    $selector: #{$selector-prefix}#{defaults.$flex-wrap-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      flex-wrap,
+      $property,
+      $important: defaults.$use-important
+    );
+  }
+
+  // For each flex grow property, create a utility class.
+  @each $name, $property in defaults.$flex-grow-properties {
+    // e.g. `.flex-grow` or `.flex-no-grow`
+    $selector: #{$selector-prefix}#{defaults.$flex-grow-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      flex-grow,
+      $property,
+      $important: defaults.$use-important
+    );
+  }
+
+  // For each flex shrink property, create a utility class.
+  @each $name, $property in defaults.$flex-shrink-properties {
+    // e.g. `.flex-shrink` or `.flex-no-shrink`
+    $selector: #{$selector-prefix}#{defaults.$flex-shrink-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      flex-shrink,
+      $property,
+      $important: defaults.$use-important
+    );
+  }
+
+  // For each flex basis property, create a utility class.
+  @each $name, $property in defaults.$flex-basis-properties {
+    // e.g. `.flex-min-content` or `.flex-max-content`
+    $selector: #{$selector-prefix}#{defaults.$flex-basis-selector-prefix}#{$name};
+
+    @include utility.create(
+      $selector,
+      flex-basis,
+      $property,
+      $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 flex direction property, create a utility class.
+      @each $name, $property in defaults.$flex-direction-properties {
+        // e.g. `.md:flex-row` or `.lg:flex-col`
+        $selector: #{$selector-prefix}#{defaults.$flex-direction-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-direction,
+          $property,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      // For each flex wrap property, create a utility class.
+      @each $name, $property in defaults.$flex-wrap-properties {
+        // e.g. `.md:flex-wrap` or `.lg:flex-nowrap`
+        $selector: #{$selector-prefix}#{defaults.$flex-wrap-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-wrap,
+          $property,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      // For each flex grow property, create a utility class.
+      @each $name, $property in defaults.$flex-grow-properties {
+        // e.g. `.md:flex-grow` or `.lg:flex-no-grow`
+        $selector: #{$selector-prefix}#{defaults.$flex-grow-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-grow,
+          $property,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      // For each flex shrink property, create a utility class.
+      @each $name, $property in defaults.$flex-shrink-properties {
+        // e.g. `.md:flex-shrink` or `.lg:flex-no-shrink`
+        $selector: #{$selector-prefix}#{defaults.$flex-shrink-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-shrink,
+          $property,
+          $important: defaults.$use-important,
+          $screen: $screen-name
+        );
+      }
+
+      // For each flex basis property, create a utility class.
+      @each $name, $property in defaults.$flex-basis-properties {
+        // e.g. `.md:flex-min-content` or `.lg:flex-max-content`
+        $selector: #{$selector-prefix}#{defaults.$flex-basis-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-basis,
+          $property,
+          $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 flex direction property, create a utility class.
+        @each $name, $property in defaults.$flex-direction-properties {
+          // e.g. `.dark:flex-row` or `.light:flex-col`
+          $selector: #{$selector-prefix}#{defaults.$flex-direction-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            flex-direction,
+            $property,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        // For each flex wrap property, create a utility class.
+        @each $name, $property in defaults.$flex-wrap-properties {
+          // e.g. `.dark:flex-wrap` or `.light:flex-nowrap`
+          $selector: #{$selector-prefix}#{defaults.$flex-wrap-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            flex-wrap,
+            $property,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        // For each flex grow property, create a utility class.
+        @each $name, $property in defaults.$flex-grow-properties {
+          // e.g. `.dark:flex-grow` or `.light:flex-no-grow`
+          $selector: #{$selector-prefix}#{defaults.$flex-grow-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            flex-grow,
+            $property,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        // For each flex shrink property, create a utility class.
+        @each $name, $property in defaults.$flex-shrink-properties {
+          // e.g. `.dark:flex-shrink` or `.light:flex-no-shrink`
+          $selector: #{$selector-prefix}#{defaults.$flex-shrink-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            flex-shrink,
+            $property,
+            $important: defaults.$use-important,
+            $theme: $theme-name
+          );
+        }
+
+        // For each flex basis property, create a utility class.
+        @each $name, $property in defaults.$flex-basis-properties {
+          // e.g. `.dark:flex-min-content` or `.light:flex-max-content`
+          $selector: #{$selector-prefix}#{defaults.$flex-basis-selector-prefix}#{$name};
+
+          @include utility.create(
+            $selector,
+            flex-basis,
+            $property,
+            $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 flex direction property, create a utility class.
+      @each $name, $property in defaults.$flex-direction-properties {
+        // e.g. `.hover:flex-row` or `.focus:flex-col`
+        $selector: #{$selector-prefix}#{defaults.$flex-direction-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-direction,
+          $property,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      // For each flex wrap property, create a utility class.
+      @each $name, $property in defaults.$flex-wrap-properties {
+        // e.g. `.hover:flex-wrap` or `.focus:flex-nowrap`
+        $selector: #{$selector-prefix}#{defaults.$flex-wrap-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-wrap,
+          $property,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      // For each flex grow property, create a utility class.
+      @each $name, $property in defaults.$flex-grow-properties {
+        // e.g. `.hover:flex-grow` or `.focus:flex-no-grow`
+        $selector: #{$selector-prefix}#{defaults.$flex-grow-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-grow,
+          $property,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      // For each flex shrink property, create a utility class.
+      @each $name, $property in defaults.$flex-shrink-properties {
+        // e.g. `.hover:flex-shrink` or `.focus:flex-no-shrink`
+        $selector: #{$selector-prefix}#{defaults.$flex-shrink-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-shrink,
+          $property,
+          $important: defaults.$use-important,
+          $state: $state-name
+        );
+      }
+
+      // For each flex basis property, create a utility class.
+      @each $name, $property in defaults.$flex-basis-properties {
+        // e.g. `.hover:flex-min-content` or `.focus:flex-max-content`
+        $selector: #{$selector-prefix}#{defaults.$flex-basis-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-basis,
+          $property,
+          $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 flex direction property, create a utility class.
+      @each $name, $property in defaults.$flex-direction-properties {
+        // e.g. `.md:flex-row` or `.lg:flex-col`
+        $selector: #{$selector-prefix}#{defaults.$flex-direction-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-direction,
+          $property,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      // For each flex wrap property, create a utility class.
+      @each $name, $property in defaults.$flex-wrap-properties {
+        // e.g. `.md:flex-wrap` or `.lg:flex-nowrap`
+        $selector: #{$selector-prefix}#{defaults.$flex-wrap-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-wrap,
+          $property,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      // For each flex grow property, create a utility class.
+      @each $name, $property in defaults.$flex-grow-properties {
+        // e.g. `.md:flex-grow` or `.lg:flex-no-grow`
+        $selector: #{$selector-prefix}#{defaults.$flex-grow-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-grow,
+          $property,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      // For each flex shrink property, create a utility class.
+      @each $name, $property in defaults.$flex-shrink-properties {
+        // e.g. `.md:flex-shrink` or `.lg:flex-no-shrink`
+        $selector: #{$selector-prefix}#{defaults.$flex-shrink-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-shrink,
+          $property,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+
+      // For each flex basis property, create a utility class.
+      @each $name, $property in defaults.$flex-basis-properties {
+        // e.g. `.md:flex-min-content` or `.lg:flex-max-content`
+        $selector: #{$selector-prefix}#{defaults.$flex-basis-selector-prefix}#{$name};
+
+        @include utility.create(
+          $selector,
+          flex-basis,
+          $property,
+          $important: defaults.$use-important,
+          $container: $container-name
+        );
+      }
+    }
+  }
+}

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

@@ -1,4 +1,4 @@
-// @graupl/graupl color utilities variables.
+// @graupl/core flex 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/gradient/_defaults.scss

@@ -0,0 +1,70 @@
+// @graupl/core gradient 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;
+
+// Gradient properties.
+$gradient-selector: "gradient" !default;
+$gradient-type-selector-prefix: "" !default;
+$gradient-direction-selector-prefix: "" !default;
+$gradient-color-selector-prefix: "" !default;
+$gradient-color-from-selector-prefix: "from-" !default;
+$gradient-color-to-selector-prefix: "to-" !default;
+$base-gradient-types: (
+  linear: linear-gradient,
+  radial: radial-gradient,
+);
+$custom-gradient-types: () !default;
+$gradient-types: map.merge($base-gradient-types, $custom-gradient-types);
+$base-gradient-directions: (
+  to-top: "to top",
+  to-right: "to right",
+  to-bottom: "to bottom",
+  to-left: "to left",
+  circle: circle,
+  circle-at-top: circle at top,
+  circle-at-right: circle at right,
+  circle-at-bottom: circle at bottom,
+  circle-at-left: circle at left,
+  ellipse: ellipse,
+  ellipse-at-top: ellipse at top,
+  ellipse-at-right: ellipse at right,
+  ellipse-at-bottom: ellipse at bottom,
+  ellipse-at-left: ellipse at left,
+  closest-side: closest-side,
+  closest-corner: closest-corner,
+  farthest-side: farthest-side,
+  farthest-corner: farthest-corner,
+);
+$custom-gradient-directions: () !default;
+$gradient-directions: map.merge(
+  $base-gradient-directions,
+  $custom-gradient-directions
+);
+$base-gradient-colors: (
+  transparent: transparent,
+);
+$custom-gradient-colors: () !default;
+$gradient-colors: map.merge($base-gradient-colors, $custom-gradient-colors);