grailwind 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to this project are documented here. The format is based
+on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2026-11-01
+
+### Added
+
+- Charges `on` an ordinary: `charges on` places one, two, three or five charges
+  along the pale, fess, bend, bend sinister, chevron, cross, saltire or pall.
+- Fimbriation: `fimbriated-<tincture>` edges an ordinary with a narrow border,
+  e.g. `cross-azure fimbriated-argent`.
+
+### Fixed
+
+- Charges at `in-dexter-chief`, `in-chief` and `in-sinister-chief` now sit on
+  the chief when one is present, and charges are drawn above it.
+
+## [0.1.0] - 2026-10-31
+
+Initial release: tinctures, divisions, ordinaries, charges, strict mode and
+custom SVG charges.
+
+[0.2.0]: https://github.com/pafirmin/grailwind/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/pafirmin/grailwind/releases/tag/v0.1.0

package/README.md

@@ -1,5 +1,7 @@
 # Grailwind CSS
 
+![Eight coats of arms drawn with Grailwind: chevrons, quarters, fleurs-de-lis, a saltire, gyronny, a chief, a bend and a bordure](https://pafirmin.github.io/grailwind/preview.png)
+
 Heraldic blazon for [Tailwind CSS](https://tailwindcss.com). Draw coats of
 arms, or style anything else, in the language heralds have used for 800 years:
 
@@ -51,9 +53,9 @@ tinctures replace Tailwind's colours entirely.
   `gyronny-or-sable` and more, or `per-pale`, `per-fess` and `quarterly` for
   layout.
 - **Ordinaries:** `fess-or`, `chevron-gules`, `cross-argent`, `chief-azure`
-  and more.
+  and more, with `fimbriated-*` for a narrow border.
 - **Charges:** `mullet`, `fleur-de-lis`, `bezant` and more, arranged by
-  number, `in-pale`, `in-fess`, `in-bend` or `between` the ordinary, or
+  number, `in-pale`, `in-fess`, `in-bend`, `on` or `between` the ordinary, or
   placed at a named point such as `in-dexter-chief`, and sized with
   `charge-size-*`.
 - **Your own charges:** any SVG, via `charge-[url(…)]`.
@@ -62,9 +64,8 @@ tinctures replace Tailwind's colours entirely.
 
 ```sh
 npm install
-npm test        # checks both the default and strict builds
-npm run build   # builds the docs site; `npm run dev` rebuilds on change
-python3 -m http.server -d docs
+npm test            # checks both the default and strict builds
+npm run dev:watch   # rebuilds the docs site on change and serves it at http://localhost:8000
 ```
 
 ## Licence

package/charges.js

@@ -63,6 +63,9 @@ const POINTS = {
 };
 const POINT_SIZE = 22;
 
+// With a chief on the shield, these points sit on it (see ordinaries.js).
+const CHIEF_POINTS = new Set(["dexter-chief", "chief", "sinister-chief"]);
+
 const ARRANGEMENTS = {
   "in-pale": {
     2: { size: 30, points: [[50, 24], [50, 66]] },
@@ -119,6 +122,8 @@ export default plugin(({ addUtilities, matchUtilities }) => {
   const charges = {
     position: "absolute",
     inset: "var(--field-top, 0%) 0 0",
+    // Above the chief, which is painted last, so charges can sit on it.
+    "z-index": "1",
     "& > *": {
       position: "absolute",
       "aspect-ratio": "1",
@@ -155,8 +160,34 @@ export default plugin(({ addUtilities, matchUtilities }) => {
   }
   utilities[".between"] = between;
 
-  for (const [name, point] of Object.entries(POINTS)) {
-    utilities[`.in-${name}`] = { ".charges > &": place(point, POINT_SIZE) };
+  // Falls back to the plain-field default when the ordinary has no points for this count.
+  // An undefined var() would otherwise unset `left`/`top` instead of  deferring to the :where() default.
+  const on = {};
+  for (const count of [1, 2, 3, 5]) {
+    const fallback = DEFAULTS[count];
+    for (let i = 1; i <= count; i++) {
+      const [left, top] = fallback?.points[i - 1] ?? [];
+      const at = (axis, value) =>
+        value === undefined ? `var(--on-${count}-${i}-${axis})` : `var(--on-${count}-${i}-${axis}, ${value}%)`;
+      on[`&${hasCount(count)} > :nth-child(${i})`] = {
+        left: at("x", left),
+        top: at("y", top),
+        width: `var(--charge-size, var(--on-size, ${fallback?.size ?? 16}%))`,
+      };
+    }
+  }
+  utilities[".on"] = on;
+
+  for (const [name, [left, top]] of Object.entries(POINTS)) {
+    utilities[`.in-${name}`] = {
+      ".charges > &": CHIEF_POINTS.has(name)
+        ? {
+            left: `${left}%`,
+            top: `var(--chief-points-y, ${top}%)`,
+            width: `var(--charge-size, var(--chief-points-size, ${POINT_SIZE}%))`,
+          }
+        : place([left, top], POINT_SIZE),
+    };
   }
 
   addUtilities(utilities);

package/grailwind.css

@@ -13,6 +13,15 @@
 @plugin "./ordinaries.js";
 @plugin "./charges.js";
 
+@property --fimbriated {
+  syntax: "*";
+  inherits: false;
+}
+@property --fimbriation {
+  syntax: "*";
+  inherits: false;
+}
+
 /* ---------------------------------------------------------------------------
  * Tinctures
  * ------------------------------------------------------------------------- */

package/ordinaries.js

@@ -6,22 +6,164 @@ import plugin from "tailwindcss/plugin";
 const TINCTURES = ["or", "argent", "gules", "azure", "vert", "purpure", "sable"];
 
 const ORDINARIES = {
-  pale: "polygon(35% 0, 65% 0, 65% 100%, 35% 100%)",
-  fess: "polygon(0 30%, 100% 30%, 100% 60%, 0 60%)",
-  bend: "polygon(0 0, 20% 0, 100% 80%, 100% 100%, 80% 100%, 0 20%)",
-  "bend-sinister":
-    "polygon(100% 0, 80% 0, 0 80%, 0 100%, 20% 100%, 100% 20%)",
-  chevron: "polygon(50% 25%, 100% 75%, 100% 95%, 50% 45%, 0 95%, 0 75%)",
-  cross:
-    "polygon(40% 0, 60% 0, 60% 35%, 100% 35%, 100% 55%, 60% 55%, 60% 100%, 40% 100%, 40% 55%, 0 55%, 0 35%, 40% 35%)",
-  saltire:
-    "polygon(0 0, 15% 0, 50% 35%, 85% 0, 100% 0, 100% 15%, 65% 50%, 100% 85%, 100% 100%, 85% 100%, 50% 65%, 15% 100%, 0 100%, 0 85%, 35% 50%, 0 15%)",
-  pall: "polygon(0 0, 15% 0, 50% 35%, 85% 0, 100% 0, 100% 15%, 60% 50%, 60% 100%, 40% 100%, 40% 50%, 0 15%)",
-  chief: "polygon(0 0, 100% 0, 100% 30%, 0 30%)",
+  pale: [[35, 0], [65, 0], [65, 100], [35, 100]],
+  fess: [[0, 30], [100, 30], [100, 60], [0, 60]],
+  bend: [[0, 0], [20, 0], [100, 80], [100, 100], [80, 100], [0, 20]],
+  "bend-sinister": [[100, 0], [80, 0], [0, 80], [0, 100], [20, 100], [100, 20]],
+  chevron: [[50, 25], [100, 75], [100, 95], [50, 45], [0, 95], [0, 75]],
+  cross: [
+    [40, 0], [60, 0], [60, 35], [100, 35], [100, 55], [60, 55],
+    [60, 100], [40, 100], [40, 55], [0, 55], [0, 35], [40, 35],
+  ],
+  saltire: [
+    [0, 0], [15, 0], [50, 35], [85, 0], [100, 0], [100, 15], [65, 50], [100, 85],
+    [100, 100], [85, 100], [50, 65], [15, 100], [0, 100], [0, 85], [35, 50], [0, 15],
+  ],
+  pall: [
+    [0, 0], [15, 0], [50, 35], [85, 0], [100, 0], [100, 15],
+    [60, 55], [60, 100], [40, 100], [40, 55], [0, 15],
+  ],
+  chief: [[0, 0], [100, 0], [100, 30], [0, 30]],
 };
 
+const num = (v) => +v.toFixed(3);
+const pct = (v) => (num(v) === 0 ? "0" : `${num(v)}%`);
+const point = ([x, y]) => `${pct(x)} ${pct(y)}`;
+const polygon = (vertices) => `polygon(${vertices.map(point).join(", ")})`;
+
 const PSEUDO = { chief: "&::after" };
 
+// Fimbriation: the ordinary's clip is widened and filled with the fimbriation
+// tincture, and the ordinary's own tincture is painted over it as gradient
+// bands.
+const W = 100;
+const H = 120;
+const FIMBRIATION = 3;
+
+const real = ([x, y]) => [(x * W) / 100, (y * H) / 100];
+const onShieldEdge = (a, b) =>
+  (a[0] === b[0] && (a[0] === 0 || a[0] === 100)) ||
+  (a[1] === b[1] && (a[1] === 0 || a[1] === 100));
+const signedArea = (vertices) =>
+  vertices.reduce((sum, [x1, y1], i) => {
+    const [x2, y2] = vertices[(i + 1) % vertices.length];
+    return sum + x1 * y2 - x2 * y1;
+  }, 0) / 2;
+
+// The edge a→b as a line n·p = c, moved outward by `distance` real units.
+const offsetLine = (a, b, outward, distance) => {
+  const [ax, ay] = real(a);
+  const [bx, by] = real(b);
+  const length = Math.hypot(bx - ax, by - ay);
+  const n = [(outward * (by - ay)) / length, (outward * (ax - bx)) / length];
+  return { n, c: n[0] * ax + n[1] * ay + distance };
+};
+
+// How far each vertex moves, in %, when fimbriated. Sides on the shield's edge
+// don't move, so their vertices slide along it.
+const widen = (vertices) => {
+  const outward = Math.sign(signedArea(vertices));
+  const count = vertices.length;
+  const line = (i) => {
+    const a = vertices[i];
+    const b = vertices[(i + 1) % count];
+    return offsetLine(a, b, outward, onShieldEdge(a, b) ? 0 : FIMBRIATION);
+  };
+  return vertices.map((v, i) => {
+    const p = line((i - 1 + count) % count);
+    const q = line(i);
+    const det = p.n[0] * q.n[1] - p.n[1] * q.n[0];
+    const [x, y] = [(p.c * q.n[1] - q.c * p.n[1]) / det, (p.n[0] * q.c - q.n[0] * p.c) / det];
+    const [rx, ry] = real(v);
+    return [((x - rx) * 100) / W, ((y - ry) * 100) / H];
+  });
+};
+
+const shift = (v, d) =>
+  num(d) === 0
+    ? pct(v)
+    : `calc(${num(v)}% ${d < 0 ? "-" : "+"} ${num(Math.abs(d))}% * var(--fimbriated, 0))`;
+const widenedPolygon = (vertices) => {
+  const offsets = widen(vertices);
+  const points = vertices.map(
+    ([x, y], i) => `${shift(x, offsets[i][0])} ${shift(y, offsets[i][1])}`,
+  );
+  return `polygon(${points.join(", ")})`;
+};
+
+// The ordinary's tincture, top layer first. `x`/`y` bands run between two x or y
+// values in %; `u-v`/`u+v` are diagonal, between values of x − y or x + y.
+// A `tile` [x0, y0, x1, y1] confines a layer to part of the box (square, if
+// diagonal). Stripes repaint the fimbriation where one arm's band runs on into
+// another's.
+const S = 12;
+const band = (kind, from, to, tile) => ({ kind, from, to, tile });
+const stripe = (kind, from, to, tile) => ({ kind, from, to, tile, stripe: true });
+const BANDS = {
+  pale: [band("x", 35, 65)],
+  fess: [band("y", 30, 60)],
+  bend: [band("u-v", -20, 20)],
+  "bend-sinister": [band("u+v", 80, 120)],
+  chevron: [
+    stripe("u+v", 75 - S, 75),
+    stripe("u-v", 25, 25 + S),
+    band("u+v", 75, 95),
+    band("u-v", 5, 25),
+  ],
+  cross: [band("x", 40, 60), band("y", 35, 55)],
+  saltire: [band("u-v", -15, 15), band("u+v", 85, 115)],
+  pall: [
+    stripe("x", 60, 60 + S, [0, 55, 100, 100]),
+    stripe("x", 40 - S, 40, [0, 55, 100, 100]),
+    stripe("u+v", 115, 115 + S, [60, 30, 100, 70]),
+    stripe("u-v", -15 - S, -15, [0, 30, 40, 70]),
+    band("u-v", -15, 15),
+    band("u+v", 85, 115),
+    band("x", 40, 60, [0, 55, 100, 100]),
+  ],
+};
+
+const DIRECTION = { x: "to right", y: "to bottom", "u-v": "to top right", "u+v": "to bottom right" };
+
+// A band's edges as % along its gradient, within its tile.
+const stop = ({ kind, tile: [x0, y0, x1, y1] = [0, 0, 100, 100] }, value) => {
+  const w = x1 - x0;
+  const h = y1 - y0;
+  if (kind.length > 1 && w !== h) throw new Error("diagonal bands need a square tile");
+  switch (kind) {
+    case "x": return ((value - x0) * 100) / w;
+    case "y": return ((value - y0) * 100) / h;
+    case "u-v": return ((value - (x0 - y0)) * 100) / w / 2 + 50;
+    case "u+v": return ((value - x0 - y0) * 100) / w / 2;
+  }
+};
+
+// Soften each edge by a pixel, as hard gradient stops aren't antialiased.
+const gradient = (layer, colour) => {
+  const a = num(stop(layer, layer.from));
+  const b = num(stop(layer, layer.to));
+  return (
+    `linear-gradient(${DIRECTION[layer.kind]}, transparent calc(${a}% - 0.5px), ` +
+    `${colour} calc(${a}% + 0.5px) calc(${b}% - 0.5px), transparent calc(${b}% + 0.5px))`
+  );
+};
+
+const tilePosition = (start, size) => (size === 100 ? "0" : pct((start * 100) / (100 - size)));
+
+const bands = (layers, tincture) => ({
+  "background-image": layers
+    .map((l) => gradient(l, l.stripe ? "var(--fimbriation, transparent)" : `var(--color-${tincture})`))
+    .join(", "),
+  "background-size": layers
+    .map(({ tile: [x0, y0, x1, y1] = [0, 0, 100, 100] }) => `${pct(x1 - x0)} ${pct(y1 - y0)}`)
+    .join(", "),
+  "background-position": layers
+    .map(({ tile: [x0, y0, x1, y1] = [0, 0, 100, 100] }) =>
+      `${tilePosition(x0, x1 - x0)} ${tilePosition(y0, y1 - y0)}`)
+    .join(", "),
+  "background-repeat": "no-repeat",
+});
+
 // Where charges go for "between", as [left%, top%], plus their size as % of width.
 const BETWEEN = {
   pale: { size: 18, points: [[18, 42], [82, 42]] },
@@ -34,6 +176,18 @@ const BETWEEN = {
   pall: { size: 18, points: [[50, 11], [18, 56], [82, 56]] },
 };
 
+// Where charges go for "on", along the ordinary's centre line, by number of charges.
+const ON = {
+  pale: { size: 20, counts: { 1: [[50, 45]], 2: [[50, 28], [50, 62]], 3: [[50, 18], [50, 45], [50, 72]] } },
+  fess: { size: 22, counts: { 1: [[50, 45]], 2: [[30, 45], [70, 45]], 3: [[20, 45], [50, 45], [80, 45]] } },
+  bend: { size: 18, counts: { 1: [[50, 50]], 2: [[33, 33], [67, 67]], 3: [[24, 24], [50, 50], [76, 76]] } },
+  "bend-sinister": { size: 18, counts: { 1: [[50, 50]], 2: [[67, 33], [33, 67]], 3: [[76, 24], [50, 50], [24, 76]] } },
+  chevron: { size: 12, counts: { 1: [[50, 36]], 3: [[20, 65], [50, 36], [80, 65]] } },
+  cross: { size: 15, counts: { 1: [[50, 45]], 5: [[50, 15], [18, 45], [50, 45], [82, 45], [50, 80]] } },
+  saltire: { size: 14, counts: { 1: [[50, 50]], 5: [[22, 22], [78, 22], [50, 50], [22, 78], [78, 78]] } },
+  pall: { size: 14, counts: { 1: [[50, 50]], 3: [[22, 22], [78, 22], [50, 75]] } },
+};
+
 const betweenVars = ({ size, points }) => {
   const vars = { "--between-size": `${size}%` };
   points.forEach(([left, top], i) => {
@@ -43,22 +197,56 @@ const betweenVars = ({ size, points }) => {
   return vars;
 };
 
+const onVars = ({ size, counts }) => {
+  const vars = { "--on-size": `${size}%` };
+  for (const [count, points] of Object.entries(counts)) {
+    points.forEach(([left, top], i) => {
+      vars[`--on-${count}-${i + 1}-x`] = `${left}%`;
+      vars[`--on-${count}-${i + 1}-y`] = `${top}%`;
+    });
+  }
+  return vars;
+};
+
 export default plugin(({ addUtilities }) => {
   const utilities = {};
 
-  for (const [ordinary, shape] of Object.entries(ORDINARIES)) {
+  for (const tincture of TINCTURES) {
+    utilities[`.fimbriated-${tincture}`] = {
+      "--fimbriated": "1",
+      "--fimbriation": `var(--color-${tincture})`,
+    };
+  }
+
+  for (const [ordinary, vertices] of Object.entries(ORDINARIES)) {
     for (const tincture of TINCTURES) {
       utilities[`.${ordinary}-${tincture}`] = {
         position: "relative",
         ...(BETWEEN[ordinary] && betweenVars(BETWEEN[ordinary])),
+        ...(ON[ordinary] && onVars(ON[ordinary])),
         // With a chief, everything else is drawn in the field below it.
-        ...(ordinary === "chief" && { "--field-top": "30%" }),
+        ...(ordinary === "chief" && {
+          "--field-top": "30%",
+          // The chief's centre line, relative to the charges container below it.
+          "--chief-points-y": "calc(-15% / 0.7)",
+          "--chief-points-size": "18%",
+        }),
         [PSEUDO[ordinary] ?? "&::before"]: {
           content: '""',
           position: "absolute",
           inset: ordinary === "chief" ? "0" : "var(--field-top, 0%) 0 0",
-          "background-color": `var(--color-${tincture})`,
-          "clip-path": shape,
+          ...(BANDS[ordinary]
+            ? {
+                "--fimbriated": "inherit",
+                "--fimbriation": "inherit",
+                "background-color": `var(--fimbriation, var(--color-${tincture}))`,
+                ...bands(BANDS[ordinary], tincture),
+                "clip-path": widenedPolygon(vertices),
+              }
+            : {
+                "background-color": `var(--color-${tincture})`,
+                "clip-path": polygon(vertices),
+              }),
         },
       };
     }

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "grailwind",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "scripts": {
     "build": "tailwindcss -i docs/app.css -o docs/site.css",
     "dev": "tailwindcss -i docs/app.css -o docs/site.css --watch",
-    "test": "node test/modes.mjs"
+    "test": "node test/modes.mjs",
+    "dev:watch": "tailwindcss -i docs/app.css -o docs/site.css --watch=always & python3 -m http.server ${PORT:-8000} -d docs"
   },
   "keywords": [
     "tailwindcss",
@@ -38,7 +39,8 @@
     "ordinaries.js",
     "charges.js",
     "strict.css",
-    "palette-reset.css"
+    "palette-reset.css",
+    "CHANGELOG.md"
   ],
   "peerDependencies": {
     "tailwindcss": "^4.0.0"