@apolitical/component-library 0.0.4-beta.1 → 0.0.4-beta.3

package/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react/jsx-runtime"),n={};function o(r){return e.jsx("div",{className:n.container,children:e.jsx("h1",{children:"Component library demo!"})})}exports.Demo=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react/jsx-runtime"),n="_container_a7v7k_1",o={container:n};function t(r){return e.jsx("div",{className:o.container,children:e.jsx("h1",{children:"Component library demo!"})})}exports.Demo=t;

package/index.mjs

@@ -1,8 +1,10 @@
-import { jsx as o } from "react/jsx-runtime";
-const r = {};
-function t(e) {
-  return /* @__PURE__ */ o("div", { className: r.container, children: /* @__PURE__ */ o("h1", { children: "Component library demo!" }) });
+import { jsx as n } from "react/jsx-runtime";
+const o = "_container_a7v7k_1", r = {
+  container: o
+};
+function c(e) {
+  return /* @__PURE__ */ n("div", { className: r.container, children: /* @__PURE__ */ n("h1", { children: "Component library demo!" }) });
 }
 export {
-  t as Demo
+  c as Demo
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/component-library",
-  "version": "0.0.4-beta.1",
+  "version": "0.0.4-beta.3",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/style.css

@@ -1 +1 @@
-h1{color:#4f43ba}
+._container_a7v7k_1 h1{color:#4f43ba}

package/styles/README.md

@@ -0,0 +1,53 @@
+# Styles
+
+## `#root`
+
+NextJS is very opinionated and won't let us style general elements (e.g. `h1`) - it wants elements to be 'pure', using classes or IDs to identify them (e.g. `.specific-section h1`).
+
+To get the benefit of global base styling, where we get styling out of the box without having to explicitly add it to every element, we use the `#root` ID, on the `body`, to scope our global styling.
+
+### Adding a selector between `#root` and an element
+
+One of the big benefits of using Sass is the `&` selector, which uses the full path to the element as the selector, letting us quickly add different states, like `:hover` and `:focus`, or show different styling inside a specific parent element.
+
+This works as expected for states, but - because we scope everything to `#root` - using `&` would result in a selector like `.new-parent #root .element` - which is not going to be a valid path.
+
+Instead, we've created a mixin, `selector-after-root`, to write the expected path.
+
+`@include selector-after-root('.element')` will translate to the path `#root .element &`.
+
+---
+
+## `@layer`
+
+We're using [CSS cascade layers (`@layer`)](https://www.smashingmagazine.com/2022/01/introduction-css-cascade-layers/) to organise our styles, to help us avoid specificity issues and to make it easier to find and update styles.
+
+The `global.css` file defines the order of our layers, with the browser reset as the lowest.
+
+If you need to overwrite CSS, you don't need to create an overly specific (and less performant) rule or add an `!important` (as an aside: please, please [never add an `!important`](https://dev.to/alvaromontoro/using-important-in-css-75c)) - just put the styling in a higher layer.
+
+---
+
+## `button` styling
+
+We handle button styling through classes.
+
+### Variations
+
+By default, buttons have `primary` styling (a purple background and white text) and don't need a `primary` class to be styled. Buttons can also be `secondary` (a ghost button with a purple border) or `tertiary` (no border or background color). There are additional variations for `destructive` (only available on primary buttons), `muted` (only available on secondary and tertiary buttons), and `disabled`.
+
+### Sizes
+
+By default, buttons are `medium`. They don't need a class to be styled. Buttons can also be `small` or `large`.
+
+### Icons
+
+Buttons can have an icon but - because we can't mix pre-processing and data passed into CSS for file names, like CSS variables or data attributes - icons on buttons need to be set up in advance with classes. The list of available icons is maintained in `base-styles/buttons/_icons.scss`. To add a new icon, add a new item to the list with arguments for the sizes on large, medium, and small buttons.
+
+To add an icon to a button, add the class name `icon [file name of icon without file extension]`, e.g. `icon heart_empty`.
+
+The icon file, with a matching name, should be uploaded to the `apolitical-assets` bucket on Google Cloud Platform. (Referred to as `$assets-bucket` in the styling.)
+
+You can also pass `left` or `right` to position the icon - this will add margin between the text and the icon. e.g. `icon heart_empty right`.
+
+You can change the icon on hover by adding a second file name, prepended with `hover_`, e.g. `icon heart_empty hover_heart` will change the heart icon from an outline to a filled in heart on hover.

package/styles/base-styles/_accessibility.scss

@@ -0,0 +1,31 @@
+@use 'sass:map';
+@import './../functions',
+        './../mixins',
+        './../variables';
+
+@layer base {
+  #root {
+
+    /* stylelint-disable no-descending-specificity */
+    a, button, input, textarea, [role="menu"], li[tabindex] {
+      &:focus, &:focus-visible {
+        outline: none;
+        box-shadow: $outline map.get($theme, 'default_focus');
+      }
+      &:active { box-shadow: none; }
+    }
+
+    [role="menu"], [role="menu"] a, li[tabindex] {
+      &:focus, &:focus-visible { box-shadow: $outline map.get($theme, 'default_focus') inset; }
+    }
+    /* stylelint-enable no-descending-specificity */
+
+    .hidden {
+      width: 0;
+      height: 0;
+      display: block;
+      overflow: hidden;
+    }
+  }
+}
+

package/styles/base-styles/_blockquotes.scss

@@ -0,0 +1,31 @@
+@use 'sass:map';
+@import './../functions',
+        './../mixins',
+        './../variables';
+
+$blockquote: ('margin-top': 20, 'margin-top_md': 30, 'margin-bottom': 10, 'margin-bottom_md': 20, 'padding-vertical': 4, 'padding-left': 24, 'font-size': 18, 'font-size_md': 20, 'line-height': 28, 'border-width': 6);
+
+@layer base {
+  #root {
+    blockquote {
+      margin: px-to-rem(map.get($blockquote, 'margin-top')) 0 px-to-rem(map.get($blockquote, 'margin-bottom')) 0;
+      padding: px-to-rem(map.get($blockquote, 'padding-vertical')) 0 0 px-to-rem(map.get($blockquote, 'padding-left'));
+      font-size: px-to-rem(map.get($blockquote, 'font-size'));
+      color: map.get($theme, 'blockquote');
+      font-weight: 700;
+      font-style: italic;
+      line-height: px-to-rem(map.get($blockquote, 'line-height'));
+      border-left: px-to-rem(map.get($blockquote, 'border-width')) solid map.get($theme, 'blockquote_border');
+
+        p:last-of-type {
+          margin-bottom: 0;
+        }
+
+        @include breakpoint('min-width', 'md') {
+          margin-top: px-to-rem(map.get($blockquote, 'margin-top_md'));
+          margin-bottom: px-to-rem(map.get($blockquote, 'margin-bottom_md'));
+          font-size: px-to-rem(map.get($blockquote, 'font-size_md'));
+        }
+    }
+  }
+}

package/styles/base-styles/_hr.scss

@@ -0,0 +1,17 @@
+@use 'sass:map';
+@import './../functions',
+        './../variables';
+
+$hr: ('height': 1, 'margin-vertical': 40);
+
+@layer base {
+  #root {
+    hr {
+      width: 100%;
+      height: px-to-rem(map.get($hr, 'height'));
+      background: map.get($theme, 'divider');
+      margin: px-to-rem(map.get($hr, 'margin-vertical')) auto;
+      border: none;
+    }
+  }
+}

package/styles/base-styles/_index.scss

@@ -0,0 +1,8 @@
+@import 'accessibility',
+        'blockquotes',
+        'buttons',
+        'hr',
+        'links',
+        'lists',
+        'text',
+        'titles';

package/styles/base-styles/_links.scss

@@ -0,0 +1,18 @@
+@use 'sass:map';
+@import './../variables';
+
+@layer base {
+  #root {
+    a {
+        color: map.get($theme, 'link');
+        text-decoration: underline;
+        font-weight: 900;
+
+        &:hover,
+        &:focus,
+        &:active {
+          color: map.get($theme, 'link_hover');
+        }
+    }
+  }
+}

package/styles/base-styles/_lists.scss

@@ -0,0 +1,30 @@
+@use 'sass:map';
+@import './../functions',
+        './../mixins';
+
+$ul: ('margin-bottom': 16, 'padding-left': 40);
+$li: ('margin-bottom': 18, 'margin-bottom_sm': 12, 'margin-bottom_md': 16);
+
+@layer base {
+  #root {
+    ol, ul {
+      margin: 0 0 px-to-rem(map.get($ul, 'margin-bottom')) 0;
+      padding-left: px-to-rem(map.get($ul, 'padding-left'));
+      display: block;
+    }
+
+    li {
+      margin-bottom: px-to-rem(map.get($li, 'margin-bottom'));
+
+        @include selector-after-root('.text-small') { margin-bottom: px-to-rem(map.get($li, 'margin-bottom_sm')); }
+
+        @include selector-after-root('.text-medium') { margin-bottom: px-to-rem(map.get($li, 'margin-bottom_md')); }
+
+        &:last-child {
+          margin-bottom: 0;
+
+            p:last-child { margin-bottom: 0; }
+        }
+    }
+  }
+}

package/styles/base-styles/_text.scss

@@ -0,0 +1,83 @@
+@use 'sass:map';
+@import './../functions',
+        './../mixins',
+        './../variables';
+
+$default: ('font-size': 16, 'font-size_md': 18, 'line-height': 24, 'line-height_md': 28, 'margin-bottom': 20); // The default size is the 'large paragraph' in Figma
+$small: ('font-size': 12, 'font-size_md': 14, 'letter-spacing': 0.16, 'line-height': 16, 'margin-bottom': 16);
+$medium: ('font-size': 14, 'font-size_md': 16, 'line-height': 16, 'line-height_md': 20, 'margin-bottom': 18);
+$sup: ('font-size': 10);
+
+@layer base {
+  #root {
+    p, li, small {
+      color: map.get($theme, 'text');
+      font-weight: 500;
+    }
+
+    p, li {
+      font-size: px-to-rem(map.get($default, 'font-size'));
+      line-height: px-to-rem(map.get($default, 'line-height'));
+
+        @include selector-after-root('.text-small') {
+          font-size: px-to-rem(map.get($small, 'font-size'));
+          line-height: px-to-rem(map.get($small, 'line-height'));
+          letter-spacing: px-to-rem(map.get($small, 'letter-spacing'));
+        }
+
+        @include selector-after-root('.text-medium') {
+          font-size: px-to-rem(map.get($medium, 'font-size'));
+          line-height: px-to-rem(map.get($medium, 'line-height'));
+        }
+      
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($default, 'font-size_md'));
+          line-height: px-to-rem(map.get($default, 'line-height_md'));
+
+            @include selector-after-root('.text-small') {
+              font-size: px-to-rem(map.get($small, 'font-size_md'));
+            }
+
+            @include selector-after-root('.text-medium') {
+              font-size: px-to-rem(map.get($medium, 'font-size_md'));
+              line-height: px-to-rem(map.get($medium, 'line-height_md'));
+            }
+        }
+    }
+
+    p {
+      margin-bottom: px-to-rem(map.get($default, 'margin-bottom'));
+
+        @include selector-after-root('.text-small') { margin-bottom: px-to-rem(map.get($small, 'margin-bottom')); }
+
+        @include selector-after-root('.text-medium') { margin-bottom: px-to-rem(map.get($medium, 'margin-bottom')); }
+    }
+
+    small {
+      font-size: px-to-rem(map.get($small, 'font-size'));
+      line-height: px-to-rem(map.get($small, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($small, 'font-size_md'));
+        }
+    }
+
+    strong { font-weight: 900; }
+    em, i { font-style: italic; }
+
+    sup, sub {
+      font-size: px-to-rem(map.get($sup, 'font-size'));
+      line-height: normal;
+    }
+
+    sup {
+      vertical-align: super;
+    }
+
+    sub {
+      vertical-align: sub;
+    }
+
+  }
+
+}

package/styles/base-styles/_titles.scss

@@ -0,0 +1,132 @@
+@use 'sass:map';
+@import './../functions',
+        './../mixins',
+        './../variables';
+
+$pre-title: ('font-size': 14, 'font-size_md': 16, 'letter-spacing': 1.28, 'line-height': 16, 'line-height_md': 20, 'margin-bottom': 24);
+$title: ('font-size': 32, 'font-size_md': 52, 'letter-spacing': -0.16, 'line-height': 40, 'line-height_md': 64, 'margin-bottom': 16, 'margin-bottom_md': 32);
+$h1: ('font-size': 28, 'font-size_md': 40, 'line-height': 32, 'line-height_md': 48, 'letter-spacing': -0.16, 'margin-bottom': 16);
+$h2: ('font-size': 24, 'font-size_md': 28, 'line-height': 32, 'line-height_md': 40, 'margin-top': 40, 'margin-bottom': 16);
+$h3: ('font-size': 20, 'font-size_md': 24, 'line-height': 28, 'line-height_md': 32, 'margin-top': 60, 'margin-bottom': 20);
+$h4: ('font-size': 18, 'font-size_md': 20, 'line-height': 24, 'line-height_md': 28, 'margin-top': 40, 'margin-bottom': 20);
+$h5: ('font-size': 12, 'font-size_md': 14, 'line-height': 16, 'margin-top': 16, 'margin-bottom': 16);
+$h6: ('font-size': 12, 'font-size_md': 11, 'line-height': 16);
+$subtitle: ('font-size': 20, 'font-size_md': 24, 'line-height': 28, 'line-height_md': 32, 'margin-bottom': 20);
+
+@layer base {
+  #root {
+    .pre-title, h5, h6 {
+      color: map.get($theme, 'title');
+      text-transform: uppercase;
+      font-weight: 700;
+    }
+
+    .title, h1, h2, h3, h4 {
+      color: map.get($theme, 'title');
+      font-weight: 900;
+    }
+
+    .pre-title {
+      margin-bottom: px-to-rem(map.get($pre-title, 'margin-bottom'));
+      font-size: px-to-rem(map.get($pre-title, 'font-size'));
+      line-height: px-to-rem(map.get($pre-title, 'line-height'));
+      letter-spacing: px-to-rem(map.get($pre-title, 'letter-spacing'));
+      text-transform: uppercase;
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($pre-title, 'font-size_md'));
+          line-height: px-to-rem(map.get($title, 'line-height_md'));
+        }
+    }
+
+    .title {
+      margin-bottom: px-to-rem(map.get($title, 'margin-bottom'));
+      font-size: px-to-rem(map.get($title, 'font-size'));
+      line-height: px-to-rem(map.get($title, 'line-height'));
+      letter-spacing: px-to-rem(map.get($title, 'letter-spacing'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($title, 'font-size_md'));
+          line-height: px-to-rem(map.get($title, 'line-height_md'));
+        }
+    }
+
+    h1 {
+      margin-bottom: px-to-rem(map.get($h1, 'margin-bottom'));
+      font-size: px-to-rem(map.get($h1, 'font-size'));
+      line-height: px-to-rem(map.get($h1, 'line-height'));
+      letter-spacing: px-to-rem(map.get($h1, 'letter-spacing'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h1, 'font-size_md'));
+          line-height: px-to-rem(map.get($h1, 'line-height_md'));
+        }
+    }
+
+    h2 {
+      margin: px-to-rem(map.get($h2, 'margin-top')) 0 px-to-rem(map.get($h2, 'margin-bottom')) 0;
+      font-size: px-to-rem(map.get($h2, 'font-size'));
+      line-height: px-to-rem(map.get($h2, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h2, 'font-size_md'));
+          line-height: px-to-rem(map.get($h2, 'line-height_md'));
+        }
+    }
+
+    h3 {
+      margin: px-to-rem(map.get($h3, 'margin-top')) 0 px-to-rem(map.get($h3, 'margin-bottom')) 0;
+      font-size: px-to-rem(map.get($h3, 'font-size'));
+      line-height: px-to-rem(map.get($h3, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h3, 'font-size_md'));
+          line-height: px-to-rem(map.get($h3, 'line-height_md'));
+        }
+    }
+
+    h4 {
+      margin: px-to-rem(map.get($h4, 'margin-top')) 0 px-to-rem(map.get($h4, 'margin-bottom')) 0;
+      font-size: px-to-rem(map.get($h4, 'font-size'));
+      line-height: px-to-rem(map.get($h4, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h4, 'font-size_md'));
+          line-height: px-to-rem(map.get($h4, 'line-height_md'));
+        }
+    }
+
+
+    h5 {
+      margin: px-to-rem(map.get($h5, 'margin-top')) 0 px-to-rem(map.get($h5, 'margin-bottom')) 0;
+      font-size: px-to-rem(map.get($h5, 'font-size'));
+      line-height: px-to-rem(map.get($h5, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h5, 'font-size_md'));
+        }
+    }
+
+    h6 {
+      font-size: px-to-rem(map.get($h6, 'font-size'));
+      line-height: px-to-rem(map.get($h6, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($h6, 'font-size_md'));
+        }
+    }
+
+    .subtitle {
+      margin-bottom: px-to-rem(map.get($subtitle, 'margin-bottom'));
+      font-size: px-to-rem(map.get($subtitle, 'font-size'));
+      color: map.get($theme, 'subtitle');
+      font-weight: 400;
+      line-height: px-to-rem(map.get($subtitle, 'line-height'));
+
+        @include breakpoint('min-width', 'md') {
+          font-size: px-to-rem(map.get($subtitle, 'font-size_md'));
+          line-height: px-to-rem(map.get($subtitle, 'line-height_md'));
+        }
+    }
+  }
+}