@vit-foundation/ui 0.3.0 → 0.7.0

package/dist/components/account/NewsletterSignup.svelte

@@ -1,5 +1,7 @@
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
+	import Editable from '../../edit/Editable.svelte';
 	import { withNewsletterIntent } from '../../forms/transport.js';
 	import type { NewsletterToggleFormInstance } from './AccountPanel.svelte';
 	import Button from '../ui/Button.svelte';
@@ -27,28 +29,49 @@
 
 <section class="newsletter" aria-labelledby="newsletter-title">
 	<div class="inner band">
-		<h2 id="newsletter-title">{msg.newsletter_title()}</h2>
-		<p>{msg.newsletter_intro()}</p>
+		<Editable edit={config.messageEdit?.('newsletter_title')} value={msg.newsletter_title()}>
+			{#snippet children(text, attrs)}<h2 id="newsletter-title" {...attrs}>{text}</h2>{/snippet}
+		</Editable>
+		<Editable edit={config.messageEdit?.('newsletter_intro')} value={msg.newsletter_intro()}>
+			{#snippet children(text, attrs)}<p {...attrs}>{text}</p>{/snippet}
+		</Editable>
 
 		{#if account === null}
 			<p class="prompt">
-				{msg.newsletter_promptLoggedOut()}
+				<Editable
+					edit={config.messageEdit?.('newsletter_promptLoggedOut')}
+					value={msg.newsletter_promptLoggedOut()}
+				>
+					{#snippet children(text, attrs)}<span {...attrs}>{text}</span>{/snippet}
+				</Editable>
 				<Link href={withNewsletterIntent('/signup')}>{msg.comments_signupLink()}</Link>
 				·
 				<Link href={withNewsletterIntent('/login')}>{msg.comments_loginLink()}</Link>
 			</p>
 		{:else if account.newsletterSubscribed}
 			<p class="prompt">
-				{msg.newsletter_subscribedNote()}
+				<Editable
+					edit={config.messageEdit?.('newsletter_subscribedNote')}
+					value={msg.newsletter_subscribedNote()}
+				>
+					{#snippet children(text, attrs)}<span {...attrs}>{text}</span>{/snippet}
+				</Editable>
 				<Link href="/account">{msg.account_navLabel()}</Link>
 			</p>
 		{:else}
 			<form {...f}>
 				<input {...f.fields.action.as('hidden', 'subscribe')} />
 				<LocaleField field={f.fields.locale} />
-				<Button type="submit" pending={f.pending}>
-					{msg.account_newsletterSubscribe()}
-				</Button>
+				<ActionLabel
+					edit={config.messageEdit?.('account_newsletterSubscribe')}
+					value={msg.account_newsletterSubscribe()}
+				>
+					{#snippet control()}
+						<Button type="submit" pending={f.pending}>
+							{msg.account_newsletterSubscribe()}
+						</Button>
+					{/snippet}
+				</ActionLabel>
 			</form>
 			{#if f.result}
 				<div class="feedback-slot">

package/dist/components/contact/ContactForm.svelte

@@ -19,6 +19,7 @@
 
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
 	import { CONTACT_MESSAGE, CONTACT_NAME, EMAIL } from '../../forms/constraints.js';
 	import { CONTACT_CATEGORIES } from '../../content/types.js';
 	import { contactCategoryLabel } from '../../utils/contact.js';
@@ -120,7 +121,11 @@
 		<Honeypot form={f.fields} id="contact-website" />
 
 		<div class="actions">
-			<Button type="submit" pending={f.pending}>{msg.contact_submit()}</Button>
+			<ActionLabel edit={config.messageEdit?.('contact_submit')} value={msg.contact_submit()}>
+				{#snippet control()}
+					<Button type="submit" pending={f.pending}>{msg.contact_submit()}</Button>
+				{/snippet}
+			</ActionLabel>
 		</div>
 
 		{#if f.result && !f.result.ok}

package/dist/components/jobs/JobList.svelte

@@ -30,8 +30,12 @@
 </script>
 
 {#if jobs.length === 0}
-	<p class="empty">{msg.jobs_empty()}</p>
-	<p class="nudge">{msg.jobs_newsletterNudge()}</p>
+	<Editable edit={config.messageEdit?.('jobs_empty')} value={msg.jobs_empty()}>
+		{#snippet children(text, attrs)}<p class="empty" {...attrs}>{text}</p>{/snippet}
+	</Editable>
+	<Editable edit={config.messageEdit?.('jobs_newsletterNudge')} value={msg.jobs_newsletterNudge()}>
+		{#snippet children(text, attrs)}<p class="nudge" {...attrs}>{text}</p>{/snippet}
+	</Editable>
 {:else}
 	<ul>
 		{#each jobs as job (job.slug)}
@@ -49,7 +53,9 @@
 			</li>
 		{/each}
 	</ul>
-	<p class="nudge">{msg.jobs_newsletterNudge()}</p>
+	<Editable edit={config.messageEdit?.('jobs_newsletterNudge')} value={msg.jobs_newsletterNudge()}>
+		{#snippet children(text, attrs)}<p class="nudge" {...attrs}>{text}</p>{/snippet}
+	</Editable>
 {/if}
 
 <style>

package/dist/components/layout/Footer.svelte

@@ -1,6 +1,9 @@
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
 	import type { SiteLink } from '../../config/types.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
+	import Editable from '../../edit/Editable.svelte';
+	import type { EditDescriptor } from '../../edit/types.js';
 	import Link from '../ui/Link.svelte';
 
 	/**
@@ -10,9 +13,11 @@
 	 */
 	interface Props {
 		links: SiteLink[];
+		/** Edit descriptors for the link labels — see Nav. */
+		editFor?: (link: SiteLink) => EditDescriptor | undefined;
 	}
 
-	let { links }: Props = $props();
+	let { links, editFor = undefined }: Props = $props();
 
 	const config = getUiConfig();
 
@@ -26,10 +31,22 @@
 		</span>
 		<ul>
 			{#each links as link (link.href)}
-				<li><Link href={link.href}>{link.label}</Link></li>
+				<li>
+					<ActionLabel edit={editFor?.(link)} value={link.label}>
+						{#snippet control()}<Link href={link.href}>{link.label}</Link>{/snippet}
+					</ActionLabel>
+				</li>
 			{/each}
 		</ul>
-		<p class="rights">© {year} {config.messages.footer_rights()}</p>
+		<p class="rights">
+			© {year}
+			<Editable
+				edit={config.messageEdit?.('footer_rights')}
+				value={config.messages.footer_rights()}
+			>
+				{#snippet children(text, attrs)}<span {...attrs}>{text}</span>{/snippet}
+			</Editable>
+		</p>
 	</div>
 </footer>
 

package/dist/components/layout/Footer.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { SiteLink } from '../../config/types.js';
+import type { EditDescriptor } from '../../edit/types.js';
 /**
  * The links are a prop rather than a package constant: the host app owns
  * its routes, and Nav and Footer render the same list — the foundation
@@ -6,6 +7,8 @@ import type { SiteLink } from '../../config/types.js';
  */
 interface Props {
     links: SiteLink[];
+    /** Edit descriptors for the link labels — see Nav. */
+    editFor?: (link: SiteLink) => EditDescriptor | undefined;
 }
 declare const Footer: import("svelte").Component<Props, {}, "">;
 type Footer = ReturnType<typeof Footer>;

package/dist/components/layout/Nav.svelte

@@ -1,6 +1,8 @@
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
 	import type { SiteLink } from '../../config/types.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
+	import type { EditDescriptor } from '../../edit/types.js';
 	import { isPathUnder } from '../../utils/paths.js';
 	import GhostButton from '../ui/GhostButton.svelte';
 	import Link from '../ui/Link.svelte';
@@ -16,9 +18,16 @@
 		account?: { displayName: string } | null;
 		/** The URL highlighting reads from. Only tests and stories pass one. */
 		url?: URL;
+		/**
+		 * Edit descriptors for the link LABELS — a function because the host
+		 * owns both the routes and the message keys behind them. While the
+		 * adapter is editing, a link with a descriptor renders as editable
+		 * text instead of an anchor (see ActionLabel).
+		 */
+		editFor?: (link: SiteLink) => EditDescriptor | undefined;
 	}
 
-	let { links, account = null, url = undefined }: Props = $props();
+	let { links, account = null, url = undefined, editFor = undefined }: Props = $props();
 
 	const config = getUiConfig();
 	const msg = $derived(config.messages);
@@ -77,9 +86,13 @@
 			<ul class="links">
 				{#each links as link (link.href)}
 					<li>
-						<Link href={link.href} aria-current={isCurrent(link.href) ? 'page' : undefined}>
-							{link.label}
-						</Link>
+						<ActionLabel edit={editFor?.(link)} value={link.label}>
+							{#snippet control()}
+								<Link href={link.href} aria-current={isCurrent(link.href) ? 'page' : undefined}>
+									{link.label}
+								</Link>
+							{/snippet}
+						</ActionLabel>
 					</li>
 				{/each}
 			</ul>

package/dist/components/layout/Nav.svelte.d.ts

@@ -1,4 +1,5 @@
 import type { SiteLink } from '../../config/types.js';
+import type { EditDescriptor } from '../../edit/types.js';
 interface Props {
     /**
      * Primary navigation entries. A prop rather than a package constant:
@@ -12,6 +13,13 @@ interface Props {
     } | null;
     /** The URL highlighting reads from. Only tests and stories pass one. */
     url?: URL;
+    /**
+     * Edit descriptors for the link LABELS — a function because the host
+     * owns both the routes and the message keys behind them. While the
+     * adapter is editing, a link with a descriptor renders as editable
+     * text instead of an anchor (see ActionLabel).
+     */
+    editFor?: (link: SiteLink) => EditDescriptor | undefined;
 }
 declare const Nav: import("svelte").Component<Props, {}, "">;
 type Nav = ReturnType<typeof Nav>;

package/dist/components/ui/Pagination.svelte

@@ -1,5 +1,6 @@
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
 	import Link from './Link.svelte';
 
 	/**
@@ -37,21 +38,32 @@
 
 {#if pages > 1 || isOutOfRange}
 	<nav class="pagination" aria-label={msg.pagination_label()}>
-		{#if hasPrevious}
-			<Link href={href(previousPage)} rel="prev">{msg.pagination_previous()}</Link>
-		{:else}
-			<span class="disabled">{msg.pagination_previous()}</span>
-		{/if}
+		<ActionLabel
+			edit={config.messageEdit?.('pagination_previous')}
+			value={msg.pagination_previous()}
+		>
+			{#snippet control()}
+				{#if hasPrevious}
+					<Link href={href(previousPage)} rel="prev">{msg.pagination_previous()}</Link>
+				{:else}
+					<span class="disabled">{msg.pagination_previous()}</span>
+				{/if}
+			{/snippet}
+		</ActionLabel>
 
 		<p class="status" aria-live="polite">
 			{msg.pagination_status({ page, pages })}
 		</p>
 
-		{#if hasNext}
-			<Link href={href(page + 1)} rel="next">{msg.pagination_next()}</Link>
-		{:else}
-			<span class="disabled">{msg.pagination_next()}</span>
-		{/if}
+		<ActionLabel edit={config.messageEdit?.('pagination_next')} value={msg.pagination_next()}>
+			{#snippet control()}
+				{#if hasNext}
+					<Link href={href(page + 1)} rel="next">{msg.pagination_next()}</Link>
+				{:else}
+					<span class="disabled">{msg.pagination_next()}</span>
+				{/if}
+			{/snippet}
+		</ActionLabel>
 	</nav>
 {/if}
 

package/dist/components/weeklies/CommentSection.svelte

@@ -10,6 +10,8 @@
 
 <script lang="ts">
 	import { getUiConfig } from '../../config/context.js';
+	import ActionLabel from '../../edit/ActionLabel.svelte';
+	import Editable from '../../edit/Editable.svelte';
 	import { COMMENT_BODY } from '../../forms/constraints.js';
 	import type { CommentData, CommentThreadData } from '../../content/types.js';
 	import Button from '../ui/Button.svelte';
@@ -67,10 +69,16 @@
 {/snippet}
 
 <section aria-labelledby="comments-heading">
-	<h2 class="subsection-heading" id="comments-heading">{msg.comments_title()}</h2>
+	<Editable edit={config.messageEdit?.('comments_title')} value={msg.comments_title()}>
+		{#snippet children(text, attrs)}
+			<h2 class="subsection-heading" id="comments-heading" {...attrs}>{text}</h2>
+		{/snippet}
+	</Editable>
 
 	{#if comments.length === 0}
-		<p class="empty">{msg.comments_empty()}</p>
+		<Editable edit={config.messageEdit?.('comments_empty')} value={msg.comments_empty()}>
+			{#snippet children(text, attrs)}<p class="empty" {...attrs}>{text}</p>{/snippet}
+		</Editable>
 	{:else}
 		<ul class="list">
 			{#each comments as thread (thread.id)}
@@ -111,9 +119,16 @@
 								<input {...reply.fields.weeklySlug.as('hidden', weeklySlug)} />
 								<input {...reply.fields.parentId.as('hidden', String(thread.id))} />
 								<div class="actions">
-									<Button type="submit" pending={reply.pending}>
-										{msg.comments_replySubmit()}
-									</Button>
+									<ActionLabel
+										edit={config.messageEdit?.('comments_replySubmit')}
+										value={msg.comments_replySubmit()}
+									>
+										{#snippet control()}
+											<Button type="submit" pending={reply.pending}>
+												{msg.comments_replySubmit()}
+											</Button>
+										{/snippet}
+									</ActionLabel>
 								</div>
 								<FormErrorFeedback result={reply.result} messages={errorMessages} />
 							</form>
@@ -141,14 +156,23 @@
 			<input {...main.fields.weeklySlug.as('hidden', weeklySlug)} />
 
 			<div class="actions">
-				<Button type="submit" pending={main.pending}>{msg.comments_submit()}</Button>
+				<ActionLabel edit={config.messageEdit?.('comments_submit')} value={msg.comments_submit()}>
+					{#snippet control()}
+						<Button type="submit" pending={main.pending}>{msg.comments_submit()}</Button>
+					{/snippet}
+				</ActionLabel>
 			</div>
 
 			<FormErrorFeedback result={main.result} messages={errorMessages} />
 		</form>
 	{:else}
 		<p class="login-prompt">
-			{msg.comments_loginPrompt()}
+			<Editable
+				edit={config.messageEdit?.('comments_loginPrompt')}
+				value={msg.comments_loginPrompt()}
+			>
+				{#snippet children(text, attrs)}<span {...attrs}>{text}</span>{/snippet}
+			</Editable>
 			<Link href="/login">{msg.comments_loginLink()}</Link>
 			·
 			<Link href="/signup">{msg.comments_signupLink()}</Link>

package/dist/config/context.js

@@ -37,7 +37,10 @@ export function setUiConfig(input) {
         },
         get messages() {
             return input().messages ?? defaultMessages;
-        }
+        },
+        // Undefined means inert: components render their message strings as
+        // plain text, which is every app but the CMS.
+        messageEdit: (key) => input().messageEdit?.(key)
     };
     return setContext(KEY, resolved);
 }

package/dist/config/types.d.ts

@@ -1,3 +1,4 @@
+import type { EditDescriptor } from '../edit/types.js';
 /**
  * The site's locales and their canonical member. Fixed rather than generic:
  * `ca` is load-bearing — it is the required key of every localized column
@@ -156,6 +157,14 @@ export interface UiConfig {
     /** Appended to document titles and shown as the wordmark. */
     siteName: string;
     messages: UiMessages;
+    /**
+     * Edit descriptor for one of THIS config's message strings, by catalog
+     * key — the interface-wording half of edit mode. Optional and undefined by
+     * default, so a read-only app (and every story/test) renders the messages
+     * as plain text. A CMS-shaped host supplies it alongside an EditAdapter;
+     * components offer only their parameterless, plain-text message sites.
+     */
+    messageEdit?: (key: string) => EditDescriptor | undefined;
 }
 /** What an app hands UiProvider: any subset; the rest keeps package defaults. */
 export interface UiConfigInput {
@@ -166,4 +175,5 @@ export interface UiConfigInput {
     canonicalPathname?: UiConfig['canonicalPathname'];
     siteName?: string;
     messages?: UiMessages;
+    messageEdit?: UiConfig['messageEdit'];
 }

package/dist/edit/ActionLabel.svelte

@@ -0,0 +1,45 @@
+<script lang="ts">
+	import type { Snippet } from 'svelte';
+	import { getEditAdapter } from './context.js';
+	import Editable from './Editable.svelte';
+	import type { EditDescriptor } from './types.js';
+
+	/**
+	 * The label of an INTERACTIVE control — a button, a nav link — made
+	 * editable the way WeeklieCard's title is: while the adapter is editing
+	 * and a descriptor is supplied, the control is REPLACED by its label as
+	 * editable text, because a caret inside a live control would activate it
+	 * (a link navigates mid-draft, a label focuses its input). The control
+	 * comes back the moment editing turns off; with no descriptor or no
+	 * adapter it renders untouched, byte-identical to a read-only build.
+	 */
+	interface Props {
+		/** Undefined leaves the control alone — the inert default. */
+		edit: EditDescriptor | undefined;
+		/** The label text the control renders. */
+		value: string;
+		/** The real control, rendered whenever the label is not being edited. */
+		control: Snippet;
+	}
+
+	let { edit, value, control }: Props = $props();
+
+	const adapter = getEditAdapter();
+	const editing = $derived(edit !== undefined && (adapter?.isEditing ?? false));
+</script>
+
+{#if editing}
+	<Editable {edit} {value}>
+		{#snippet children(text, attrs)}<span class="action-label" {...attrs}>{text}</span>{/snippet}
+	</Editable>
+{:else}
+	{@render control()}
+{/if}
+
+<style>
+	/* Roughly the control's footprint, so the swap doesn't collapse the row. */
+	.action-label {
+		display: inline-block;
+		padding: 0.2em 0.4em;
+	}
+</style>

package/dist/edit/ActionLabel.svelte.d.ts

@@ -0,0 +1,22 @@
+import type { Snippet } from 'svelte';
+import type { EditDescriptor } from './types.js';
+/**
+ * The label of an INTERACTIVE control — a button, a nav link — made
+ * editable the way WeeklieCard's title is: while the adapter is editing
+ * and a descriptor is supplied, the control is REPLACED by its label as
+ * editable text, because a caret inside a live control would activate it
+ * (a link navigates mid-draft, a label focuses its input). The control
+ * comes back the moment editing turns off; with no descriptor or no
+ * adapter it renders untouched, byte-identical to a read-only build.
+ */
+interface Props {
+    /** Undefined leaves the control alone — the inert default. */
+    edit: EditDescriptor | undefined;
+    /** The label text the control renders. */
+    value: string;
+    /** The real control, rendered whenever the label is not being edited. */
+    control: Snippet;
+}
+declare const ActionLabel: import("svelte").Component<Props, {}, "">;
+type ActionLabel = ReturnType<typeof ActionLabel>;
+export default ActionLabel;

package/dist/edit/helpers.d.ts

@@ -1,5 +1,14 @@
 import type { Locale } from '../config/types.js';
 import type { EditableEntity, EditDescriptor } from './types.js';
+/**
+ * Descriptor for one interface-wording message (a Paraglide catalog key).
+ * Only parameterless messages are sensibly editable in place — editing the
+ * RENDERED text of a parameterized one would overwrite its template.
+ */
+export declare function chromeEdit(key: string, locale: Locale, options?: {
+    format?: EditDescriptor['format'];
+    label?: string;
+}): EditDescriptor;
 /** Descriptor for one page-copy block (`page_content` row). */
 export declare function pageCopyEdit(page: string, sectionKey: string, locale: Locale, options?: {
     format?: EditDescriptor['format'];

package/dist/edit/helpers.js

@@ -1,3 +1,11 @@
+/**
+ * Descriptor for one interface-wording message (a Paraglide catalog key).
+ * Only parameterless messages are sensibly editable in place — editing the
+ * RENDERED text of a parameterized one would overwrite its template.
+ */
+export function chromeEdit(key, locale, options) {
+    return { ref: { kind: 'chrome', key }, locale, ...options };
+}
 /** Descriptor for one page-copy block (`page_content` row). */
 export function pageCopyEdit(page, sectionKey, locale, options) {
     return { ref: { kind: 'page-copy', page, sectionKey }, locale, ...options };

package/dist/edit/index.d.ts

@@ -1,5 +1,6 @@
 export { getEditAdapter, setEditAdapter } from './context.js';
+export { default as ActionLabel } from './ActionLabel.svelte';
 export { default as Editable } from './Editable.svelte';
-export { entityEdit, pageCopyEdit } from './helpers.js';
+export { chromeEdit, entityEdit, pageCopyEdit } from './helpers.js';
 export { localize } from './types.js';
 export type { ContentRef, EditableEntity, EditAdapter, EditDescriptor, LocalizedText } from './types.js';

package/dist/edit/index.js

@@ -1,4 +1,5 @@
 export { getEditAdapter, setEditAdapter } from './context.js';
+export { default as ActionLabel } from './ActionLabel.svelte';
 export { default as Editable } from './Editable.svelte';
-export { entityEdit, pageCopyEdit } from './helpers.js';
+export { chromeEdit, entityEdit, pageCopyEdit } from './helpers.js';
 export { localize } from './types.js';

package/dist/edit/types.d.ts

@@ -17,8 +17,12 @@ export declare function localize(value: LocalizedText, locale: Locale): string;
  */
 export type EditableEntity = 'weeklies' | 'projects' | 'milestones' | 'team_members' | 'job_openings';
 /**
- * The identity of one editable string in the content model: either a page
- * copy block (`page_content` row) or one localized field of a domain entity.
+ * The identity of one editable string in the content model: a page copy
+ * block (`page_content` row), one localized field of a domain entity, or one
+ * interface-wording message (`chrome`) — a Paraglide catalog key. What a
+ * chrome save MEANS is the host's decision, like every other ref: the
+ * foundation CMS writes the website's `ui_messages` table, from which the
+ * catalogs are regenerated at deploy.
  */
 export type ContentRef = {
     kind: 'page-copy';
@@ -29,6 +33,9 @@ export type ContentRef = {
     entity: EditableEntity;
     id: string | number;
     field: string;
+} | {
+    kind: 'chrome';
+    key: string;
 };
 /** What a component hands the adapter alongside the new value. */
 export interface EditDescriptor {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@vit-foundation/ui",
-	"version": "0.3.0",
+	"version": "0.7.0",
 	"scripts": {
 		"dev": "vite dev",
 		"build": "vite build && npm run prepack",
@@ -122,7 +122,7 @@
 		"svelte"
 	],
 	"license": "MIT",
-	"description": "Fundaci\u00f3 VIT's shared Svelte 5 component library with pluggable edit mode",
+	"description": "Fundació VIT's shared Svelte 5 component library with pluggable edit mode",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/fndvit/VizVit-UI.git"