@fusion.dev/helix-templates 0.138.0 → 0.139.0

package/templates/angular/src/main.ts

@@ -0,0 +1,21 @@
+import { isDevMode } from '@angular/core'
+import { bootstrapApplication } from '@angular/platform-browser'
+
+/* A custom element registers as a side effect of being imported, so this line
+   makes every Helix tag in the app real. Import the whole library while you are
+   finding your feet. `@fusion.dev/helix/button` and its siblings are subpath
+   exports, for when you want to pay for only what you use. The stylesheets are
+   in `angular.json`, since Angular takes global styles there. */
+import '@fusion.dev/helix'
+
+import { App } from './app/app'
+import { appConfig } from './app/app.config'
+
+/* **Diagnostics in development only.** `ng serve` runs in development, and
+   `ng build` in production, where `isDevMode()` is false and the chunk this
+   imports is never requested. */
+if (isDevMode()) {
+  void import('./diagnostics')
+}
+
+bootstrapApplication(App, appConfig).catch((error: unknown) => console.error(error))

package/templates/angular/tsconfig.app.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": []
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

package/templates/angular/tsconfig.json

@@ -0,0 +1,34 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "isolatedModules": true,
+    "lib": [
+      "DOM",
+      "DOM.Iterable",
+      "ES2023"
+    ],
+    "module": "preserve",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ES2022"
+  },
+  "angularCompilerOptions": {
+    "enableI18nLegacyMessageIdFormat": false,
+    "strictInjectionParameters": true,
+    "strictInputAccessModifiers": true,
+    "strictTemplates": true
+  },
+  "files": [],
+  "references": [
+    {
+      "path": "./tsconfig.app.json"
+    }
+  ]
+}

package/templates/react-nextjs/app/diagnostics.ts

@@ -0,0 +1,19 @@
+/**
+ * Helix diagnostics, which `instrumentation-client.ts` loads in development only.
+ *
+ * It finds the Helix mistakes that are valid CSS and therefore silent, such as
+ * a `::part()` naming a part nothing publishes, and an attribute value outside
+ * the set a component takes. Each finding prints once in DevTools, and a badge
+ * in the corner of the page lists them while there are any.
+ *
+ * **Checked against the Helix you installed**, from the lint data it ships, so
+ * nothing is loaded from the network.
+ *
+ * To print the findings in your terminal as well, run `npx helix diagnostics`
+ * from `@fusion.dev/helix-cli` beside the dev server, and add
+ * `sinks: { relay: true }` below.
+ */
+import { initDiagnostics } from '@fusion.dev/helix-diagnostics'
+import lint from '@fusion.dev/helix/lint.json'
+
+initDiagnostics({ environment: 'development', tiers: [{ lint }] })

package/templates/react-nextjs/app/landing.tsx

@@ -94,7 +94,7 @@ export function Landing() {
             </helix-text>
             <helix-text as="p" emphasis="muted" variant="body">
               They are custom elements, so you write the tags and there is no per-component import
-              to keep in step. One line in <helix-code>src/main.tsx</helix-code> registers all of
+              to keep in step. One line in <helix-code>app/helix-elements.tsx</helix-code> registers all of
               them, and a subpath like <helix-code>@fusion.dev/helix/tabs</helix-code> registers
               one.
             </helix-text>
@@ -122,7 +122,7 @@ export function Landing() {
               A short stylesheet
             </helix-text>
             <helix-text as="p" emphasis="muted" variant="body">
-              <helix-code>src/app.css</helix-code> holds this page's measure, the rhythm between its
+              <helix-code>app/app.css</helix-code> holds this page's measure, the rhythm between its
               blocks, and nothing a component already draws. Where a component leaves a decision
               open it names a part: the data view reaches one to paint the row you tick.
             </helix-text>

package/templates/react-nextjs/app/overview.tsx

@@ -26,7 +26,7 @@ export function Overview() {
         </helix-text>
         <helix-text as="p" className="lede" emphasis="muted" variant="body">
           Twelve people from a local module. Sort a column, turn a page, or tick a row and watch the
-          rule in <helix-code>src/app.css</helix-code> paint it.
+          rule in <helix-code>app/app.css</helix-code> paint it.
         </helix-text>
       </header>
 

package/templates/react-nextjs/instrumentation-client.ts

@@ -0,0 +1,6 @@
+/* **Diagnostics in development, and none of it in a build.** Next.js runs this
+   file in the browser before the app hydrates, and replaces
+   `process.env.NODE_ENV` when it builds, which drops the import with it. */
+if (process.env.NODE_ENV === 'development') {
+  void import('./app/diagnostics')
+}

package/templates/react-nextjs/package.json

@@ -16,6 +16,7 @@
     "react-dom": "^19.2.0"
   },
   "devDependencies": {
+    "@fusion.dev/helix-diagnostics": "^__HELIX_VERSION__",
     "@types/node": "^22.10.0",
     "@types/react": "^19.2.0",
     "@types/react-dom": "^19.2.0",

package/templates/react-nextjs/tsconfig.json

@@ -8,6 +8,7 @@
     ],
     "module": "ESNext",
     "moduleResolution": "bundler",
+    "resolveJsonModule": true,
     "skipLibCheck": true,
     "strict": true,
     "target": "ES2023",

package/templates/react-vite/package.json

@@ -15,6 +15,7 @@
     "react-dom": "^19.2.0"
   },
   "devDependencies": {
+    "@fusion.dev/helix-diagnostics": "^__HELIX_VERSION__",
     "@types/react": "^19.2.0",
     "@types/react-dom": "^19.2.0",
     "@vitejs/plugin-react": "^6.1.1",

package/templates/react-vite/src/diagnostics.ts

@@ -0,0 +1,24 @@
+/**
+ * Helix diagnostics, which `main.tsx` loads in development only.
+ *
+ * It finds the Helix mistakes that are valid CSS and therefore silent, such as
+ * a `::part()` naming a part nothing publishes, and an attribute value outside
+ * the set a component takes. Each finding prints once in DevTools, and a badge
+ * in the corner of the page lists them while there are any.
+ *
+ * **Checked against the Helix you installed**, from the lint data it ships, so
+ * nothing is loaded from the network.
+ *
+ * To print the findings in your terminal as well, run `npx helix diagnostics`
+ * from `@fusion.dev/helix-cli` beside the dev server, and add
+ * `sinks: { relay: true }` below.
+ */
+import { initDiagnostics } from '@fusion.dev/helix-diagnostics'
+import lint from '@fusion.dev/helix/lint.json'
+
+initDiagnostics({
+  environment: 'development',
+  /* The route is in the hash, so each page's findings are kept apart. */
+  page: () => window.location.hash.slice(1) || '/',
+  tiers: [{ lint }],
+})

package/templates/react-vite/src/main.tsx

@@ -15,6 +15,12 @@ import './app.css'
 
 import { App } from './App.js'
 
+/* **Diagnostics in development, and none of it in a build.** `vite build`
+   replaces `import.meta.env.DEV` with `false` and drops the import with it. */
+if (import.meta.env.DEV) {
+  void import('./diagnostics.js')
+}
+
 createRoot(document.querySelector('#root') as HTMLElement).render(
   <StrictMode>
     <App />

package/templates/react-vite/tsconfig.json

@@ -8,6 +8,7 @@
     ],
     "module": "ESNext",
     "moduleResolution": "bundler",
+    "resolveJsonModule": true,
     "noEmit": true,
     "skipLibCheck": true,
     "strict": true,

package/templates/solid-vite/helix-solid.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Types for the Helix custom elements written directly in Solid's JSX.
+ *
+ * Generated from the same manifest the API pages read, so a wrong attribute or
+ * a wrong event detail is a compile error. The Solid flavor of the typings adds
+ * `prop:`, `attr:`, and `on:` to every tag, beside the plain props.
+ */
+import type { CustomElementsSolidJs } from '@fusion.dev/helix/jsx'
+
+declare module 'solid-js' {
+  namespace JSX {
+    interface IntrinsicElements extends CustomElementsSolidJs {}
+  }
+}

package/templates/solid-vite/index.html

@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>__PROJECT_NAME__</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>

package/templates/solid-vite/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "__PROJECT_NAME__",
+  "version": "0.0.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "tsc && vite build",
+    "dev": "vite",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@fusion.dev/helix": "^__HELIX_VERSION__",
+    "@fusion.dev/helix-styles": "^__HELIX_VERSION__",
+    "solid-js": "^1.9.15"
+  },
+  "devDependencies": {
+    "@fusion.dev/helix-diagnostics": "^__HELIX_VERSION__",
+    "typescript": "^7.0.2",
+    "vite": "^8.3.0",
+    "vite-plugin-solid": "^2.11.14"
+  }
+}

package/templates/solid-vite/src/App.tsx

@@ -0,0 +1,35 @@
+import { Dynamic } from 'solid-js/web'
+import { Landing } from './landing.tsx'
+import { Overview } from './overview.tsx'
+import { pathname } from './routes.ts'
+import { SignupForm } from './signup-form.tsx'
+import { SiteFooter } from './site-footer.tsx'
+import { SiteHeader } from './site-header.tsx'
+
+/** The page for each path, in the order the bar offers them. */
+const PAGES = {
+  '/': Landing,
+  '/join': SignupForm,
+  '/overview': Overview,
+}
+
+/**
+ * The shell, and the switch between the three pages.
+ *
+ * Helix components are custom elements, so you write the tags directly. There
+ * is no wrapper package and nothing to import per component: `src/main.tsx`
+ * registers them once, and every tag in the app is real from then on.
+ */
+export function App() {
+  /* The bar, the route, and the footer, in a column the height of the window.
+     `app.css` says why the footer is worth having and why the column is flex. */
+  return (
+    <div class="shell">
+      <SiteHeader />
+      <main class="page">
+        <Dynamic component={PAGES[pathname() as keyof typeof PAGES] ?? Landing} />
+      </main>
+      <SiteFooter />
+    </div>
+  )
+}

package/templates/solid-vite/src/app.css

@@ -0,0 +1,363 @@
+/*
+ * The page around the components.
+ *
+ * Helix draws its own insides, so what is left to an app stylesheet is the
+ * measure, the rhythm between blocks, and the few things a component
+ * deliberately leaves open. Everything below is a Helix token or a documented
+ * hook, so a theme moves it and both color modes follow without a second copy
+ * of anything.
+ *
+ * **Color appears twice and both places are named.** The wordmark takes
+ * `--helix-color-brand-mark`, which is the token for the brand as a graphic
+ * rather than as a word, and a chosen row takes `--helix-color-primary-subtle`
+ * through the parts the table publishes. Everywhere else this page is ink on the
+ * background and the components carry their own.
+ */
+
+/*
+ * **The shell, and what stops a short route ending in a void.** The overview is
+ * a header, a table and a caption, which on a 1280 by 900 window left something
+ * like four hundred pixels of nothing under it: a page that stopped rather than
+ * a page that finished. A column the height of the window with the footer at the
+ * end of it puts a floor under every route.
+ *
+ * **Flex and not grid, because the bar is sticky.** A grid item's containing
+ * block is its own grid area, which is one row as tall as the bar, so a sticky
+ * header in a grid row sticks for nothing. A flex item's containing block is the
+ * flex container, which is the whole document.
+ */
+.shell {
+  display: flex;
+  flex-direction: column;
+  min-block-size: 100dvh;
+}
+
+/*
+ * **56rem, which is a measure rather than a maximum.** A page is as wide as its
+ * widest block can be read at, and the widest block here is a four-column table:
+ * given the whole of a 1280 window its first column came out 448 pixels across
+ * to hold a name, which reads as a table that has been stretched rather than
+ * laid out. The bar and the footer are centered in the same width, so the
+ * wordmark sits over the first column of the page rather than near it.
+ *
+ * `flex-grow` is what hands the slack to the page rather than to the footer.
+ */
+.page {
+  flex-grow: 1;
+  margin-inline: auto;
+  max-inline-size: 56rem;
+  padding-block: var(--helix-space-2xl) var(--helix-space-3xl);
+  padding-inline: var(--helix-space-lg);
+}
+
+/*
+ * Two documented hooks, and both are about agreeing with the page. The bar
+ * centers its row in the page's measure, so the wordmark sits over the first
+ * column rather than near it. And it draws no line under itself by default,
+ * because a header over a page that already has a surface does not need one:
+ * this page has no such surface, so it asks for one. A token rather than a
+ * color, so it follows the theme.
+ */
+helix-app-header {
+  --app-header-border-color: var(--helix-color-border);
+  --app-header-max-inline-size: 56rem;
+}
+
+/* The mark beside the project's name, which is the one graphic on the page and
+   the reason `--helix-color-brand-mark` exists: a mark answers to the 3:1 WCAG
+   asks of a graphic rather than to the 4.5 a word does, so it may sit closer to
+   the brand a theme was seeded with than any text color can. Swap the glyph, or
+   replace the whole element with your own logo. */
+.wordmark {
+  align-items: center;
+  display: inline-flex;
+  gap: var(--helix-space-xs);
+}
+
+.wordmark helix-icon {
+  color: var(--helix-color-brand-mark);
+}
+
+/*
+ * One rhythm between the blocks of a page, so no page states its own.
+ *
+ * **`minmax(0, 1fr)` and never a bare column, which is the trap in every grid
+ * here.** An implicit track is `auto`, and an `auto` track's minimum is its
+ * content's min-content size, so a child that would rather scroll itself widens
+ * the track instead and takes the page with it. Measured at 320: the table's
+ * columns floor at 344, the column it sits in should have been 288, and
+ * `documentElement.scrollWidth` came back 360 against a 320 viewport. The whole
+ * page scrolled sideways so that a table with its own scrollport would not have
+ * to. Zero as the minimum hands the overflow back to whoever is equipped for it.
+ */
+.stack,
+.section,
+.hero,
+.first-screen,
+.fact,
+.facts,
+.notes,
+.split {
+  grid-template-columns: minmax(0, 1fr);
+}
+
+/* One step between the blocks of a page and a smaller one inside them, which is
+   the whole of the rhythm: `3xl` here against the `md` a section puts between
+   its heading and its block, so a reader sees three groups rather than six
+   evenly spaced things. */
+.stack {
+  display: grid;
+  gap: var(--helix-space-3xl);
+}
+
+/*
+ * **The first screen is two things at once**, which is what makes it a screen
+ * rather than a stack: what this is, on the left, and the library doing it, on
+ * the right. Below 60rem there is no room for two columns that are both worth
+ * reading, so they become one and the panel reads as the thing the words were
+ * about.
+ *
+ * `start`, because a grid column stretches to its tallest sibling: the panel
+ * beside a taller block of words would otherwise grow to match it and spread its
+ * own regions out to fill the difference.
+ */
+.first-screen {
+  align-items: start;
+  display: grid;
+  gap: var(--helix-space-xl);
+}
+
+@media (width >= 60rem) {
+  .first-screen {
+    grid-template-columns: minmax(0, 1fr) minmax(0, 20rem);
+  }
+}
+
+/* A heading and the lines around it are one block, and the gap between them is
+   not the gap between blocks. Every route opens with one. */
+.hero {
+  display: grid;
+  gap: var(--helix-space-xs);
+  justify-items: start;
+}
+
+/* **A measure for the lede, which the page's own is too wide to be.** A line of
+   prose across 56rem is around 110 characters, and the readable range tops out
+   near 75. The heading above it is exempt: a heading is scanned rather than
+   read along. */
+.lede {
+  max-inline-size: 42rem;
+}
+
+.actions {
+  display: flex;
+  flex-wrap: wrap;
+  gap: var(--helix-space-sm);
+  padding-block-start: var(--helix-space-md);
+}
+
+/*
+ * **The panel is the library rather than a picture of it**, so the only thing it
+ * needs from here is room. Two documented hooks: the figures come down a step
+ * from the display size, which is set for a figure on its own and is too loud
+ * for three of them in a 20rem column, and the rule between them comes in from
+ * `2xl`, which `divided` doubles and which would leave no column to put a
+ * number in.
+ */
+.specimen {
+  --stat-group-gap: var(--helix-space-md);
+  --stat-value-size: var(--helix-text-xl);
+}
+
+/* A section is its heading and its one block, closer together than two sections
+   are. */
+.section {
+  display: grid;
+  gap: var(--helix-space-md);
+}
+
+/*
+ * **Three facts about the library, and deliberately not three cards.** A row of
+ * identical outlined boxes is the shape a generated page takes, and it is also a
+ * claim: a box says each of these is its own object, when they are three
+ * paragraphs about the same installed thing. A rule over each column groups them
+ * at a fraction of the weight, and leaves the cards below to mean something,
+ * which is that they go somewhere.
+ *
+ * `border-thick` in the foreground rather than a hairline in the border color:
+ * this is a heading device rather than a container edge, and it is the one place
+ * the page draws in ink.
+ */
+.facts {
+  display: grid;
+  gap: var(--helix-space-lg);
+}
+
+@media (width >= 48rem) {
+  .facts {
+    grid-template-columns: repeat(3, minmax(0, 1fr));
+  }
+}
+
+.fact {
+  align-content: start;
+  border-block-start: var(--helix-border-thick) solid var(--helix-color-foreground);
+  display: grid;
+  gap: var(--helix-space-xs);
+  justify-items: start;
+  padding-block-start: var(--helix-space-sm);
+}
+
+/*
+ * **The one departure the grids state.** `helix-grid` takes a fixed count as
+ * plain CSS, which is what keeps a server-rendered row of cards correct before
+ * any JavaScript arrives. Below this width there is only ever room for one
+ * column, and `--grid-columns` is the documented way to say so from outside the
+ * shadow root.
+ */
+@media (width < 48rem) {
+  helix-grid {
+    --grid-columns: minmax(0, 1fr);
+  }
+}
+
+/*
+ * **The cards keep `start`, which is `--card-align`'s resting value, and the
+ * alternative is worth naming because it looks right and is not.**
+ * `space-between` puts the last line of each card on its bottom edge, so a row
+ * of cards ends in a straight line. It gets there by sharing the slack out
+ * between every region, and the first thing that moves is the body: three cards
+ * of six, five and seven lines had their opening lines 50 pixels apart under
+ * headings that were level. A reader scans the first line of each, so that is
+ * the alignment worth keeping.
+ */
+
+/* The card fills the link that wraps it, so a row of destinations ends level:
+   the anchor is the grid item and stretches, and the card inside it does not.
+   The regions stay packed at the top, per `--card-align` above. */
+[data-card] > helix-card {
+  block-size: 100%;
+}
+
+/* A form is read straight down, and a field wider than about this stops being
+   scannable however much room the window has. */
+.form {
+  align-content: start;
+  display: grid;
+  gap: var(--helix-space-lg);
+  justify-items: start;
+  max-inline-size: 28rem;
+}
+
+/* Every control fills the column; the submit is as wide as its own words. */
+.form > :not(helix-button) {
+  inline-size: 100%;
+}
+
+/*
+ * **The form takes a column and the notes take the rest.** A 28rem form on a
+ * 1280 window is a third of a page and two thirds of nothing, which is what the
+ * measure above cannot fix on its own: the form has a right width and the page
+ * does not shrink to it. Narrow, the two stack and the notes read as a
+ * postscript, which is the order they are written in.
+ */
+.split {
+  display: grid;
+  gap: var(--helix-space-2xl);
+}
+
+@media (width >= 60rem) {
+  .split {
+    grid-template-columns: minmax(0, 28rem) minmax(0, 1fr);
+  }
+}
+
+/* `start`, because a grid column stretches to its tallest sibling and a
+   stretched grid shares the difference out between its own rows: beside a form
+   half a page long, three paragraphs came out 140 pixels apart. */
+.notes {
+  align-content: start;
+  display: grid;
+  gap: var(--helix-space-sm);
+  justify-items: start;
+  max-inline-size: 32rem;
+}
+
+/* The callout takes the column, which `start` above would otherwise size to its
+   own words: a notice narrower than the paragraph under it reads as a stray. The
+   link beside it is meant to be its own width. */
+.notes > helix-callout {
+  inline-size: 100%;
+}
+
+/*
+ * **The counterpart to the bar, and the reason every route now ends rather than
+ * stops.** The rule runs the window while its contents keep the page's measure,
+ * which is what a footer under a centered page looks like; the shell above is
+ * what holds it to the bottom of a window a route does not fill.
+ */
+.site-footer {
+  border-block-start: var(--helix-border-thin) solid var(--helix-color-border);
+}
+
+.footer-row {
+  display: flex;
+  flex-wrap: wrap;
+  gap: var(--helix-space-md);
+  justify-content: space-between;
+  margin-inline: auto;
+  max-inline-size: 56rem;
+  padding-block: var(--helix-space-lg);
+  padding-inline: var(--helix-space-lg);
+}
+
+.footer-links {
+  display: flex;
+  flex-wrap: wrap;
+  gap: var(--helix-space-md);
+}
+
+/*
+ * **Narrow, the gutter gives before the content does.** 24 pixels either side of
+ * a 390 window is 48 of 390 spent on margin, and the table needs 355 of what is
+ * left. At `md` it has 358 and fits; at `lg` it was 13 pixels short and the last
+ * column sat outside the box until the reader scrolled the table sideways.
+ */
+@media (width < 40rem) {
+  .page {
+    padding-block: var(--helix-space-xl) var(--helix-space-2xl);
+    padding-inline: var(--helix-space-md);
+  }
+
+  .footer-row {
+    padding-inline: var(--helix-space-md);
+  }
+}
+
+/*
+ * **The escape hatch, and the reason a component names its parts.** The table
+ * washes a chosen row at the strength `Tag` rests at; this page wants a row
+ * somebody has ticked to be findable from across the screen, and there is no
+ * token for "more than that". `::part` reaches the boxes the component drew
+ * without forking it, and a rule written out here beats the component's own
+ * however specific that one is.
+ *
+ * **Two parts and not one, because a row has no box.** The row is
+ * `display: contents` so that one grid can align every column across every row,
+ * which leaves the cells as the only thing a selection can be painted on. The
+ * table names both: the data cells and the cell holding the checkbox. Naming
+ * only the first leaves a pale stripe down the left of every chosen row.
+ *
+ * The values are still the library's, so a theme carries them like everything
+ * else. `primary-subtle` and not `primary-surface`: the second is the solid
+ * accent a button stands on and expects white on top of it, so a row painted
+ * with it puts the table's own ink on a saturated fill.
+ */
+helix-data-table::part(cell-selected),
+helix-data-table::part(select-selected) {
+  background-color: var(--helix-color-primary-subtle);
+}
+
+helix-data-table::part(cell-selected) {
+  font-weight: var(--helix-weight-semibold);
+}