@ciderpress/ui 1.0.0-rc.1 → 1.0.0-rc.11

package/dist/theme/components/theme-provider.tsx

@@ -11,6 +11,8 @@ declare const __CIDERPRESS_DEFAULT_VARIANT__: string
 declare const __CIDERPRESS_THEME_COLORS__: string
 declare const __CIDERPRESS_THEME_DARK_COLORS__: string
 declare const __CIDERPRESS_THEME_REGISTRY__: string
+declare const __CIDERPRESS_HAS_USER_FAVICON__: boolean
+declare const __CIDERPRESS_LOADER_MIN_MS__: number
 
 interface RegistryEntry {
   readonly name: string
@@ -26,7 +28,7 @@ type ThemeColorKey = keyof ThemeColors
 
 /**
  * Parsed theme registry — built-in themes plus any user themes from
- * `config.themes`. Read from the build-time define so the client bundle
+ * `theme.themes`. Read from the build-time define so the client bundle
  * does not pull `@ciderpress/theme`'s factory + Zod into the runtime path.
  */
 const REGISTRY_ENTRIES: readonly RegistryEntry[] = parseRegistry(__CIDERPRESS_THEME_REGISTRY__)
@@ -123,9 +125,11 @@ const COLOR_VAR_MAP: Readonly<Record<ThemeColorKey, readonly string[]>> = Object
 const ALL_CSS_VARS: readonly string[] = Object.values(COLOR_VAR_MAP).flat()
 
 /**
- * Minimum time (ms) the loading overlay stays visible before fading out.
+ * Minimum time (ms) the loading overlay stays visible before fading
+ * out. Resolved at build time from `brand.loader.minDisplayMs` —
+ * defaults to 150ms in `packages/ui/src/config.ts`.
  */
-const LOADER_MIN_DISPLAY_MS = 150
+const LOADER_MIN_DISPLAY_MS = __CIDERPRESS_LOADER_MIN_MS__
 
 /**
  * Duration (ms) of the CSS fade-out transition. Must match the
@@ -199,12 +203,14 @@ export function ThemeProvider(): React.ReactElement | null {
       applyColorOverrides(html, darkColors)
     }
 
-    // Sync the document favicon with the active theme's brand colour.
-    // Browsers cache static icon assets and ignore CSS, so the only way to
-    // keep the tab mark in lockstep with the chosen theme is to swap
-    // `<link rel="icon">` to a data-URI SVG carrying the resolved
-    // `--cp-c-brand-1`.
-    syncThemeFavicon(html)
+    // Sync the document favicon with the active theme's brand colour —
+    // only when the user has NOT set their own `favicon` in config. When
+    // they have, Rspress already points `<link rel="icon">` at the
+    // user's asset, and overwriting it with the themed apple data-URI
+    // would silently restore ciderpress branding.
+    if (!__CIDERPRESS_HAS_USER_FAVICON__) {
+      syncThemeFavicon(html)
+    }
 
     // Observe `.rp-dark` class changes so Rspress's built-in dark toggle
     // stays the single source of truth for variant flips. The new variant
@@ -253,8 +259,11 @@ export function ThemeProvider(): React.ReactElement | null {
       }
       // Re-sync the favicon — brand colour is constant across variants for
       // built-in themes, but surface overrides on the dark variant can
-      // affect the chip background colour we bake into the SVG.
-      syncThemeFavicon(html)
+      // affect the chip background colour we bake into the SVG. Skipped
+      // when the user supplied their own favicon (see initial sync above).
+      if (!__CIDERPRESS_HAS_USER_FAVICON__) {
+        syncThemeFavicon(html)
+      }
     })
     observer.observe(html, { attributes: true, attributeFilter: ['class'] })
 
@@ -628,6 +637,13 @@ function dismissLoader(html: HTMLElement): () => void {
     clearDotsInterval()
   }, LOADER_MIN_DISPLAY_MS + LOADER_FADE_MS)
 
+  // The forced-dismiss fallback (covering the case where React never
+  // hydrates) lives in the inline head script — see `buildHeadScriptBody`
+  // in `packages/ui/src/config.ts`. That timer always runs, so a
+  // duplicate React-side fallback here would only fire AFTER ThemeProvider
+  // has already mounted — at which point the normal fade path above has
+  // already won.
+
   return () => {
     clearTimeout(fadeTimer)
     clearTimeout(removeTimer)

package/dist/theme/components/workspaces/card.css

@@ -69,6 +69,10 @@
   font-size: 15px;
   font-weight: 700;
   color: var(--cp-c-text-1);
+  /* Presentational lowercase. Done here rather than in JS because the
+     title may carry inline markup — lowercasing the source would also
+     lowercase link targets and class names inside it. */
+  text-transform: lowercase;
 }
 
 .cp-workspace-card__desc {

package/dist/theme/components/workspaces/card.tsx

@@ -1,8 +1,10 @@
 import { match, P } from 'massaman/match'
 import type React from 'react'
 
+import { renderRichText } from '../../lib/rich-text.tsx'
 import { Card } from '../shared/card'
-import { Icon } from '../shared/icon'
+import { CardIcon } from '../shared/card-icon'
+import type { CardIconInput } from '../shared/resolve-card-icon'
 import { resolveCardIcon } from '../shared/resolve-card-icon'
 import { TechTag } from '../shared/tech-tag'
 
@@ -16,9 +18,10 @@ export interface WorkspaceCardProps {
    */
   readonly href: string
   /**
-   * Icon config — Iconify identifier string or `{ id, color }` object.
+   * Icon config — Iconify identifier string, `{ id, color }` object, or
+   * `{ kind: 'image', src, alt }` for a static image asset.
    */
-  readonly icon?: string | { readonly id: string; readonly color: string }
+  readonly icon?: CardIconInput
   /**
    * Scope prefix shown above the name (e.g. "apps/").
    */
@@ -63,17 +66,12 @@ export function WorkspaceCard({
   titleLines,
   descriptionLines,
 }: WorkspaceCardProps): React.ReactElement {
-  const name = title.toLowerCase()
   const resolved = resolveCardIcon(icon)
 
   const iconEl = match(resolved)
-    .with(P.nonNullable, (r) => <Icon icon={r.id} />)
+    .with(P.nonNullable, (r) => <CardIcon resolved={r} className="cp-card__icon" />)
     .otherwise(() => null)
 
-  const iconColor = match(resolved)
-    .with(P.nonNullable, (r) => r.color)
-    .otherwise(() => 'purple')
-
   const scopeEl = match(scope)
     .with(
       P.when((s): s is string => s !== undefined && s.length > 0),
@@ -95,7 +93,7 @@ export function WorkspaceCard({
         className={clampClass('cp-workspace-card__desc', descriptionLines)}
         style={clampStyle(descriptionLines)}
       >
-        {d}
+        {renderRichText(d)}
       </span>
     ))
     .otherwise(() => null)
@@ -117,14 +115,14 @@ export function WorkspaceCard({
     <Card href={href} className="cp-workspace-card">
       <div className="cp-workspace-card__header">
         <div className="cp-workspace-card__identity">
-          <span className={`cp-card__icon cp-card__icon--${iconColor}`}>{iconEl}</span>
+          {iconEl}
           <div className="cp-workspace-card__title">
             {scopeEl}
             <span
               className={clampClass('cp-workspace-card__name', titleLines)}
               style={clampStyle(titleLines)}
             >
-              {name}
+              {renderRichText(title)}
             </span>
           </div>
         </div>

package/dist/theme/components/workspaces/grid.tsx

@@ -1,16 +1,21 @@
+import { match, P } from 'massaman/match'
 import type React from 'react'
 
+import { renderRichText } from '../../lib/rich-text.tsx'
+
 import './card.css'
 
 export interface WorkspaceGridProps {
   /**
-   * Section heading (e.g. "Apps", "Packages").
+   * Section heading (e.g. "Apps", "Packages"). Omitted for an ungrouped
+   * grid, such as a showcase block with an explicit `source` list.
    */
-  readonly heading: string
+  readonly heading?: string
   /**
-   * Brief description rendered below the heading.
+   * Brief description rendered below the heading. Omitted for an
+   * ungrouped grid.
    */
-  readonly description: string
+  readonly description?: string
   /**
    * Number of grid columns.
    */
@@ -38,8 +43,15 @@ export function WorkspaceGrid({
 
   return (
     <>
-      <h2>{heading}</h2>
-      <p className="cp-workspace-section__desc">{description}</p>
+      {/* Rich text, matching the card titles and descriptions this grid
+          wraps — a group heading was the one string in the block that
+          showed its `**markers**` literally. */}
+      {match(heading)
+        .with(P.string, (h) => <h2>{renderRichText(h)}</h2>)
+        .otherwise(() => null)}
+      {match(description)
+        .with(P.string, (d) => <p className="cp-workspace-section__desc">{renderRichText(d)}</p>)
+        .otherwise(() => null)}
       <div className="cp-workspace-grid" style={style}>
         {children}
       </div>

package/dist/theme/hooks/use-ciderpress.ts

@@ -1,17 +1,17 @@
-import type { FooterConfig, HomeConfig, SiteConfig } from '@ciderpress/config'
+import type { BadgeConfig, FooterConfig, HomeConfig, SerializedIcon } from '@ciderpress/config'
 import { useSite } from '@rspress/core/runtime'
 
 export interface CiderpressSidebarItem {
   readonly text?: string
   readonly link?: string
-  readonly icon?: string
+  readonly icon?: SerializedIcon
   readonly items?: readonly CiderpressSidebarItem[]
 }
 
 export interface CiderpressSidebarLink {
   readonly text: string
   readonly link: string
-  readonly icon?: string | { readonly id: string; readonly color: string }
+  readonly icon?: SerializedIcon
   readonly style?: 'brand' | 'alt' | 'ghost'
   readonly shape?: 'square' | 'rounded' | 'circle'
 }
@@ -19,7 +19,7 @@ export interface CiderpressSidebarLink {
 export interface WorkspaceCardData {
   readonly title: string
   readonly href: string
-  readonly icon: string | { readonly id: string; readonly color: string } | undefined
+  readonly icon: SerializedIcon | undefined
   readonly scope: string | undefined
   readonly description: string | undefined
   readonly tags: readonly string[]
@@ -33,6 +33,65 @@ export interface WorkspaceGroupData {
   readonly cards: readonly WorkspaceCardData[]
 }
 
+/**
+ * Serialised view of the unified `CiderpressConfig` that the runtime
+ * theme components still read through. The `site` field is rebuilt in
+ * `packages/ui/src/config.ts` (`buildSiteBlock`) from the new top-level
+ * `editLink` / `reportLink` / `topbar` / `sidebar` / `footer` / `version`
+ * config — kept under the legacy `site.*` name so theme components don't
+ * need to be rewired to look up each field individually.
+ */
+export interface CiderpressSiteBlock {
+  readonly version: string | undefined
+  readonly edit:
+    | {
+        readonly repo: string
+        readonly branch?: string
+        readonly directory?: string
+        readonly label?: string
+      }
+    | undefined
+  readonly report:
+    | {
+        readonly repo: string
+        readonly branch?: string
+        readonly directory?: string
+        readonly label?: string
+      }
+    | undefined
+  readonly topbarCta: { readonly text: string; readonly href: string } | undefined
+  readonly sidebarPromo:
+    | {
+        readonly title: string
+        readonly body: string
+        readonly cta: { readonly text: string; readonly href: string }
+      }
+    | undefined
+  readonly announcement:
+    | {
+        readonly id?: string
+        readonly lead?: string
+        readonly message: string
+        readonly cta?: { readonly href: string; readonly label: string }
+        readonly persistent?: boolean
+      }
+    | undefined
+  readonly footer:
+    | {
+        readonly columns?: readonly {
+          readonly heading: string
+          readonly links: readonly { readonly text: string; readonly href: string }[]
+        }[]
+        readonly tagline?: string
+        readonly brandMark?: string
+      }
+    | undefined
+  readonly feedback: {
+    readonly enabled: boolean
+    readonly question: string | undefined
+  }
+}
+
 interface CiderpressThemeConfig {
   readonly sidebar: Record<string, readonly CiderpressSidebarItem[]>
   readonly sidebarAbove: readonly CiderpressSidebarLink[] | undefined
@@ -41,7 +100,8 @@ interface CiderpressThemeConfig {
   readonly standaloneScopePaths: readonly string[] | undefined
   readonly home: HomeConfig | undefined
   readonly ciderpressFooter: FooterConfig | undefined
-  readonly site: SiteConfig | undefined
+  readonly site: CiderpressSiteBlock | undefined
+  readonly pageBadges: Record<string, readonly BadgeConfig[]> | undefined
 }
 
 /**

package/dist/theme/hooks/use-nav-items.ts

@@ -1,3 +1,4 @@
+import { removeBase } from '@rspress/core/runtime'
 import { useEffect, useState } from 'react'
 
 import type { CiderpressNavMenuItem } from '../components/nav/ciderpress-nav-menu'
@@ -41,34 +42,104 @@ export function useNavItems(): readonly CiderpressNavMenuItem[] {
 }
 
 /**
- * Read every anchor under Rspress's hidden `.rp-nav-menu` and project
- * it into a `{ text, link }` item. Anchors with empty text or `href`
- * are dropped so we never surface a placeholder entry.
+ * Reconstruct the primary nav from Rspress's hidden `.rp-nav-menu`,
+ * preserving dropdowns. Each top-level `.rp-nav-menu__item` is either a
+ * leaf (its container is an anchor) or a dropdown parent (it wraps a
+ * `.rp-hover-group` of child links). Items with empty text, or dropdown
+ * parents with no usable children, are dropped.
  *
  * @private
  * @returns Nav items currently in the DOM (empty array when not mounted).
  */
 function scrapeNavItems(): readonly CiderpressNavMenuItem[] {
-  const anchors = document.querySelectorAll<HTMLAnchorElement>('.rp-nav-menu .rp-nav-menu__item a')
+  return navMenuRoots()
+    .map(scrapeNavItem)
+    .filter((item): item is CiderpressNavMenuItem => item !== null)
+}
+
+/**
+ * Collect the top-level `.rp-nav-menu__item` `<li>`s to scrape. Rspress
+ * renders separate left and right nav `<ul>`s; the ciderpress topbar is
+ * right-aligned, so we read the right menu and only fall back to the
+ * unscoped selector when it isn't present.
+ *
+ * @private
+ * @returns Top-level nav item elements.
+ */
+function navMenuRoots(): readonly HTMLElement[] {
+  const right = document.querySelectorAll<HTMLElement>('.rp-nav-menu--right > .rp-nav-menu__item')
+  if (right.length > 0) {
+    return [...right]
+  }
+  return [...document.querySelectorAll<HTMLElement>('.rp-nav-menu > .rp-nav-menu__item')]
+}
+
+/**
+ * Project a single top-level `.rp-nav-menu__item` element into a nav
+ * item, recursing one level into its `.rp-hover-group` dropdown when
+ * present.
+ *
+ * @private
+ * @param root - Top-level nav `<li>` element.
+ * @returns Parsed nav item, or `null` when unusable.
+ */
+function scrapeNavItem(root: HTMLElement): CiderpressNavMenuItem | null {
+  const container = root.querySelector(':scope > .rp-nav-menu__item__container')
+  if (container === null) {
+    return null
+  }
+  const text = readElementText(container)
+  if (text === '') {
+    return null
+  }
+  const group = root.querySelector(':scope > .rp-hover-group')
+  if (group !== null) {
+    const items = scrapeGroupItems(group)
+    if (items.length === 0) {
+      return null
+    }
+    return { text, items }
+  }
+  const href = container.getAttribute('href')
+  if (href === null || href === '') {
+    return null
+  }
+  // Un-base the scraped href so `<Link>` re-applies the site `base` once
+  // rather than doubling the mount prefix on subpath deploys.
+  return { text, link: removeBase(href) }
+}
+
+/**
+ * Read the child links out of a Rspress `.rp-hover-group` dropdown.
+ *
+ * @private
+ * @param group - The `.rp-hover-group` element.
+ * @returns Child nav items with text + link (empties dropped).
+ */
+function scrapeGroupItems(group: Element): readonly CiderpressNavMenuItem[] {
+  const anchors = group.querySelectorAll<HTMLAnchorElement>('.rp-hover-group__item__link')
   return [...anchors]
     .map((anchor) => ({
-      text: readAnchorText(anchor),
-      link: anchor.getAttribute('href') ?? '',
+      text: readElementText(anchor),
+      // Rspress's rendered hrefs already include the site `base`; strip it so
+      // the consuming `<Link>` re-applies it once instead of doubling the mount
+      // prefix on subpath deploys (the `/examples/<slug>/examples/<slug>/…` 404).
+      link: removeBase(anchor.getAttribute('href') ?? ''),
     }))
     .filter((item) => item.text !== '' && item.link !== '')
 }
 
 /**
- * Pull the trimmed text content from an anchor. Returns an empty
+ * Pull the trimmed text content from an element. Returns an empty
  * string when `textContent` is missing — callers treat empty as "skip
- * this anchor".
+ * this element".
  *
  * @private
- * @param anchor - Anchor element to read.
+ * @param element - Element to read.
  * @returns Trimmed inner text, or empty string when absent.
  */
-function readAnchorText(anchor: HTMLAnchorElement): string {
-  const text = anchor.textContent
+function readElementText(element: Element): string {
+  const text = element.textContent
   if (text === null) {
     return ''
   }

package/dist/theme/index.tsx

@@ -19,11 +19,11 @@ import '@rspress/core/dist/theme/components/Sidebar/SidebarDivider.css'
 import '@rspress/core/dist/theme/components/Sidebar/SidebarGroup.css'
 import '@rspress/core/dist/theme/components/Sidebar/SidebarItem.css'
 import '@rspress/core/dist/theme/components/Sidebar/SidebarSectionHeader.css'
-
 import './styles/layers.css'
 import './styles/overrides/fonts.css'
 import './styles/overrides/tokens.css'
 import './styles/overrides/rspress.css'
+import './styles/rich-text.css'
 // Theme color palettes — scoped via [data-cp-theme][data-cp-variant] selectors.
 // `mulled.css` ships first because it is `DEFAULT_THEME_NAME` — its rules emit
 // the `:root { ... }` FOUC fallback that paints before JS hydrates the
@@ -39,6 +39,8 @@ import './styles/themes/arcade.css'
 // (border trace, neon pulse, CRT scanlines, etc.) scoped to [data-cp-theme='arcade']
 import './styles/themes/arcade-fx.css'
 import './styles/overrides/details.css'
+import './styles/overrides/lists.css'
+import './styles/overrides/footnotes.css'
 import './styles/overrides/scrollbar.css'
 import './styles/overrides/rail.css'
 import './styles/overrides/sidebar.css'
@@ -54,6 +56,7 @@ import './components/content-footer/feedback.css'
 import './components/content-footer/meta-actions.css'
 import './components/content-footer/page-pager.css'
 import './components/sidebar/framework-picker.css'
+import './components/sidebar/sidebar-badge.css'
 import './components/sidebar/sidebar-promo.css'
 import './components/sidebar/sidebar-toggle.css'
 import './components/home/page-rail.css'
@@ -90,6 +93,8 @@ export { HomeFeature } from './components/home/feature'
 export { HomeLayout } from './components/home/layout'
 /** @internal Sidebar override — multi-scope filtering for standalone sections */
 export { Sidebar } from './components/sidebar/sidebar-scope'
+/** @internal Tag override — renders ciderpress sidebar badges, delegates other tags to Rspress */
+export { Tag } from './components/sidebar/sidebar-badge'
 
 export { FeatureCard, FeatureGrid } from './components/home/feature-card'
 export type { FeatureCardProps, FeatureItem } from './components/home/feature-card'
@@ -102,6 +107,10 @@ export { TrustStrip } from './components/home/trust-strip'
 export type { TrustStripProps } from './components/home/trust-strip'
 export { HomeSplit } from './components/home/split'
 export type { SplitProps, SplitAction } from './components/home/split'
+export { HomeTabs } from './components/home/tabs'
+export { RichText, renderRichText } from './lib/rich-text.tsx'
+export { hasAccentMarker, toPlainText } from './lib/rich-text-parse.ts'
+export type { HomeTabsProps, HomeTabEntry, TabsAction } from './components/home/tabs'
 export { CTA } from './components/home/cta'
 export type { CTAProps } from './components/home/cta'
 export { WorkspaceCard } from './components/workspaces/card'
@@ -150,8 +159,6 @@ export type { StepsProps, StepProps } from './components/shared/steps'
 export { Field, FieldGroup } from './components/shared/field'
 export type { FieldProps, FieldGroupProps } from './components/shared/field'
 
-export { CopyMarkdownButton } from './components/openapi'
-export type { CopyMarkdownButtonProps } from './components/openapi'
 export { OpenAPIOperation } from './components/openapi'
 export type { OpenAPIOperationProps } from './components/openapi'
 export { OpenAPIOverview } from './components/openapi'

package/dist/theme/lib/read-social-links.ts

@@ -2,8 +2,9 @@ import type { CiderpressSocialLink } from '../components/nav/ciderpress-nav-soci
 
 /**
  * Pull social-link entries (GitHub, npm, etc) from Rspress's `site`
- * shape. Lives on `site.themeConfig.socialLinks` after Rspress
- * normalisation but isn't surfaced on the public typings.
+ * shape. Lives on `site.themeConfig.socialLinks` after the
+ * `packages/ui/src/config.ts` serialiser writes the unified `socials`
+ * config into the runtime theme config.
  *
  * @param site - Rspress site data (typically the result of `useSite().site`)
  * @returns Array of social-link entries (empty array when not configured)
@@ -22,6 +23,6 @@ export function readSocialLinks(site: unknown): readonly CiderpressSocialLink[]
       typeof item === 'object' &&
       item !== null &&
       typeof (item as { icon?: unknown }).icon === 'string' &&
-      typeof (item as { content?: unknown }).content === 'string'
+      typeof (item as { url?: unknown }).url === 'string'
   )
 }