@use "/shell" as *; @use "quark:list" as list; #release-notice { /* opens once: sheet re-runs restart a delay, so gate it on the fact it writes */ &:not([data-did-open]) { @delay 7000 { is-open: ""; data-did-open: ""; } } /* prevent clicks from bubbling to the sheet */ @on mouseup, click (stop-propagation); } provider-fetch[api-url*="package-metas/index.json"][is-success] { $package-indices: prop("provision").body; /* `excom.navGroup` moves a package out of its type's list, into that group */ $ungrouped: list.reject($package-indices.packages, "navGroup"); .package-links { [bind-elements] ul:not(ul ul) { content: iterate(getPackagesByType($ungrouped, "kit-element")); } [bind-element-bases] ul:not(ul ul) { content: iterate(getPackagesByType($ungrouped, "element-base")); } [bind-tools] ul:not(ul ul) { content: iterate(getPackagesByType($ungrouped, "tool")); } /* the standalone libraries: same rows, rendered flat (shell.css) */ [bind-libraries] ul:not(ul ul) { content: iterate(getPackagesByType($ungrouped, "library")); } [bind-library-group] ul:not(ul ul) { content: iterate(list.filter($package-indices.packages, "navGroup", "libraries")); } ul:not(ul ul) > li { $pkg: item.shortName; > spa-a { route-href: "/packages/#{item.shortName}"; } } /* one `content` rule per link: a second one would rewrite the first's text on every pass */ ul:not(ul ul, [bind-libraries] ul) > li > spa-a { content: item.shortName; } [bind-libraries] ul:not(ul ul) > li > spa-a { content: displayName(item.shortName); } /* packages whose docs span several pages: one collapsible group per section */ [bind-sections] { content: iterate(item.docSections); summary { content: item.title; } details > ul { content: iterate(item.docs); spa-a { route-href: "/packages/#{$pkg}/#{item.name}"; content: item.title; } } details:not(:has(spa-a[is-active])) { open: none; } } } /* page titles: the page, then the site. The docs home keeps the title in the document head; the other routes carry theirs in markup */ spa-route[is-active] { /* a site guide */ &[route-href$=":name"] { $title-guide: list.find($package-indices.docs, "name", $route.params.name); document-title: "#{$title-guide.title or $route.params.name} · Nucleus · docs"; } /* a package README */ &[route-href$=":packageName"] { document-title: "#{displayName($route.params.packageName)} · Nucleus · docs"; } /* one page of a package's docs */ &[route-href$=":docName"] { $title-package: list.find($package-indices.packages, "shortName", $route.params.packageName); document-title: "#{docTitle($title-package, $route.params.docName)} · #{displayName($route.params.packageName)} · Nucleus · docs"; } } /* the page's markdown file, for the footer link: the docs home and each guide the index lists, and a package's page whose index entry says `markdown` (build-docs-index sets it; the dev server's index has none, so no link there). siteDocHref and the path check say which URL is the page's own: the 404 and a package's doc pages have none */ > spa-manager[active-url] { $page-path: attr("active-url").split("#").at(0).split("?").at(0); $page-name: if($page-path == SITE_HOME: SITE_HOME_DOC; else: $page-path.split("/").at(-1)); $page-guide: list.find($package-indices.docs, "name", $page-name); $page-package: list.find($package-indices.packages, "shortName", $page-name); $page-markdown: if($page-guide and siteDocHref($page-guide.name) == $page-path: "/docs/#{$page-guide.name}.md"; $page-package.markdown and "#{SITE_BASE}/packages/#{$page-package.shortName}" == $page-path: "/#{$page-package.shortName}.md"); footer [bind-page-markdown] { href: $page-markdown; content: ternary($page-markdown, "Markdown version of this page"); } } } spa-route { $route: prop("provision"); /* paramless routes name their guide in markup (the docs home, `/`); /docs/:name gets it from params */ $route-doc-name: attr("data-doc-name"); } /* the desktop aside and the mobile sheet stamp the same nav template */ [data-site-nav] { details:has(spa-a[is-active]) { /* not kosher */ open: ""; } spa-a[is-active] { aria-current: ""; } spa-a:not([is-active]) { aria-current: none; } } /* mobile sheet: Escape / back gesture while open; a tapped link closes it */ #site-menu { &[is-open] dismiss-watcher { is-active: ""; } &:not([is-open]) dismiss-watcher { is-active: none; } @on click (target: "spa-a") { is-open: none; } } #site-menu-gesture { &:has(> #site-menu[is-open]) { progress-offset: 1; } &:not(:has(> #site-menu[is-open])) { progress-offset: 0; } @on gesture-handler-start { #site-menu { is-scrubbing: ""; } } @on gesture-handler-end { #site-menu { is-open: event.detail.snap == 1; is-scrubbing: none; } } } main { @on copy-source (handle: copySource); } #search-dialog[open] { > include-content { is-active: ""; /* for some reason this is necessary on first render */ @on include-content-did-render (handle: focusInput); } input[type="search"] { /* works on all subsequent opens */ autofocus: ""; } } #search-dialog:not([open]) input[type="search"] { autofocus: none; }

Recompose

A builder is open until define() runs: import a package's raw builder, edit it, then register it yourself.

Import the raw builder

Every element package ships two entries: index.ts (calls .define() and registers the global types) and the raw element source (<element>.ts), which only exports the builder. Import the raw entry, edit it, then register it yourself:

// app.ts — never import "@excom/detect-browser" (or nucleus-kit) here: that entry defines the element immediately
import { DetectBrowser } from "@excom/detect-browser/detect-browser";
​
DetectBrowser
  // add lifecycles / methods the package did not ship
  .onPropSet("isStandalone", () => ({ emit: ["detect-browser-standalone"] }))
  .defineMethods({ clearInfo: () => ({ provision: null }) })
  .define();

Most recomposition is exactly that: chaining new lifecycles onto a packaged element. Unregistering is rarer and goes through builtConfig.

builtConfig

Every builder exposes its definition as builtConfig, a plain object you can read before define():

Key Shape
tag The packaged tag name (also the event prefix).
props { [propName]: PropConfig } — the normalized prop configs (type, attr, defaultValue, …).
events / broadcasts { [name]: { prefixWithTag? } }
methods [name, fn][] in definition order.
lifecycles { constructed, connected, adopted, disconnected, error, effect, propSet, propUnset, propChanged, promiseResolved, promiseRejected, broadcast, event, eventDefault }, each an array of [names, handler] pairs in registration order. names is the prop / event list the handler was registered with ([] for lifecycles without one).
reflectDefaultProps / definitionOpts As stated in Neutron(), absent when left out. A composed builder holds the last one stated.

Removing a lifecycle

Removal needs the original handler reference, because off* matches by function identity. Index into builtConfig.lifecycles.<lifecycle>[entry][1] and pass that handler to the matching off*:

// stop detecting on connect; the app calls `el.setBrowserInfo()` when it wants to
DetectBrowser.offConnected(DetectBrowser.builtConfig.lifecycles.connected[0][1]);
​
// named lifecycles: pass the names too — only those names are detached, the handler keeps any others
DetectBrowser.offPropSet("isStandalone", DetectBrowser.builtConfig.lifecycles.propSet[0][1]);

Indexing by position is intentional for now (a friendlier handle may come later); read builtConfig.lifecycles.<lifecycle> once to see which entry you are after.

Adding props

Adding props goes through Neutron.compose, which also leaves the imported builder untouched (it deep-clones):

import { Neutron } from "@excom/neutron";
​
export const StampedDetectBrowser = Neutron.compose([
  DetectBrowser,
  Neutron({ tag: "detect-browser", props: { detectedAt: String } }),
]).onPropSet("provision", () => ({ detectedAt: new Date().toISOString() }));
​
StampedDetectBrowser.define();

Rules

  • Everything must happen before define(). The runtime config is built at that moment; later on* / off* / defineMethods calls return the builder but change nothing.
  • The raw builder is a module singleton — an in-place edit is visible to every importer. Use Neutron.compose when you want a modified copy instead.
  • Added handlers run after the packaged ones for the same lifecycle (registration order) and batch into the same effect pass.
  • define("other-tag") registers the class under a different name. Events configured with prefixWithTag keep the packaged prefix, because the prefix comes from the builder's tag, not from the registered name.
  • Skipping index.ts also skips its declare global block — add your own (see TypeScript) if you want the tag typed.

Beta. The Nucleus Stack is in beta for a few weeks until features are stabilized and optimized.

Thanks — we'll email you when it ships.

Something went wrong. Please try again.