Files
whynot-design/CHANGELOG.md
tegwick 80252baf53
Some checks failed
ci / check (push) Has been cancelled
ci / release (push) Has been cancelled
version 0.2.0 replaces fromer version!
2026-05-25 19:32:22 +02:00

4.8 KiB

Changelog

All notable changes to @whynot/design are recorded here. Hand-edited until release cadence makes it painful.

Format follows Keep a Changelog. Versioning rules: see DesignSystemIntroduction.md §6.

[Unreleased]

Nothing yet. Add entries above the next [vX.Y.Z] block as PRs land.

[0.2.0] — 2026-05-25

Architectural reframe. The system is now delivered as three stacked layers — tokens + CSS, Lit web components, optional framework adapters. The previous React-only component layer has been removed.

Added

  • MultiFrameworkSupport.md — full integration guide for React, Django, HTMX, Vue, Svelte, plain HTML.
  • src/elements/ — Lit-based web components, light-DOM rendered:
    • Atoms (atoms.js): <wn-button>, <wn-tag>, <wn-eyebrow>, <wn-stamp>, <wn-stage-dot>, <wn-phase-dot>, <wn-icon>.
    • Form (form.js): <wn-input>, <wn-textarea>, <wn-select>, <wn-search-input>, <wn-field-row>.
    • Layout (layout.js): <wn-card>, <wn-modal>, <wn-table> + <wn-table-row> + <wn-table-cell>, <wn-banner>, <wn-toast> + <wn-toast-region>, <wn-empty-state>, <wn-breadcrumb>.
    • Chrome (chrome.js): <wn-top-nav>, <wn-sidebar> + <wn-sidebar-group> + <wn-sidebar-item>, <wn-page-header>, <wn-pipeline>, <wn-prototype-card>.
  • src/elements/icons.js — Lucide-derived inline icon paths (no runtime CDN dependency).
  • src/styles/components.css — utility-class layer (wn-btn, wn-card, wn-tag, etc.). Consumable directly from any HTML for the "Layer 1 only" use case.
  • adapters/django/templates/whynot/*.html{% include %}-ready partials for Django consumers (button, eyebrow, tag, stage-dot, page-header, pipeline, field-row, prototype-card, banner, empty-state).
  • adapters/django/README.md — how to wire the partials into a Django app.
  • examples/showcase/index.html — single-page reference rendering every component. Doubles as the Playwright visual-regression baseline.
  • lit ^3.2.1 as a runtime dependency.

Changed

  • DesignSystemIntroduction.md — updated to describe the three-layer architecture, multi-framework consumption, and the revised propagation pipeline.
  • README.md — top-level rewrite around the new architecture, with quick-start blocks per framework.
  • package.json — adds per-group exports (@whynot/design/atoms, /form, /layout, /chrome, /icons).
  • CI now runs visual regression against examples/showcase/index.html and examples/whynot-control/index.html.

Removed

  • src/components/Atoms.jsx, src/components/Chrome.jsx — the React-only component layer. Consumers using these from v0.1.0 should swap to the corresponding custom elements (drop-in replacements; see MultiFrameworkSupport.md § React).
  • peerDependencies on React. React is no longer required to consume @whynot/design.

Migration

If you were on v0.1.0 with React imports like import { Button } from "@whynot/design":

Before (v0.1.0) After (v0.2.0)
import { Button } from "@whynot/design"; <Button variant="primary">…</Button> import "@whynot/design"; <wn-button variant="primary">…</wn-button>
import { Tag } from "@whynot/design"; <Tag active>…</Tag> <wn-tag active>…</wn-tag>
<StageDot level="S2" /> <wn-stage-dot level="S2"></wn-stage-dot>

CSS imports are unchanged; add the new components.css import alongside colors_and_type.css.

Known caveats

  • IBM Plex is loaded from Google Fonts. Drop .woff2 files into fonts/ and swap to a local @font-face for offline use.
  • The showcase uses importmap + esm.sh to load Lit (no bundler). Real consumers using pnpm add will pick up Lit from node_modules via the package's dependencies entry.
  • No TypeScript declarations for JSX yet — deferred until a TS consumer asks.
  • <wn-select> uses a native <select> internally; richer custom selects (ElementInternals-based) will appear when a real need shows up.

[0.1.0] — 2026-05-23

Initial seed. Established whynot-design as the implementation surface for the whynot visual language. (Pre-architectural reframe — see v0.2.0.)

Added

  • src/styles/colors_and_type.css — full token set + semantic element styles.
  • tokens/ — source-of-truth JSON tokens for colours, type, spacing, radii, shadows.
  • src/components/Atoms.jsx — React: Eyebrow, Tag, Button, StageDot, Stamp, Icon.
  • src/components/Chrome.jsx — React: TopNav, Sidebar, PageHeader, PipelineStrip.
  • examples/whynot-control/ — click-through UI kit recreating the whynot-control surface.
  • assets/whynot-logo.png — LEGO-brick + ?! mark.
  • SKILL.md, README.md, DesignSystemIntroduction.md, CONTRIBUTING.md, BOOTSTRAP.md.