Skip to content

Add search restore and UI validation#24

Open
ritorhymes wants to merge 8 commits into
eips-wg:masterfrom
ritovision:search-restore-validation
Open

Add search restore and UI validation#24
ritorhymes wants to merge 8 commits into
eips-wg:masterfrom
ritovision:search-restore-validation

Conversation

@ritorhymes

@ritorhymes ritorhymes commented May 18, 2026

Copy link
Copy Markdown

Built on top of the v2 multi-repo local build system #15.

Part of the Pagefind search rollout coordinated in eips-wg/preprocessor#39. This PR is stacked on #23, which adds full search pagination. This completes the stacked theme search UI rollout.

Description

Adds 24-hour last-search restore and hardens search UI validation around the completed full search page.

The last-search restore allows users to navigate away from the page to pursue search findings and then return later to continue navigating the same pool of search results, instead of needing to begin a search again from scratch each time.

Demo site: wg-eips.ritovision.com/search

  • Adds a storage module for the 24-hour last-search restore convenience.
  • Stores only the canonical generated search-route URL in a versioned localStorage envelope.
  • Restores the stored search URL with replaceState only when the current search URL has no active criteria.
  • Expires stored search URLs after 24 hours and rejects malformed, expired, cross-route, absolute, hash-bearing, inactive, and unsupported stored entries.
  • Writes storage after active committed searches and page changes, clears storage for committed empty searches, and avoids clearing unsupported-version storage on initial inactive load.
  • Reuses the normal search URL parser for stored URLs so restored searches follow the same normalization rules as shared links.
  • Keeps storage isolated from Pagefind loading, result rendering, result payloads, absolute current URLs, and cross-tab storage listeners.
  • Refactors share-link state handling without changing the icon-state feedback behavior added earlier in the stack.
  • Hardens search UI validation for storage isolation, restore eligibility, URL normalization, share button behavior, Pagefind import boundaries, and the completed browser search contract.
  • Keeps the production Pagefind search path independent of storage: bookmarked/shared URLs remain the primary persistence mechanism.

This PR completes the stacked theme search UI rollout. It does not add saved-search lists, recent-search lists, semantic search, or Pagefind support for serve/check lifecycles.

Render external requires entries as direct links without forcing Zola to
resolve them as local pages.

This supports targeted --only rendering, where cross-repo proposal
dependencies can be rewritten to external URLs instead of local pages.

Move the theme demo homepage badges into front matter, a homepage_badges
macro, and theme-owned styles so the demo homepage stays
markdown-friendly.

Declare Zola 0.22.1 as the minimum supported version, enable bottom
footnotes, and update markdown highlighting to the class-based config
with github-light/dark themes and ABNF/CSL-JSON grammars.
Add POSIX and PowerShell setup scripts for theme contributors that
reuse or install build-eips, ensure a supported Zola is available, and
bootstrap the surrounding workspace through an active proposal repo.

Document the theme local development workflow, including workspace
layout, setup flags, serve versus preview, server/base URL settings,
targeted rendering, and source/output overrides.

Keep this focused on setup and documentation; theme rendering behavior
continues to be owned by the earlier theme PR.
Add the generated search route page and inert search state fallback
chain. The theme ships data/build_eips_search.toml with enabled = false
and a [extra.search] block in theme.toml. base.html prefers the project
data file when build-eips has written one and falls back to the
theme-level config for standalone theme consumption. The search route
renders the mount, embeds search state as JSON for later runtime code,
and shows a disabled-state message when search is off. No Pagefind
browser assets are loaded here.

Add the generated search route to the header navigation with a normal
text link so desktop and mobile navigation have the route as soon as the
route exists.

Add the Pagefind indexing contract on proposal rendering. Mark the
proposal article as the data-pagefind-body region and mark repeated
chrome as data-pagefind-ignore, so the index covers proposal prose
rather than taxonomy badges, preamble tables, the table of contents,
status callouts, links, citations, or other repeated UI. Emit Pagefind
filters for derived proposal_category, status, name-only authors, and
created_year; meta for proposal id, title, description, status, type,
category, author display strings, and created date; and sort keys for
number and created date.

Read the canonical proposal id from page.extra.proposal_id on rendered
proposal pages, and add proposal_id values to the committed theme
fixtures so standalone theme rendering produces the same ids that
build-eips will write.

Add two validation scripts. scripts/check-search-template covers the
fallback chain by building downstream Zola fixtures for missing project
data and project override cases. scripts/check-pagefind-indexing-hooks
runs real Pagefind against rendered output and asserts that /search/,
home, taxonomy pages, generic pages, and repeated chrome do not appear
in the index.
Replace the old Fuse search runtime with Pagefind-backed browser search.

Add a loader module as the single Pagefind API boundary. The loader
imports the configured Pagefind bundle, sets basePath, baseUrl, and
excerptLength, initializes once, and serves both search surfaces. Split
the prior monolithic search.mjs into focused modules for config,
constants, DOM helpers, loading, modal search, full-page search, and
result rendering. Rebuild the quick search modal against the new loader
with the final keyword/phrase copy and modal layout.

Wire the full search page runtime shell with query state, the
relevance/number/created sort contract, a status region, a results
region, and the final share-link icon button. The share button keeps
copy success or failure feedback on the icon state instead of rewriting
the result status text.

Update base.html to expose resolved search state as a JSON config script
for client JavaScript, make the global header search trigger a real
/search/ link, and load search UI styles from a dedicated stylesheet
instead of injecting them from JavaScript after startup.

Add check-pagefind-search-ui coverage for the loader boundary, quick
search modal, share icon state, and full search runtime shell against
rendered output.
Add Pagefind-backed filter controls on top of the runtime core. Read
available filter values from Pagefind and render draft-driven dropdowns
for Proposal Category, Status, and Author.

Establish the draft, staged, and committed state model for full search.
Dropdown edits are staged while a dropdown is open. Query and filter
edits update draft UI state. Search or Enter commits the draft query and
filters together, updates the URL, and runs Pagefind. Dropdown Apply,
outside click, chip removal, clear-field actions, and author mode
changes update draft state only. Empty searches clear to the clean
search route without calling Pagefind. Sort continues to commit on
change against committed state.

Use the rendered proposal filter contract introduced by the template
hook foundation: proposal_category, status, and author. Encode Proposal
Category with URL parameter proposalCategory and Pagefind field
proposal_category. Keep Pagefind import, filter loading, and search
execution behind loader.mjs.

Render disabled loading filter shells in the template so the filter
layout is present before JavaScript hydrates it. Add dropdown overlay,
chevron, chip, result-hover, and loading-state styles with validation
coverage for the URL/state contract and Pagefind filter queries.
Add the Created Date range filter on top of the generic full-search
filter controls.

Expose createdFrom and createdTo URL parameters, normalize invalid or
reversed year ranges, and expand committed ranges into inclusive
Pagefind created_year OR filters. Keep same-year selections encoded as a
single starting year.

Render the Created Date control as a Year selector plus a disabled To
selector that unlocks after Year is selected. Display a single range
chip for the committed years and keep clear/remove actions in draft
state until Search or Enter commits.

Add stylesheet and validation coverage for the Created Date control,
loading shell, URL normalization, and Pagefind year filter expansion.
@ritorhymes ritorhymes force-pushed the search-restore-validation branch from ee28d06 to 6865352 Compare May 20, 2026 13:13
@ritorhymes ritorhymes force-pushed the search-restore-validation branch from 6865352 to d5a46fa Compare May 20, 2026 13:36
@ritorhymes ritorhymes marked this pull request as ready for review May 20, 2026 23:34
Add result pagination on top of the filter UI. Pagination commits on
change, like sort, and shares the same URL-backed committed state.

Track the current page as a page URL parameter and normalize
out-of-range values against the active result count. Slice cached
Pagefind results to the current page, so paging does not rerun Pagefind;
only sort, query, or filter commits do. A new query, filter, or sort
commit resets the page to 1.

Add the pagination control module, page markup, scroll controls, compact
page status, responsive styles, and validation coverage. Query and
filter edits continue to ride the explicit Search or Enter commit path.
Add the 24-hour last-search URL restore convenience on top of the
completed search UI.

Store only the canonical generated search-route URL in a versioned
localStorage envelope, expire it after 24 hours, and restore it with
replaceState only when the current search URL has no active criteria.

Harden the UI validation script around storage isolation, URL
normalization, restore eligibility, and the search browser contract.
@ritorhymes ritorhymes force-pushed the search-restore-validation branch from d5a46fa to 9b321f9 Compare May 20, 2026 23:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant