@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; }

scroll-into-view

Scrolls an element into view — on connect by default, or on click / any event via the inherited listen-for.

Features

  • Scroll on connect Works with no attributes needed
  • Any trigger Combine with listen-for to scroll on click, custom events, or lifecycles
  • Alignment control scroll-align picks start / center / end / nearest per axis
  • Offset for fixed headers scroll-offset nudges the final position after alignment
  • Skip redundant scrolls if-needed scrolls only when the target isn't already visible

Installation

This package is available in the NucleusKit. Or it can be used by itself:

CDN Package Manager 
<script src="https://unpkg.com/@excom/kit-utils@0.3.0/dist/index.umd.min.js"></script>
<script src="https://unpkg.com/@excom/neutron@0.2.0/dist/index.umd.min.js"></script>
<script src="https://unpkg.com/@excom/scroll-into-view@0.1.4/dist/index.umd.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@excom/scroll-into-view@0.1.4/dist/index.css">
 
npm install @excom/scroll-into-view
HTML Imports JS / CSS Imports 
<!-- import path to `node_modules` will depend on your build setup -->
<script type="module" src="/node_modules/@excom/scroll-into-view"></script>
<link rel="stylesheet" href="/node_modules/@excom/scroll-into-view">
 
import "@excom/scroll-into-view";
@import "@excom/scroll-into-view/index.css";
Peer dependencies (0)

Packages a consumer must install alongside this one. Workspace deps are bundled.

Package Version
View Dist Files

All exports:

.
  • types: ./dist/index.d.ts
  • import: ./dist/index.js
  • default: ./dist/index.js
./index
  • types: ./dist/index.d.ts
  • import: ./dist/index.js
  • default: ./dist/index.js
./index.bundle.min.css
  • default: ./dist/index.bundle.min.css
./index.css
  • default: ./dist/index.css
./index.js
  • types: ./dist/index.d.ts
  • import: ./dist/index.js
  • default: ./dist/index.js
./index.min
  • types: ./dist/index.d.ts
  • import: ./dist/index.min.js
  • default: ./dist/index.min.js
./index.min.css
  • default: ./dist/index.min.css
./index.min.js
  • types: ./dist/index.d.ts
  • import: ./dist/index.min.js
  • default: ./dist/index.min.js
./index.umd.min
  • types: ./dist/index.d.ts
  • default: ./dist/index.umd.min.js
./index.umd.min.js
  • types: ./dist/index.d.ts
  • default: ./dist/index.umd.min.js
./scroll-into-view
  • types: ./dist/scroll-into-view.d.ts
  • import: ./dist/scroll-into-view.js
  • default: ./dist/scroll-into-view.js
./scroll-into-view.js
  • types: ./dist/scroll-into-view.d.ts
  • import: ./dist/scroll-into-view.js
  • default: ./dist/scroll-into-view.js
./scroll-into-view.min
  • types: ./dist/scroll-into-view.d.ts
  • import: ./dist/scroll-into-view.min.js
  • default: ./dist/scroll-into-view.min.js
./scroll-into-view.min.js
  • types: ./dist/scroll-into-view.d.ts
  • import: ./dist/scroll-into-view.min.js
  • default: ./dist/scroll-into-view.min.js
./scroll-into-view.umd.min
  • types: ./dist/scroll-into-view.d.ts
  • default: ./dist/scroll-into-view.umd.min.js
./scroll-into-view.umd.min.js
  • types: ./dist/scroll-into-view.d.ts
  • default: ./dist/scroll-into-view.umd.min.js

Usage

By default, <scroll-into-view> scrolls itself into view as soon as it connects to the DOM. Set target-ref to scroll a different element instead, and pair with the inherited listen-for to trigger on click or any event rather than on connect.

<!-- Jump to a section on click -->
<scroll-into-view target-ref="#pricing" listen-for="click">
  See pricing
</scroll-into-view>

API Reference

scroll-into-view

Attributes (18) Role — option is configurable, state is managed by the element (read-only), or hybrid which is both. Role Attribute Type Values Prop Default option delay-ms
Delay handling by this many milliseconds. delayMs listenable-element
number null option host-ref
Listen on another element / window / document — e.g. Escape to dismiss a dialog from a global keydown. Defaults to :scope. Used with listen-for. Not compatible with listen-for-lifecycle. The selector MUST resolve when host-ref is set — it will not wait for a match to appear. hostRef listenable-element
string <CSS Selector> | "window" | "document" | "html" | "body" | "head" null option if-needed
Only scroll if the target isn't already fully visible. ifNeeded
boolean false option is-debounced
With delay-ms, coalesce bursts into one trailing call (debounce). isDebounced listenable-element
boolean false option keycode-filter
Space-separated key filters (OR). Join modifiers with + (AND, any order): shift+k tab → Shift+K or Tab. Modifiers: shift, alt, ctrl/control, meta/cmd. Name the space bar space / spacebar and the plus key plus (shift+space). Case-insensitive. keycodeFilter listenable-element
tokenlist <key | mod+key>… null option listen-for
Space-separated event names to listen for. Defaults to click when unset (and no lifecycle list is set). listenFor listenable-element
tokenlist <EventName>… null option listen-for-lifecycle
Space-separated element lifecycles to handle. listenForLifecycle listenable-element
tokenlist "connected" | "disconnected" | "adopted" null option listen-once
Handle each distinct event name / lifecycle at most once. listenOnce listenable-element
boolean false option pathname-filter
Only handle when location.pathname is one of these values — route-aware behaviors without a separate router element. pathnameFilter listenable-element
tokenlist <pathname>… null option prevent-default
Call preventDefault() on matched events (ignored for lifecycles). preventDefault listenable-element
boolean false option scroll-align
Two tokens <inline> <block> (x and y, respectively) controlling how the target aligns inside the scrollport. Each token is start, center, end, nearest, or none (skip alignment on that axis). scrollAlign
tokenlist "start" | "center" | "end" | "nearest" | "none" "nearest start" option scroll-behavior
Scroll animation. scrollBehavior
string "auto" | "smooth" | "instant" "auto" option scroll-offset
Two pixel offsets <x> <y> applied after alignment — e.g. leave room for a sticky header by using a negative <y>. scrollOffset
tokenlist <px> <px> "0 0" option selector-filter
Only handle events whose event.target matches this CSS selector. Does not support :scope in the selector. selectorFilter listenable-element
string <CSS Selector> null option stop-immediate-propagation
Call stopImmediatePropagation() on matched events (ignored for lifecycles). stopImmediatePropagation listenable-element
boolean false option stop-propagation
Call stopPropagation() on matched events (ignored for lifecycles). stopPropagation listenable-element
boolean false option target-ref
CSS selector of the element to scroll to. Unset scrolls this element itself. targetRef
string <CSS Selector> null option vibrate-ms
Vibrate on handle (navigator.vibrate). Empty / 0 uses a 20ms pulse. vibrateMs listenable-element
number "20 (when attribute is present with no value)"
Provision (0) This provision property lives on the DOM node. Read / watch it with Quark’s prop("provision"), or listen for the neutron-provision event from app JS. Property Type
Events (0)
Dispatches — events that scroll-into-view fires and their default actions. Dispatch Default Action
A "default action" is subsequent logic executed by the element if e.preventDefault() is not synchronously called on the event.
Listeners — events that scroll-into-view listens for which will trigger subsequent actions. Listener Type Action
Commands — verbs scroll-into-view accepts as a command event (HTML Command API): from a <button command commandfor>, an <event-handler command-name>, or a CommandEvent. Command Action
Recognized Elements (0) Child or descendant elements are recognized by scroll-into-view and relevant to its functionality. Element Relationship Required
Styles (1)
Classes — optional classes that change the appearance of scroll-into-view. Class Description
Variables — public CSS variables for theming scroll-into-view. Opt-out:
If you wish to opt-out of these styles on a case-to-case basis, use property all: revert-layer. Valence.css ships this as .unstyled and .unstyled-all for the entire tree.
Variable Syntax Default
Aliases — @custom-selector synonyms so custom elements can share semantic styles. Element aliases match the host tag / .tag-* class; state aliases match attributes (nested under the element alias). Alias Kind Matches :--scroll-into-view element scroll-into-view, .tag-scroll-into-view
Release notes (1)

0.1.1

  • Ship only dist (and declared extras) in the npm tarball; drop build logs, tests and sources
View Source

Examples

Offset for a sticky header

scroll-offset="0 -50" (negative <y>) leaves room for a sticky header after alignment; scroll-behavior="smooth" animates the scroll. This is the pattern used to jump between sections without the header covering the target's heading.

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.