nikon/docsearch
1
0
Fork 0
Code Activity Actions
docsearch/packages/docsearch-css/RELEASE_NOTES.md

4.9 KiB
Raw Permalink Blame History

Major Changes

  • ecd905d: # DocSearch v5-beta

    DocSearch v5 is a major release that introduces AI-powered answers via Agent Studio, a refreshed search UI, and a modernized package architecture.

    Ask AI & Agent Studio

    • Agent Studio integration with core tools and dynamic tool calls
    • Conversation memory support
    • Compatibility with the Algolia MCP search tool, with aggregated MCP search tool calls
    • Dynamic index selection for Agent Studio
    • Feedback integration, including feedback notes and tags
    • Prompt suggestions in keyword search and follow-up prompt suggestions
    • Ask AI modal split into its own component and Ask AI transport layer removed

    Search UI

    • Refreshed v5 UI with improved dark theme, sources panel, and accessibility
    • Faceted search with filter chips
    • Hit breadcrumbs and result badges

    Packaging & architecture

    • New @docsearch/cli package for MCP setup and search
    • MCP plugin support
    • Split JS bundles for search-only usage and JS-based hybrid mode
    • Migrated the build system to tsdown
    • Migrated CSS building to LightningCSS

    Breaking changes

    • Ask AI related props are now nested under a single root askai option
    • The Ask AI transport layer has been removed

Patch Changes

  • ecd905d: feat(v5): General UI styling updates and fixes

    • New --docsearch-font-family variable, used by the search button, keyboard keys, modal, and sidepanel. It replaces the system font stacks that were duplicated across sidepanel.css and button.css, so overriding one variable now themes every DocSearch surface
    • The search input and modal heading are 1rem at every breakpoint (previously 0.875rem with a mobile-only override)
    • .DocSearch-Title uses line-height: 1.5em instead of 0.5em and adds overflow-wrap: anywhere, so long titles wrap instead of overlapping (#2908)
    • Hit icon svg sizing moved into .DocSearch-Hit-icon. The .DocSearch-Hit-icon--small modifier is replaced by .DocSearch-Hit-icon--start, which top-aligns the icon; recent conversations use it
    • The Ask AI button icon centers with display: inline-flex instead of margin-block-start/align-self overrides
    • Removed the 2px offset on the Ask AI sources action text
    • SourcesPanel accepts pluralTitleText. titleText is now the singular label, and the trigger renders {count} {label}
    • AskAiScreenTranslations and ConversationScreenTranslations expose relatedSourcesTextPlural
    • Docusaurus adapter: theme.SearchModal.askAiScreen.relatedSourcesText is now the singular "Source", and the new theme.SearchModal.askAiScreen.relatedSourcesTextPlural provides "Sources"

  • ecd905d: Surface Agent Studio cost-control errors and block prompts until the user can recover. #2878

  • ecd905d: Stop over-truncating mobile snippets and allow long search hits to wrap.

  • ecd905d: fix(askai): Ask AI fixes for v5

    • getMessageContent now joins every assistant text part instead of stopping at the first one, so copying an answer that interleaves text with tool calls returns the complete response (#2782)
    • Key Ask AI conversation storage by appId instead of indexName, fixes triggering a new conversation in hybrid mode
    • Negative feedback panel is labelled with aria-labelledby and reason chips expose selection via aria-pressed (styling moved off the --selected modifier)
    • Popover.Trigger forwards refs, fixes sources panel not showing in some cases
    • Add --docsearch-error-soft-color, --docsearch-error-text-color, and --docsearch-code-block-background variables; restyle the Ask AI error panel and markdown code blocks to use them

  • ecd905d: feat(v5): add customizable footer action

    • New footerAction prop renders a custom action in the modal footer, before the Algolia logo, inside .DocSearch-Footer-Action
    • @docsearch/js supports footerAction via template patterns (html helper, JSX, or function-based)
    • Fixes typing differences between @docsearch/react and @docsearch/js
    • Restyle the footer with a .DocSearch-Footer-Actions wrapper

  • ecd905d: Align CSS class and animation names with the DocSearch- naming convention.

    • The shimmer utility class is now DocSearch-shimmer
    • Fixed a typo in DocSearck-AskAiScreen-MessageContent-Stopped, now DocSearch-AskAiScreen-MessageContent-Stopped
    • Keyframes renamed to kebab-case: shimmerText → shimmer-text, slideDown → slide-down, fadeIn → fade-in
    • Dark theme selectors use :root[data-theme='dark'] instead of html[data-theme='dark']
    • Dropped redundant type qualifiers from .DocSearch-Hits-padded and .DocSearch-Hit-Select-Icon selectors, slightly lowering their specificity

    If you override these classes or keyframes in custom styles, update your selectors accordingly.