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

package/index.html

@@ -15,7 +15,7 @@
     <p>This source code can be found in <a href="https://github.com/Graupl/graupl">GitHub</a>.</p>
     <p>Graupl supports light and dark modes out-of-the-box.</p>
     <button id="dark-mode-toggle" class="button mt-5 w-half">Toggle dark mode</button>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Buttons</h2>
       <p>There are 4 colours of buttons supported by default, with plans to have a "graupl-theme" plugin that adds more.
       </p>
@@ -34,7 +34,7 @@
         <a class="button" href="#" disabled>Anchor Button</a>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Form elements</h2>
       <p>Graupl provides default styling for all form elements.</p>
       <form class="full-width rg-4">
@@ -83,7 +83,7 @@
             </optgroup>
           </select>
         </div>
-        <div class="input-group"><label for"multi-select">Multi-select</label>
+        <div class="input-group"><label for="multi-select">Multi-select</label>
           <select id="multi-select" multiple>
             <option value="1">Option 1</option>
             <option value="2">Option 2</option>
@@ -131,7 +131,7 @@
         </div>
       </form>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Navigation</h2>
       <div class="py-7">
         <nav class="navigation" data-graupl-menu-type="DisclosureMenu"
@@ -155,7 +155,7 @@
         </nav>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Tables</h2>
       <p>Graupl provides some default styling for tables as well as some other useful features to customize them.</p>
       <table class="bordered striped-rows hoverable">
@@ -386,7 +386,7 @@
         </table>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Columns</h2>
       <div class="columns count-6 py-5">
         <div class="bg-primary-700 text-primary-100 py-7 px-5"></div>
@@ -403,7 +403,7 @@
         <div class="bg-primary-700 text-primary-100 py-7 px-5"></div>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Flex columns</h2>
       <div class="flex-columns py-5">
         <div class="col-6 col-md-8 col-xl-9 py-7 bg-primary-700 text-primary-100 px-5">
@@ -428,7 +428,7 @@
         <div class="col-4 py-7 bg-primary-700 text-primary-100 px-5"></div>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Cards</h2>
       <p>Cards using the <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.top</span> class
         will have the image placed on the top while cards using the <span
@@ -533,7 +533,7 @@
         </div>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Horizontal Cards</h2>
       <p>Cards using the <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.right</span> class
         will have the image placed on the right while cards using the <span
@@ -638,7 +638,7 @@
         </div>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Inverse Cards</h2>
       <p>Cards using the <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.inverse</span>
         class will have the image placed on the right if it is a horizontal card and on the bottom if it is a vertical
@@ -681,7 +681,7 @@
         </div>
       </div>
     </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Alerts</h2>
       <div class="display-grid g-5">
         <div class="alert">
@@ -788,7 +788,7 @@
           </div>
         </div>
       </div>
-    <div class="full-width container min-h-full-screen align-content-center">
+    <div class="full-width container py-10 my-10 align-content-center">
       <h2>Carousels</h2>
       <section class="carousel">
         <div class="carousel-control-container">
@@ -822,6 +822,78 @@
         </div>
       </section>
     </div>
+    <div class="full-width container py-10 my-10 align-content-center">
+      <h2>Lists</h2>
+      <p>Lists are inspired by Bootstrap's list groups.</p>
+      <h3>Unordered list</h3>
+      <ul class="list">
+        <li class="list-item">
+          <a href="#">List item 1</a>
+        </li>
+        <li class="list-item">
+          List item 2
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 3</a>
+        </li>
+      </ul>
+      <h3>Ordered list</h3>
+      <p>You can add the list markers back in using utility classes (in this case <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.list-style-decimal</span> and <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.list-style-inside</span>).</p>
+      <ol class="list list-style-decimal list-style-inside">
+        <li class="list-item">
+          <a href="#">List item 1</a>
+        </li>
+        <li class="list-item">
+          List item 2
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 3</a>
+        </li>
+      </ol>
+      <h3>Inline lists</h3>
+      <p>We can achieve an inline list by utilizing the <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.columns</span> class.</p>
+      <ul class="list columns">
+        <li class="list-item">
+          <a href="#">List item 1</a>
+        </li>
+        <li class="list-item">
+          List item 2
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 3</a>
+        </li>
+        <li class="list-item">
+          <a href="#">List item 4</a>
+        </li>
+        <li class="list-item">
+          List item 5
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 6</a>
+        </li>
+      </ul>
+      <p class="pt-5">We can also use the <span class="display-inline-block text-tertiary-800 bg-secondary-100 px-1">.display-flex</span> utility class.</p>
+      <ul class="list display-flex">
+        <li class="list-item">
+          <a href="#">List item 1</a>
+        </li>
+        <li class="list-item">
+          List item 2
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 3</a>
+        </li>
+        <li class="list-item">
+          <a href="#">List item 4</a>
+        </li>
+        <li class="list-item">
+          List item 5
+        </li>
+        <li class="list-item">
+          <a href="#" class="stretched">List item 6</a>
+        </li>
+      </ul>
+    </div>
   </main>
   <script src="https://cdn.jsdelivr.net/npm/accessible-menu/dist/disclosure-menu.iife.js"></script>
   <script type="module" src="src/js/alert/index.js"></script>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graupl/graupl",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.2",
   "description": "A modular and modern CSS framework.",
   "type": "module",
   "exports": {

package/scss/component/list.scss

@@ -0,0 +1,3 @@
+// @graupl/graupl list component.
+
+@forward "../../src/scss/component/list";

package/scss/utilities/border.scss

@@ -0,0 +1,3 @@
+// @graupl/graupl border utilities.
+
+@forward "../../src/scss/utilities/border";

package/src/scss/_defaults.scss

@@ -9,11 +9,15 @@
 @use "sass:map";
 
 // Prefix for custom properties and other naming conventions.
-$prefix: "graupl-" !default;
+$id: "graupl" !default;
+$prefix: "#{$id}-" !default;
 
 // Settings.
 $use-important: true !default;
-$responsive-utilities: true !default;
+$screen-aware-utilities: true !default;
+$theme-aware-utilities: true !default;
+$state-aware-utilities: true !default;
+$use-layers: true !default;
 
 // Layout properties.
 $content-max-width: 96ch !default;
@@ -87,7 +91,7 @@ $interactive-min-height: 44px !default;
 
 // Border properties.
 $border-radius: 0.125rem !default;
-$border-width: 2px !default;
+$border-width: 0.125rem !default;
 $border-style: solid !default;
 
 // Transition properties.
@@ -132,5 +136,10 @@ $base-state-selectors: (
 $custom-state-selectors: () !default;
 $state-selectors: map.merge($base-state-selectors, $custom-state-selectors);
 
-// Responsive utility separator.
-$responsive-separator: "\\:" !default;
+// Utility properties.
+$utility-selector-prefix: "." !default;
+
+// Utility modifier separators.
+$utility-screen-aware-separator: "\\:" !default;
+$utility-theme-aware-separator: "\\:" !default;
+$utility-state-aware-separator: "\\:" !default;

package/src/scss/component/_index.scss

@@ -5,5 +5,6 @@
 @forward "card";
 @forward "carousel";
 @forward "input-group";
+@forward "list";
 @forward "menu";
 @forward "navigation";

package/src/scss/component/input-group/_index.scss

@@ -37,7 +37,7 @@
     }
   }
 
-  @include screen.up(xs) {
+  @include screen.down(xs) {
     #{defaults.$input-group-selector}#{defaults.$input-group-inline-selector} {
       grid-template-areas: $input-group-grid-template-areas;
       grid-template-columns: $input-group-grid-template-columns;

package/src/scss/component/list/_defaults.scss

@@ -0,0 +1,15 @@
+// @graupl/graupl list component 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.
+
+// Card selectors.
+$list-selector: ".list" !default;
+$list-item-selector: ".list-item" !default;
+
+// List item properties.
+$list-item-transform: none !default;
+$list-item-hover-transform: $list-item-transform !default;

package/src/scss/component/list/_index.scss

@@ -0,0 +1,50 @@
+// @graupl/graupl card component styles.
+
+@use "../../defaults" as root-defaults;
+@use "../../mixins/animation";
+@use "../../mixins/layer" as *;
+@use "defaults";
+@use "sass:map";
+@use "variables" as *;
+
+@include layer(component) {
+  #{defaults.$list-selector} {
+    display: grid;
+    position: relative;
+    margin: $list-margin;
+    padding: $list-padding;
+    border: $list-border;
+    border-radius: $list-border-radius;
+    list-style: none;
+    gap: $list-gap;
+  }
+
+  #{defaults.$list-item-selector} {
+    position: relative;
+    padding: $list-item-padding;
+    transform: $list-item-transform;
+    transition: $list-item-transition;
+    border: $list-item-border;
+    border-radius: $list-item-border-radius;
+
+    @each $selector in map.get(root-defaults.$state-selectors, hover) {
+      &#{$selector} {
+        --#{root-defaults.$prefix}list-item-transform: $list-item-hover-transform;
+      }
+    }
+  }
+}
+
+@include layer(theme) {
+  #{defaults.$list-selector} {
+    border-color: $list-border-color;
+    background: $list-background;
+    color: $list-color;
+  }
+
+  #{defaults.$list-item-selector} {
+    border-color: $list-item-border-color;
+    background: $list-item-background;
+    color: $list-item-color;
+  }
+}

package/src/scss/component/list/_variables.scss

@@ -0,0 +1,176 @@
+// @graupl/graupl list component 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 "../../theme/color/variables" as color;
+@use "../../variables" as root-variables;
+@use "defaults";
+@use "sass:map";
+
+// List properties.
+$list-padding-x: var(
+  --#{root-defaults.$prefix}list-padding-x,
+  #{map.get(root-variables.$spacers, 0)}
+);
+$list-padding-y: var(
+  --#{root-defaults.$prefix}list-padding-y,
+  #{map.get(root-variables.$spacers, 0)}
+);
+$list-padding: var(
+  --#{root-defaults.$prefix}list-padding,
+  #{$list-padding-y} #{$list-padding-x}
+);
+$list-margin-x: var(
+  --#{root-defaults.$prefix}list-margin-x,
+  #{map.get(root-variables.$spacers, 0)}
+);
+$list-margin-y: var(
+  --#{root-defaults.$prefix}list-margin-y,
+  #{map.get(root-variables.$spacers, 0)}
+);
+$list-margin: var(
+  --#{root-defaults.$prefix}list-margin,
+  #{$list-margin-y} #{$list-margin-x}
+);
+
+// List gap properties.
+$list-column-gap: var(
+  --#{root-defaults.$prefix}list-column-gap,
+  #{map.get(root-variables.$spacers, 2)}
+);
+$list-row-gap: var(
+  --#{root-defaults.$prefix}list-row-gap,
+  #{map.get(root-variables.$spacers, 2)}
+);
+$list-gap: var(
+  --#{root-defaults.$prefix}list-gap,
+  #{$list-column-gap} #{$list-row-gap}
+);
+
+// List color properties.
+$list-background: var(
+  --#{root-defaults.$prefix}list-background,
+  #{color.$root-background}
+);
+$list-color: var(--#{root-defaults.$prefix}list-color, #{color.$root-color});
+
+// List border-properties.
+$list-border-color: var(
+  --#{root-defaults.$prefix}list-border-color,
+  #{$list-color}
+);
+$list-top-left-border-radius: var(
+  --#{root-defaults.$prefix}list-top-left-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-top-right-border-radius: var(
+  --#{root-defaults.$prefix}list-top-right-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-bottom-left-border-radius: var(
+  --#{root-defaults.$prefix}list-bottom-left-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-bottom-right-border-radius: var(
+  --#{root-defaults.$prefix}list-bottom-right-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-border-radius: var(
+  --#{root-defaults.$prefix}list-border-radius,
+  #{$list-top-left-border-radius} #{$list-top-right-border-radius}
+    #{$list-bottom-right-border-radius} #{$list-bottom-left-border-radius}
+);
+$list-border-style: var(
+  --#{root-defaults.$prefix}list-border-style,
+  #{root-variables.$border-style}
+);
+$list-border-width: var(--#{root-defaults.$prefix}list-border-width, 0);
+$list-border: var(
+  --#{root-defaults.$prefix}list-border,
+  #{$list-border-width} #{$list-border-style}
+);
+
+// List item properties.
+$list-item-padding-x: var(
+  --#{root-defaults.$prefix}list-item-padding-x,
+  #{map.get(root-variables.$spacers, 5)}
+);
+$list-item-padding-y: var(
+  --#{root-defaults.$prefix}list-item-padding-y,
+  #{map.get(root-variables.$spacers, 3)}
+);
+$list-item-padding: var(
+  --#{root-defaults.$prefix}list-item-padding,
+  #{$list-item-padding-y} #{$list-item-padding-x}
+);
+$list-item-transition: var(
+  --#{root-defaults.$prefix}list-item-transition,
+  transform #{map.get(root-variables.$transition-durations, fast)}
+    #{root-variables.$transition-timing-function}
+);
+$list-item-transition-reduced-motion: var(
+  --#{root-defaults.$prefix}list-item-transition-reduced-motion,
+  none
+);
+
+// List item transform properties.
+$list-item-transform: var(
+  --#{root-defaults.$prefix}list-item-transform,
+  #{defaults.$list-item-transform}
+);
+$list-item-hover-transform: var(
+  --#{root-defaults.$prefix}list-item-hover-transform,
+  #{defaults.$list-item-hover-transform}
+);
+
+// List item color properties.
+$list-item-background: var(
+  --#{root-defaults.$prefix}list-item-background,
+  #{color.$root-background}
+);
+$list-item-color: var(
+  --#{root-defaults.$prefix}list-item-color,
+  #{color.$root-color}
+);
+
+// List item border-properties.
+$list-item-border-color: var(
+  --#{root-defaults.$prefix}list-item-border-color,
+  #{$list-item-color}
+);
+$list-item-top-left-border-radius: var(
+  --#{root-defaults.$prefix}list-item-top-left-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-item-top-right-border-radius: var(
+  --#{root-defaults.$prefix}list-item-top-right-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-item-bottom-left-border-radius: var(
+  --#{root-defaults.$prefix}list-item-bottom-left-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-item-bottom-right-border-radius: var(
+  --#{root-defaults.$prefix}list-item-bottom-right-border-radius,
+  #{root-variables.$border-radius}
+);
+$list-item-border-radius: var(
+  --#{root-defaults.$prefix}list-item-border-radius,
+  #{$list-item-top-left-border-radius} #{$list-item-top-right-border-radius}
+    #{$list-item-bottom-right-border-radius}
+    #{$list-item-bottom-left-border-radius}
+);
+$list-item-border-style: var(
+  --#{root-defaults.$prefix}list-item-border-style,
+  #{root-variables.$border-style}
+);
+$list-item-border-width: var(
+  --#{root-defaults.$prefix}list-item-border-width,
+  #{root-variables.$border-width}
+);
+$list-item-border: var(
+  --#{root-defaults.$prefix}list-item-border,
+  #{$list-item-border-width} #{$list-item-border-style}
+);

package/src/scss/functions/_screen.scss

@@ -7,12 +7,20 @@
 @use "sass:list";
 
 @function min($size) {
+  @if not map.has-key(root-defaults.$screen-sizes, $size) {
+    @error "The screen size \"#{$size}\" does not exist.";
+  }
+
   $screen-size: map.get(root-defaults.$screen-sizes, $size);
 
   @return $screen-size;
 }
 
 @function max($size) {
+  @if not map.has-key(root-defaults.$screen-sizes, $size) {
+    @error "The screen size \"#{$size}\" does not exist.";
+  }
+
   $keys: map.keys(root-defaults.$screen-sizes);
   $index: list.index($keys, "#{$size}");
   $key: list.nth($keys, $index + 1);

package/src/scss/functions/_utility.scss

@@ -0,0 +1,28 @@
+// @graupl/graupl utility functions.
+//
+// Functions to help generate utility classes.
+
+@use "sass:map";
+
+/// Convert a property and value to a map.
+///
+/// This mixin is used internally.
+///
+/// @param {string|List} $property
+///   The property/properties to convert to keys.
+/// @param {string}      $value
+///   The value to use for keys.
+@function convert-property-values-to-map($property, $value) {
+  $map: ();
+
+  @each $prop in $property {
+    $map: map.merge(
+      $map,
+      (
+        $prop: $value,
+      )
+    );
+  }
+
+  @return $map;
+}

package/src/scss/mixins/_layer.scss

@@ -6,7 +6,11 @@
 @use "../defaults" as root-defaults;
 
 @mixin layer($layer) {
-  @layer #{root-defaults.$prefix}.#{$layer} {
+  @if root-defaults.$use-layers {
+    @layer #{root-defaults.$id}.#{$layer} {
+      @content;
+    }
+  } @else {
     @content;
   }
 }

package/src/scss/mixins/_screen.scss

@@ -6,7 +6,6 @@
 @use "../functions/screen";
 @use "../defaults" as root-defaults;
 @use "sass:map";
-@use "sass:list";
 @use "sass:meta";
 
 // A mixin to generate a minimum screen width media query.
@@ -45,12 +44,34 @@
 }
 
 @mixin trigger($trigger) {
+  @if not map.has-key(root-defaults.$screen-size-triggers, $trigger) {
+    @error "The screen size trigger \"#{$trigger}\" does not exist.";
+  }
+
   $screen-size-trigger: map.get(root-defaults.$screen-size-triggers, $trigger);
+
+  @if not map.has-key($screen-size-trigger, "mixin") {
+    @error "The screen size trigger \"#{$trigger}\" does not have a mixin key.";
+  }
+
+  @if not map.has-key($screen-size-trigger, "args") {
+    @error "The screen size trigger \"#{$trigger}\" does not have an args key.";
+  }
+
   $mixin-name: map.get($screen-size-trigger, "mixin");
   $mixin-args: map.get($screen-size-trigger, "args");
+
+  @if not meta.mixin-exists($mixin-name) {
+    @error "The mixin \"#{$mixin-name}\" does not exist.";
+  }
+
   $mixin: meta.get-mixin($mixin-name);
 
-  @include meta.apply($mixin, $mixin-args...) {
-    @content;
+  @if meta.accepts-content($mixin) {
+    @include meta.apply($mixin, $mixin-args...) {
+      @content;
+    }
+  } @else {
+    @warn "The mixin \"#{$mixin-name}\" does not accept content.";
   }
 }

package/src/scss/mixins/_state.scss

@@ -0,0 +1,18 @@
+// @graupl/graupl state mixins.
+//
+// A series of mixins to tie styles to a state.
+
+@use "../defaults" as root-defaults;
+@use "sass:map";
+
+/// Applies styles to a specific state.
+///
+/// @param {string} $state
+///   The name of the state to apply the styles to.
+@mixin state($state) {
+  @each $selector in map.get(root-defaults.$state-selectors, $state) {
+    &#{$selector} {
+      @content;
+    }
+  }
+}

package/src/scss/mixins/_theme.scss

@@ -0,0 +1,15 @@
+// @graupl/graupl theme mixins.
+//
+// A series of mixins to tie styles to a theme-mode.
+
+@use "../theme/color/defaults" as color-defaults;
+
+/// Applies styles to a specific theme mode.
+///
+/// @param {string} $theme-name
+///   The name of the theme mode to apply the styles to.
+@mixin theme($theme-name) {
+  #{color-defaults.$theme-selector-prefix}#{$theme-name}#{color-defaults.$theme-selector-suffix} {
+    @content;
+  }
+}