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

package/packages/core/src/scss/theme/typography/_variables.scss

@@ -0,0 +1,248 @@
+// @graupl/core typography theme variables.
+//
+// These values are to be used to directly style components and provide a
+// cleaner way to reference custom properties.
+
+@use "../../defaults" as root-defaults;
+@use "../../variables" as root-variables;
+@use "../color/variables" as color-variables;
+@use "defaults";
+@use "sass:map";
+
+// Font properties.
+$font-size-base: var(
+  --#{root-defaults.$prefix}font-size-base,
+  #{defaults.$font-size-base}
+);
+$line-height: var(
+  --#{root-defaults.$prefix}line-height,
+  #{defaults.$line-height}
+);
+
+// Generate all of the font-size-x custom properties.
+$font-sizes: ();
+
+@each $key, $value in defaults.$font-size-multipliers {
+  $size: var(
+    --#{root-defaults.$prefix}font-#{$key},
+    calc(#{$value} * #{$font-size-base})
+  );
+  $font-sizes: map.set($font-sizes, $key, $size);
+}
+
+$font-weights: ();
+
+@each $key, $value in defaults.$font-weights {
+  $weight: var(--#{root-defaults.$prefix}font-weight-#{$key}, $value);
+  $font-weights: map.set($font-weights, $key, $weight);
+}
+
+$font-weight-bold: var(
+  --#{root-defaults.$prefix}font-weight-bold,
+  #{map.get($font-weights, bold)}
+);
+
+// Root properties.
+$root-font-family: var(
+  --#{root-defaults.$prefix}root-font-family,
+  #{defaults.$root-font-family}
+);
+$root-font-size: var(
+  --#{root-defaults.$prefix}root-font-size,
+  #{defaults.$root-font-size}
+);
+
+// Typography properties.
+$body-font-size: var(
+  --#{root-defaults.$prefix}body-font-size,
+  #{map.get($font-sizes, base)}
+);
+$body-line-height: var(
+  --#{root-defaults.$prefix}body-line-height,
+  #{$line-height}
+);
+$body-font-weight: var(
+  --#{root-defaults.$prefix}body-font-weight,
+  #{map.get($font-weights, normal)}
+);
+$body-color: var(
+  --#{root-defaults.$prefix}body-color,
+  #{color-variables.$color}
+);
+$paragraph-font-size: var(
+  --#{root-defaults.$prefix}paragraph-font-size,
+  #{$body-font-size}
+);
+$paragraph-line-height: var(
+  --#{root-defaults.$prefix}paragraph-line-height,
+  #{$body-line-height}
+);
+$paragraph-margin: var(
+  --#{root-defaults.$prefix}paragraph-margin,
+  0 0 #{map.get(root-variables.$spacers, 2)} 0
+);
+$paragraph-font-weight: var(
+  --#{root-defaults.$prefix}paragraph-font-weight,
+  #{$body-font-weight}
+);
+$paragraph-color: var(
+  --#{root-defaults.$prefix}paragraph-color,
+  #{$body-color}
+);
+$small-font-size: var(
+  --#{root-defaults.$prefix}small-font-size,
+  #{map.get($font-sizes, sm)}
+);
+$small-line-height: var(
+  --#{root-defaults.$prefix}small-line-height,
+  #{$line-height}
+);
+$small-margin: var(
+  --#{root-defaults.$prefix}small-margin,
+  0 0 #{map.get(root-variables.$spacers, 2)} 0
+);
+$small-font-weight: var(
+  --#{root-defaults.$prefix}small-font-weight,
+  #{$body-font-weight}
+);
+$small-color: var(--#{root-defaults.$prefix}small-color, #{$body-color});
+
+// Headings properties.
+$heading-font-family: var(
+  --#{root-defaults.$prefix}heading-font-family,
+  $root-font-family
+);
+$heading-line-height: var(
+  --#{root-defaults.$prefix}heading-line-height,
+  #{$line-height}
+);
+$heading-margin: var(
+  --#{root-defaults.$prefix}heading-margin,
+  #{map.get(root-variables.$spacers, 5)} 0
+    #{map.get(root-variables.$spacers, 2)} 0
+);
+$heading-font-weight: var(
+  --#{root-defaults.$prefix}heading-font-weight,
+  #{$font-weight-bold}
+);
+$heading-color: var(--#{root-defaults.$prefix}heading-color, #{$body-color});
+
+// H1 properties.
+$h1-font-size: var(
+  --#{root-defaults.$prefix}h1-font-size,
+  #{map.get($font-sizes, 5xl)}
+);
+$h1-line-height: var(
+  --#{root-defaults.$prefix}h1-line-height,
+  #{$heading-line-height}
+);
+$h1-margin: var(--#{root-defaults.$prefix}h1-margin, #{$heading-margin});
+$h1-font-family: var(
+  --#{root-defaults.$prefix}h1-font-family,
+  $heading-font-family
+);
+$h1-font-weight: var(
+  --#{root-defaults.$prefix}h1-font-weight,
+  $heading-font-weight
+);
+$h1-color: var(--#{root-defaults.$prefix}h1-color, #{$heading-color});
+
+// H2 properties.
+$h2-font-size: var(
+  --#{root-defaults.$prefix}h2-font-size,
+  #{map.get($font-sizes, 4xl)}
+);
+$h2-line-height: var(
+  --#{root-defaults.$prefix}h2-line-height,
+  #{$heading-line-height}
+);
+$h2-margin: var(--#{root-defaults.$prefix}h2-margin, #{$heading-margin});
+$h2-font-family: var(
+  --#{root-defaults.$prefix}h2-font-family,
+  $heading-font-family
+);
+$h2-font-weight: var(
+  --#{root-defaults.$prefix}h2-font-weight,
+  $heading-font-weight
+);
+$h2-color: var(--#{root-defaults.$prefix}h2-color, #{$heading-color});
+
+// H3 properties.
+$h3-font-size: var(
+  --#{root-defaults.$prefix}h3-font-size,
+  #{map.get($font-sizes, 3xl)}
+);
+$h3-line-height: var(
+  --#{root-defaults.$prefix}h3-line-height,
+  #{$heading-line-height}
+);
+$h3-margin: var(--#{root-defaults.$prefix}h3-margin, #{$heading-margin});
+$h3-font-family: var(
+  --#{root-defaults.$prefix}h3-font-family,
+  $heading-font-family
+);
+$h3-font-weight: var(
+  --#{root-defaults.$prefix}h3-font-weight,
+  $heading-font-weight
+);
+$h3-color: var(--#{root-defaults.$prefix}h3-color, #{$heading-color});
+
+// H4 properties.
+$h4-font-size: var(
+  --#{root-defaults.$prefix}h4-font-size,
+  #{map.get($font-sizes, 2xl)}
+);
+$h4-line-height: var(
+  --#{root-defaults.$prefix}h4-line-height,
+  #{$heading-line-height}
+);
+$h4-margin: var(--#{root-defaults.$prefix}h4-margin, #{$heading-margin});
+$h4-font-family: var(
+  --#{root-defaults.$prefix}h4-font-family,
+  $heading-font-family
+);
+$h4-font-weight: var(
+  --#{root-defaults.$prefix}h4-font-weight,
+  $heading-font-weight
+);
+$h4-color: var(--#{root-defaults.$prefix}h4-color, #{$heading-color});
+
+// H5 properties.
+$h5-font-size: var(
+  --#{root-defaults.$prefix}h5-font-size,
+  #{map.get($font-sizes, xl)}
+);
+$h5-line-height: var(
+  --#{root-defaults.$prefix}h5-line-height,
+  #{$heading-line-height}
+);
+$h5-margin: var(--#{root-defaults.$prefix}h5-margin, #{$heading-margin});
+$h5-font-family: var(
+  --#{root-defaults.$prefix}h5-font-family,
+  $heading-font-family
+);
+$h5-font-weight: var(
+  --#{root-defaults.$prefix}h5-font-weight,
+  $heading-font-weight
+);
+$h5-color: var(--#{root-defaults.$prefix}h5-color, #{$heading-color});
+
+// H6 properties.
+$h6-font-size: var(
+  --#{root-defaults.$prefix}h6-font-size,
+  #{map.get($font-sizes, lg)}
+);
+$h6-line-height: var(
+  --#{root-defaults.$prefix}h6-line-height,
+  #{$heading-line-height}
+);
+$h6-margin: var(--#{root-defaults.$prefix}h6-margin, #{$heading-margin});
+$h6-font-family: var(
+  --#{root-defaults.$prefix}h6-font-family,
+  $heading-font-family
+);
+$h6-font-weight: var(
+  --#{root-defaults.$prefix}h6-font-weight,
+  $heading-font-weight
+);
+$h6-color: var(--#{root-defaults.$prefix}h6-color, #{$heading-color});

package/{src → packages/core/src}/scss/utilities/_index.scss

@@ -1,9 +1,13 @@
-// @graupl/graupl utilities styles.
+// @graupl/core utilities styles.
 
 @forward "alignment";
+@forward "background";
+@forward "border";
 @forward "color";
+@forward "container";
 @forward "display";
 @forward "flex";
+@forward "gradient";
 @forward "height";
 @forward "inset";
 @forward "justification";
@@ -14,4 +18,6 @@
 @forward "spacing";
 @forward "typography";
 @forward "visibility";
+@forward "visually-hidden";
 @forward "width";
+@forward "z-index";

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

@@ -0,0 +1,41 @@
+// @graupl/core [_template] 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;
+
+// _Template properties.
+//
+// Remember when defining properties to make sure the defaults can be customized.
+// This can be done by using variables for class names, or by defining base properties and merging them with custom properties provided by the user.
+//
+// Remember to replace references like [_template], or other placeholder content with appropriate descriptions!
+
+$template-selector-prefix: "template-" !default;
+$base-template-properties: ();
+$custom-template-properties: () !default;
+$template-properties: map.merge(
+  $base-template-properties,
+  $custom-template-properties
+);

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;