@museumwnf/viewer-layout 2.16.0 → 2.18.0

package/README.md

@@ -17,7 +17,7 @@ all the packages:
 | `@museumwnf/viewer-layout/content` | building blocks | the blocks alone, without the shell | the same |
 | `@museumwnf/viewer-layout/views` | composed views | whole pages driven by a spec the website declares, with slots it fills | viewer-core's data layer, the site config and the router |
 | `@museumwnf/viewer-layout/components` | composed views | `SiteShell`, the frame composed from `dataset.config.js` | the site config and the current route |
-| `@museumwnf/viewer-layout/dxa` | DXA family layer | the gallery and exhibition pages, `standardRoutes` | the entries above, `@museumwnf/viewer-core` and `@museumwnf/viewer-core/dxa` |
+| `@museumwnf/viewer-layout/dxa` | DXA family layer | the gallery and exhibition pages and shells, the family-only blocks, `standardRoutes`, `galleryConfig` / `exhibitionConfig` | the entries above, `@museumwnf/viewer-core` and `@museumwnf/viewer-core/dxa` |
 | `@museumwnf/viewer-layout/style.css` | — | one stylesheet for every entry, the family styles included | — |
 | `@museumwnf/viewer-layout/tokens.reference.css` | — | every token the package reads, with its fallback | — |
 
@@ -46,14 +46,15 @@ entries publish, and `@museumwnf/viewer-core`. A component that moves
 between entries keeps its old export as an alias until the websites have
 moved; a major release then removes the alias.
 
-Where the package does not follow these rules yet, milestone M10 moves it:
 `FeaturedPartners`, `SiblingGalleries`, `PopupLogo`, `PictureGallery`,
-`PictureNarrative` (blocks) and `RecordSheetView` (a composed view) are used
-only by the DXA family and move under `/dxa`
-([inventory-app#2017](https://github.com/museumwithnofrontiers/inventory-app/issues/2017));
-`PictureGallery`, `PictureNarrative` and `EssayView` default to
-`exhibition.*` entries, and `FeaturedPartners` to `partner.featured`, which
-does not exist.
+`PictureNarrative` (blocks) and `ItemDetailView` (the composed view that was
+`RecordSheetView`) are used only by the DXA family and live under `/dxa`
+since 2.18.0; `/content` and `/views` keep their old names as deprecated
+aliases until the next major
+([inventory-app#2055](https://github.com/museumwithnofrontiers/inventory-app/issues/2055)).
+Where the package does not follow the rules yet: `PictureGallery`,
+`PictureNarrative` and `EssayView` default to `exhibition.*` entries
+(inventory-app#2019).
 
 Two companion docs give a more scannable version of who-owns-what and the
 full slot list: [`docs/designer-contract.md`](docs/designer-contract.md) (the
@@ -322,7 +323,7 @@ the application registered, without any router coupling here.
 | `FeaturedPartners` | `records: [{ id, name, logo, city, country, description, route }]`, or `partners` (view-models from viewer-core's `partnerView()`: the first picture or logo, "city, country", the description as plain text cut at `descriptionLength`, 420), `headingEntry` ('partner.featured') | a carousel of partners with bullet controls, rotated on an 8-second timer; the site provides filtered/shuffled records and routes |
 | `SiblingGalleries` | `galleries: [{ id, name, image?, route }]`, `museums: [{ name, to \| href, accent?, textColor? }]`, `galleriesHeadingEntry`, `seeMoreGalleriesEntry`, `seeMoreGalleriesHref`, `museumsHeadingEntry` | two blocks of links: sibling galleries (may be unresolved, rendering as non-clickable tiles) and MWNF virtual museums (text initials over a coloured background) |
 | `PopupLogo` | `content` (Markdown or raw HTML), `rawHtml` (false), `enabled` (true), `closeLabel` ('core.action.close') | a dismissible fixed modal for sponsor notices; renders content through `renderInline` by default (escaping, Markdown); when `rawHtml: true`, passes content as-is (for trusted HTML from the importer) |
-| `BackLink` | `label` ('core.action.back'), `to \| href` (fallback when history is unavailable) | a "back" link that calls `router.back()` when browser history is available (length > 1); falls back to the provided route |
+| `BackLink` | `label` ('core.action.back'), `to \| href` (the fallback), `variant: 'button' \| 'bar'`, `arrow` ('←', the bar's leading mark) | a "back" link: `router.back()` when the previous page is one of this website's own (vue-router's `history.state.back`), the fallback otherwise, so a visitor who arrived from another site stays on this one; with no fallback, back through whatever history the tab has. The default is a button (`.mwnf-back-link`); `bar` is a link carrying `.mwnf-back-bar`, addressed to the fallback so it also opens in a new tab, whose default slot replaces the label |
 | `GlossaryTool` | `language`, `entity` ('glossary'), `labels` (entry-name overrides), `dir` | the search box four item sheets and a theme page each wrote for themselves: an input, the hits viewer-core's `searchGlossary` finds, the chosen definition as Markdown; a native `<details>` toggle |
 | `DynastyPopout` | `dynasty` (record: `from_ah`/`to_ah`/`from_ad`/`to_ad`), `text` (its translation: `name`, `also_known_as`, `area`, `history`), `dir` | one dynasty, collapsed behind a native `<details>` toggle: name, also known as, area, AH/AD dates, history as Markdown |
 | `DynastyList` | `heading`, `dynasties`, `tr` (dynasty → its translation), `dir` | one `DynastyPopout` per dynasty of a record, `RelatedRecords`'s shape |
@@ -330,7 +331,9 @@ the application registered, without any router coupling here.
 | `PictureGallery` | `pictures: [{ id, image, imageAlt?, name (inline HTML), imageCaption?, detail?, fields?: [{ label, value }], to (route \| null), backRelated?: [{ picture, reciprocalText }] }]`, `selectedId` (v-model), `seeItemEntry`/`unresolvedEntry`/`emptyEntry`/`addRelatedEntry`/`hideRelatedEntry` (entry names) | a DXA exhibition theme page's curated-picture side panel + thumbnail strip: the selected picture large, its fields, a link to the parent record (or the "not in this exhibition" message when `to` is `null`); a picture that is the target of some other picture's related link (`backRelated`) starts hidden behind an "Add related works" toggle |
 | `PictureNarrative` | `picture` (the selected picture, `PictureGallery`'s shape plus `related: [{ picture, text }]` and `backRelated: [{ picture, reciprocalText }]`), `contextualDescription` (Markdown), `relatedHeadingEntry`/`reciprocalFallbackEntry` (entry names); emits `select(id)` | the same page's narrative body, below `EssayView`'s own prose: the selected picture's own curated text, then the pictures it relates to (forward) and, when one points at it, the one it is related to (backward) — either direction may cross a theme boundary, which is why the website resolves the target/source picture rather than this component |
 | `TimelineLookup` | `info: { trigger? (entry, default `record.related.timelineForItem`), heading (entry), countries: [{ value, label }], defaultCountry?() => value, events(value) => [{ id?, year_from, text: { description } }], range: [from, to], era?(year) => string, searchTo(value, range) => to }` | the timeline popout `RecordSheetView`'s related block opens onto (see below): a trigger line, a country select, the events for the chosen country within the record's own date range (rendered through `md()`), and a "begin a full search" link — the DXA gallery/exhibition pair's shared shape, parameterized by the site's own timeline composable |
-
+| `SpecialFeatures` | `features` (the record's `details`: `{ id, internal_name, display_order, images, artist_names }`), `tr` (feature → its translation: `name`, `location`, `dates`, `description`), `language` (the pictures' captions), `glossary` (`RecordView`'s), `heading` ('sheet.field.specialFeatures'), `dir` | a monument's sub-details, as the data package embeds them on it: each one's name, location, dates and artists, its description as Markdown with the record's glossary terms, its pictures in a row; `DynastyList`'s shape |
+| `RelatedMedia` | `media` (the record's `media`: `{ title, description, url, language }`), `language` (the entries in it when there are any, all otherwise), `descriptions` (true), `heading` ('record.related.audioVideo'), `dir` | a record's audio and video, each a ↗ link opening elsewhere, its description under it |
+| `OnDisplayIn` | `groups: [{ heading? (entry), links: [{ id?, label (inline HTML), to? \| href?, external? }] }]`, `heading` ('record.related.onDisplayIn'; '' renders the groups alone), `pendingLabel` (entry, after a name with no address), `dir` | the exhibitions, chapters and galleries that show a record: a route links inside the site, an `external` address opens elsewhere marked ↗, a name with neither is plain text |
 The record contract `RecordList`, `RecordGrid` and `RelatedRecords` share:
 `{ id, image?, imageAlt?, name (inline HTML), meta: [string], badge?, href? | to? }`.
 `PictureGallery` and `PictureNarrative` share a narrower one — a curated
@@ -345,7 +348,7 @@ every bundle of `@museumwnf/viewer-i18n` from 1.7.0. `GlossaryTool` also reads
 `record.glossary.instructions`, `.definition` (1.7.0) and `record.glossary.tool`
 (2.3.0); `PartnerPanel` reads `partner.info.about`, `.contact`, `.logo`,
 `.addresses`, `.phone`, `.fax`, `partner.nav.homepage`,
-`partner.item.objectsInSite` and `partner.action.readMore`, `.viewObjects` (4.2.0); `DynastyPopout` reads `record.dynasty.heading` (2.3.0) and
+`partner.item.objectsInSite` and `partner.action.readMore`, `.viewObjects` (4.2.0); `SpecialFeatures`, `RelatedMedia` and `OnDisplayIn` default to `sheet.field.specialFeatures`, `record.related.audioVideo` and `record.related.onDisplayIn`; `DynastyPopout` reads `record.dynasty.heading` (2.3.0) and
 `sheet.field.alsoKnownAs`, `.area`, `.history`. `SourceCredit` reads
 `record.source.label` (2.5.0); the footer attribution (`SiteShell`) reads
 `record.source.rightsHolder` and `.termsOfUse` (2.5.0). `PictureGallery`/
@@ -353,14 +356,15 @@ every bundle of `@museumwnf/viewer-i18n` from 1.7.0. `GlossaryTool` also reads
 `.additionalContent`, `.addRelatedWorks`, `.hideRelatedWorks` and
 `exhibition.related.items`, `.reciprocal`, which only the `exhibition` and
 `standalone` bundles of `@museumwnf/viewer-i18n` carry — a family default
-in a generic entry, which ends when the two move under `/dxa` (see
+in the family's entry now, where the two live since 2.18.0 (see
 [Entry points and layers](#entry-points-and-layers)). Every other text is a
 prop.
 
 `FeaturedPartners`, `SiblingGalleries`, `PopupLogo`, `PictureGallery` and
-`PictureNarrative` are used only by the DXA family, and move under `/dxa`
-in milestone M10; their exports here stay as aliases until the websites have
-moved.
+`PictureNarrative` are used only by the DXA family, and live under `/dxa`
+since 2.18.0; their exports here are deprecated aliases until the next
+major. `FeaturedPartners`' heading defaults to `partner.list.featured`
+(viewer-i18n 4.3.0).
 
 ## Content classes
 
@@ -373,7 +377,7 @@ Building blocks copied from the legacy sites' own `site.css` files, available as
 | `.mwnf-form-table` | Table layout for label/value pairs in search and filter forms; header cells left-aligned, data cells right-padded |
 | `.mwnf-button` | Styled button for primary actions; variant `.mwnf-button--secondary` for secondary/destructive actions |
 | `.mwnf-select` | Legacy-styled select element with fixed height and padding |
-| `.mwnf-back-bar` | Container for back-link buttons with standard padding and hover styling |
+| `.mwnf-back-bar` | Container for back-link buttons with standard padding and hover styling; `.mwnf-back-bar--link` is `BackLink`'s `bar` variant, the link itself as the bar (`--mwnf-back-bar-margin`) |
 | `.mwnf-chip` | Inline project/source chip; variants `.mwnf-chip--<family>` where family is one of `ISLandEPM`, `DBA`, `AWE`, `DCA`, `DGA`, `EXH`, or `Galleries`, each with its own project-colour token |
 | `.mwnf-popout` | Detail box for sheet data; used in record detail popups and panels |
 | `.mwnf-loader` | Loading/spinner message container with centered text and standard padding |
@@ -384,8 +388,9 @@ Building blocks copied from the legacy sites' own `site.css` files, available as
 Whole pages, made of the content components on viewer-core's
 composables and driven by a declaration the website writes instead of a
 page. They are the broad page structures every kind of website shares;
-`RecordSheetView`, used only by the DXA family, moves under `/dxa` with a
-Detail name in milestone M10. They are exported from `@museumwnf/viewer-layout/views` — and only from
+`RecordSheetView`, used only by the DXA family, is `/dxa`'s `ItemDetailView`
+since 2.18.0, and stays here as a deprecated alias until the next major.
+They are exported from `@museumwnf/viewer-layout/views` — and only from
 there: they read the records and the engine from `@museumwnf/viewer-core`
 itself, whose entry point carries `.vue` files, and a website's test runner
 that loads this package natively would fail on the first one if the package
@@ -425,7 +430,7 @@ export default {
 
 | View | Declaration | Slots |
 |---|---|---|
-| `HomeView` | `config.home` or the same as props: `title`, `intro` (Markdown), `cards: [{ title, description, action, to \| href }]`, `featured: { entity, heading, action, route, eyebrow, meta, seed }` — the pick is `useFeaturedRecord` | `before`, default, `after` |
+| `HomeView` | `config.home` or the same as props: `title`, `intro` (Markdown), `cards: [{ title, description, action, to \| href }]`, `featured: { entity, heading, action, route, eyebrow, meta, seed, filter }` — the pick is `useFeaturedRecord`, among the records `filter` keeps (viewer-core 2.2.0) — `panels` (the welcome and the record as `.mwnf-panel` boxes) | `before`, default, `after` |
 | `CatalogueResultsView` | `spec`: `entity`, `keys`, `facets` (viewer-core's facet spec), `facetScope: 'all' \| 'matching'`, `controls: [{ key, type: 'select' \| 'year' \| 'query' \| 'checkbox', label, placeholder, anyLabel, hideEmpty }]`, `filterMode: 'apply' \| 'immediate'`, `scope(record, filters)`, `match(record, filters)`, `narrow(list, filters, helpers)` (a rule over the whole list — a keyword index, say), `dates: { mode, begin, end }`, `sort`, `pageSize`, `variant: 'list' \| 'grid'`, `record(record, helpers)`, `recordRoute`, `summary(context)`, `title`, `filterTitle`, `empty`, `actionLabel`, `pagination` | `before`, `filters`, `actions`, `aside`, `empty`, `after` — each given `{ filters, active, apply, reset, goToPage, matching, pageInfo, options }`, enough to compose the panel in the aside or a second pagination |
 | `RecordView` | `spec` and `id`: `entity`, `translations`, `attribution`, `fields` (viewer-core's `sheetRows` spec, or a function of the context), `sections`, `layout`, `shortDescription`, `media(record, ctx)`, `mediaVariant`, `credits`, `workingNumber`, `citation: { project, permalink: true \| false \| string, heading } \| false` (the permalink is `sourceUrl(currentRoute)` — null, so no address, until the website declares `site.origin` — unless the spec disables it with `false` or overrides it with a string), `related: { variant, heading, record, route } \| false`, `back: { label, to \| href }`, `title(ctx)` | `header`, `before-sheet`, `after-sheet`, `aside`, `source` (under the citation; default `SourceCredit`), `related`, `after`, and one named after every `custom` or `link` row — each given `{ record, text, language, languages, select, dir, glossary, ready, attribution, t, tr }`; `related` also `records` (the rows) and `outside` (the related records the package does not carry) |
 | `RecordSheetView` | Every `RecordView` prop (`spec`, `id`, `entity`) plus `dataGetter(id) => record \| null \| undefined` — a website's own language-subset record lookup (an exhibition's per-build `itemById.get`); omitted, every `id` `RecordView` itself finds is treated as present (the gallery shape); supplied and it reports `id` missing, `NotFoundView` renders before `RecordView` ever mounts (the exhibition shape's per-language-build 404), and it also narrows the related block's `records`/outside-reference split the same way. The DXA gallery/exhibition item sheet's own blocks, on top of `spec`: `sourceDatabase: { label?, chipClass(record, ctx), addToCollection: { label? } \| false } \| false` (the source-database line + `backward_compatibility` code + "add to my collection" link — `chipClass` is a site's own project→colour map, the name comes from `useProjects()`), `notice: { show(record, ctx), label } \| false` (the Explore-partner notice), `museum: { route(partnerId, ctx) } \| false` (the holding-museum row: the item's holder text, then the partner as `PartnerPanel`'s `summary` — "About {name}, {city}, {country}" — linked through `route`; `route` returning null keeps the name without a link, for a hidden partner; `false` keeps the holder text alone; decision D3), and on `spec.related`: `title`, `description` (entries, above the block), `notInPackageLabel`, `outsideChip(ref, ctx)` (an outside reference's chip — `TODO(#1727)`, no `project_id` on a stub yet), `artisticIntroductionLabel` (with `useProjects().links(record.project_id).artisticIntroductionUrl`), `databaseLabel` (ditto, `.relatedDatabaseUrl`), `overallDatabase: { label, linkLabel } \| false` (`mwnfLinks.overallDatabase`), `onDisplayIn: { linkPendingLabel } \| false` (`record.gallery_references`, by `kind`), `download: false` (default on, `record.action.download`/`.downloadPdf`, prints), `glossary: false` (default on, `GlossaryTool`), `dynasties(record, language, ctx) => { records, tr } \| null` (`DynastyList`), `media: false` (default on, `record.media`, a `SheetSection`), `timeline(record, ctx) => TimelineInfo \| null` (`TimelineLookup` — see `docs/slot-catalogue.md`) | Every `RecordView` slot, forwarded straight through by name, unmodified, **except** `before-sheet`/`museum`/`related`: each always has this view's own default content (above), which a website's own slot still replaces entirely — "a slot fills, the default content renders otherwise" |
@@ -503,24 +508,49 @@ it, and a website can still replace any family page with its own component
 on the same route name. Texts stay in `@museumwnf/viewer-i18n`'s `gallery`
 and `exhibition` sections.
 
-It ships each family's pages plus `standardRoutes(family, config)`, the
-RouteRecord factory a site spreads into `extraViews`. One page serves both
-families: `PartnerDetail`, the partner page (`PartnerPanel`'s `full`
-variant), fed by each family's own half — `galleryPartnerDetail` /
-`exhibitionPartnerDetail`, which `standardRoutes` passes as its `family`
-prop; `GalleryPartnerProfile`/`ExhibitionPartnerProfile` are the same page
-under their old names.
+Since 2.18.0 it holds a whole DXA site but its values. A gallery's or an
+exhibition's `dataset.config.js` is one call:
 
 ```js
-import { standardRoutes } from '@museumwnf/viewer-layout/dxa'
-
-extraViews: [
-  ...standardRoutes('gallery', { creditsBody: 'carpets.credits.body' }),
-  // + this gallery's own routes: home, item, collection entrance,
-  // timeline entrance, partners entrance
-]
+import { galleryConfig } from '@museumwnf/viewer-layout/dxa'
+
+export default galleryConfig({
+  datasetPackage: '@museumwnf/carpets-data',
+  siteName: 'Carpets',                                   // for a package without manifest.site
+  origin: 'https://museumwithnofrontiers.github.io/carpets',
+  projectColors: { '<project id>': 'mwnf-chip--DCA' },  // one of the mwnf-chip--* classes
+  noticeProjects: ['<project id>'],                      // sheets with the Explore-partner notice
+  creditsBody: 'carpets.credits.body',
+})
 ```
 
+`exhibitionConfig` takes the same values (and `partnerObjects`, overrides of
+the shared `exhibition.partnerObjects.*` entries). The config carries the
+family's shell (`GalleryShell` / `ExhibitionShell`), menu, banner, sponsor
+strip, legacy redirects, and every page through
+`standardRoutes(family, { pages: true, … })`:
+
+- the eleven pages every site of a family already served from here
+  (search, partners, partner and institution pages, timeline results and
+  gallery, collection search and results, and a gallery's about and
+  credits);
+- with `pages: true`, the pages each site used to carry itself: the home
+  page, the item page (`GalleryItemDetail` / `ExhibitionItemDetail`, on
+  `ItemDetailView` and viewer-core's `useGalleryItemDetail` /
+  `useExhibitionItemDetail`), the timeline entrance, and an exhibition's
+  about page, themes, theme pages, theme galleries, related content and
+  credits.
+
+One page serves both families: `PartnerDetail`, the partner page
+(`PartnerPanel`'s `full` variant), fed by each family's own half —
+`galleryPartnerDetail` / `exhibitionPartnerDetail`, which `standardRoutes`
+passes as its `family` prop; `GalleryPartnerProfile` /
+`ExhibitionPartnerProfile` are the same page under their old names.
+
+An exhibition's theme pages read its three theme colours as
+`--mwnf-dxa-theme-*` tokens; a record with no project gets the
+`mwnf-chip--Explore` chip.
+
 Route names and paths are pinned to what every live DXA site already
 registers, so adopting the factory keeps every existing deep link (and
 every `legacyRoutes` resolver targeting those names) working unmodified.

package/dist/FeaturedRecord-mRyLN7Mt.js

@@ -0,0 +1,88 @@
+import { T as e } from "./OnDisplayIn-D6r_KvpI.js";
+import { Fragment as t, computed as n, createCommentVNode as r, createElementBlock as i, createElementVNode as a, createVNode as o, openBlock as s, renderList as c, renderSlot as l, toDisplayString as u, useSlots as d, withCtx as f } from "vue";
+//#region src/content/FeaturedRecord.vue
+var p = {
+	key: 0,
+	class: "mwnf-featured"
+}, m = {
+	key: 0,
+	class: "mwnf-featured__heading"
+}, h = {
+	key: 0,
+	class: "mwnf-featured__media"
+}, g = ["src", "alt"], _ = { class: "mwnf-featured__body" }, v = {
+	key: 0,
+	class: "mwnf-featured__eyebrow"
+}, y = ["innerHTML"], b = {
+	key: 1,
+	class: "mwnf-featured__action"
+}, x = {
+	__name: "FeaturedRecord",
+	props: {
+		image: {
+			type: String,
+			default: ""
+		},
+		imageAlt: {
+			type: String,
+			default: ""
+		},
+		eyebrow: {
+			type: String,
+			default: ""
+		},
+		name: {
+			type: String,
+			default: ""
+		},
+		meta: {
+			type: Array,
+			default: () => []
+		},
+		action: {
+			type: String,
+			default: ""
+		},
+		to: {
+			type: [String, Object],
+			default: null
+		},
+		href: {
+			type: String,
+			default: ""
+		},
+		heading: {
+			type: String,
+			default: ""
+		}
+	},
+	setup(x) {
+		let S = x, C = d(), w = n(() => !!(S.name || S.image || C.default));
+		return (n, d) => w.value ? (s(), i("section", p, [x.heading ? (s(), i("h2", m, u(x.heading), 1)) : r("", !0), l(n.$slots, "default", {}, () => [o(e, {
+			class: "mwnf-featured__link",
+			to: x.to,
+			href: x.href
+		}, {
+			default: f(() => [x.image ? (s(), i("span", h, [a("img", {
+				class: "mwnf-featured__image",
+				src: x.image,
+				alt: x.imageAlt,
+				loading: "eager"
+			}, null, 8, g)])) : r("", !0), a("span", _, [
+				x.eyebrow ? (s(), i("span", v, u(x.eyebrow), 1)) : r("", !0),
+				a("span", {
+					class: "mwnf-featured__name",
+					innerHTML: x.name
+				}, null, 8, y),
+				(s(!0), i(t, null, c(x.meta, (e, t) => (s(), i("span", {
+					key: t,
+					class: "mwnf-featured__meta"
+				}, u(e), 1))), 128)),
+				x.action ? (s(), i("span", b, u(x.action) + " →", 1)) : r("", !0)
+			])]),
+			_: 1
+		}, 8, ["to", "href"])])])) : r("", !0);
+	}
+};
+//#endregion
+export { x as t };