@qui/mdx-docs

Highlights

• breaking (useMdxDocsContext): remove UniqueIdService from the MdxDocsContextValue interface
• breaking (TypeDocProps): replace QuiPropTypes with PagePropTypes and remove use of UniqueIdService
• breaking (TypedocPropsList): change props type from Array of QuiPropDeclaration with id to PagePropType
• breaking (UsePropsContext): change PropsContextValue type from QuiPropTypes to PageDocProps
• feat (Root): remove context dependency on UniqueIdService from the Root component
• feat (doc-props-indexer): doc props id's are now generated on the mdx-vite backend to fix collisions with heading elements
• feat (TypeDocProps): add support for PagePropTypes and PagePropType from @qui/mdx-docs-common

Highlights

• feat (CodeDemo): Add props: className, topBar, and wrapperElementProps.
• feat (CodeDemo): Exported CodeDemoProps interface.
• feat (TypedocPropsList): Add suppressHydrationWarning to the div element to suppress hydration related warnings.
• feat (TypedocPropsTable): Add suppressHydrationWarning to the span element to suppress hydration related warnings.
• feat (PropName): Add suppressHydrationWarning to the Link component to suppress hydration related warnings.
• fix (CodeDemo): demos are now clamped to the width of their container.

Highlights

• breaking (DocsLayout): the individual layout elements like the sidebar, breadcrumbs, etc., have been moved to a composite component pattern under the Layout const. These elements are no longer exported individually. These individual components were not documented, so most consumers shouldn't see any breaking changes.
• feat (DocsLayout): the layout is now composable, and each element is easier to consume and customize.
• feat (DocsLayout): added Layout const with members: AppContent, Breadcrumbs, ContentWrapper, Footer, MainContent, PageLinks, Root, Sidebar, and TableOfContents.

Highlights

• fix (SiteSearchMobile): removed leftover tailwind classes with named CSS classes.

Highlights

• feat (SiteSearch): improved the sliding window algorithm used to match highlighted text in the search results.

Highlights

• feat (NpmInstallTabs): added a simple component that shows an install command in each available package manager (npm, yarn, pnpm). The user's selection is stored in the docs global context.
• feat (ssrUserAgent): consumers can now pass this prop to the DocsLayout component for more accurate initial rendering in some contexts.

Highlights

• feat (PropDescription): added class method argument comment rendering for @param tags, including nested interfaces.

Highlights

• feat (PropDescription): added function argument comment rendering from @param tags.

Highlights

• (forwardRef): Removed last remaining forwardRef instances.

Highlights

Highlights

• breaking (React): the minimum required version is now 19.
• chore (refs): removed all instances of forwardRef in favor of the new ref prop.

Highlights

• breaking (TypeDocProps): replace QuiReactPropTypes with QuiPropTypes to align with changes in the root package.

Highlights

• feat (MdxProvider): added mdx class to sup element.
• fix (Mdx): footnote links now account for the fixed header.

Highlights

• fix (TypeDocProps): added responsive CSS fixes for sites that don't have TailwindCSS configured.

Highlights

• fix (CodeHighlight): fixed key props spreading for upcoming React 19 compat.
• fix (DocsLayout): adjusted side nav CSS to fix a rare height issue.
• fix (MdxJs): fixed type import.

Highlights

• feat (TypeDocProps): Support passing changelogPathname to component to override @since tag pathname.
• feat (PropName): Adjusted changelog URL formatting and added conditional rendering for @since tag based on changelogPathname presence.

Highlights

• fix (DocsLayout): The ToC now takes up slightly more horizontal space at larger breakpoints.
• fix (Mdx): Increase top margin for list items and sub-lists for better readability.

Highlights

• fix (useSiteContext): no longer throws an error when site context is not found. Instead, empty values are returned. This was clashing with Remix's HMR, so it has been adjusted.

Highlights

• feat (MDX): Added support for the banned property on code fences. This property is used to indicate that an example should not be followed.

Highlights

• feat (SideNav): added support for spreading additional QSideNavigationItem props to the MDX docs sidebar.

Highlights

• feat (NavItem): Added support for separator and sectionTitle properties.
• fix (TypedocProps): The @deprecated tag's summary now renders as expected.

Highlights

• Loosened the peer dependencies for QUI Table packages.

Highlights

• Loosened the peer dependencies for @qui packages.
• feat (CodeDemo): added ability to specify language in the CodeSource interface.

Highlights

• Update dependencies: @qui/base, @qui/mdx-docs-common, @qui/react, @qui/react-table

Highlights

• fix (Sidebar): the docs sidebar now accounts for the sticky top section when scrolling items into view. This fixes a bug that would sometimes cause the active element to appear behind the sticky top section on browser back/forward navigation.

Highlights

• Update dependencies: @qui/react, @qui/react-table

Highlights

• fix (TableOfContents): adjusted IntersectionObserver threshold to fix out-of-bounds toc element detection.

Highlights

• fix (styles): bold markdown elements will now appear with the correct QDS font weight.

Highlights

• Update dependencies: @qui/mdx-docs-common
• fix (TableOfContents): fixed a bug that was sometimes causing the ToC to continue scrolling down after the user had stopped scrolling.
• fix (MdxProvider): Tables are now wrapped by a div that overflows their contents automatically if they are too wide.
• feat (MdxProvider): Code Blocks now hide the copy button until the user hovers over the element.

Highlights

• Update dependencies: @qui/base, @qui/react, @qui/react-table, @qui/table-core
• feat: increased blockquote inline alert padding.

Highlights

• Update dependencies: @qui/mdx-docs-common
• feat (DocProps): replaced tailwind classes with custom CSS classes.

Highlights

• Update dependencies: @qui/mdx-docs-common
• Moved utilities to @qui/mdx-docs-common

Highlights

• Update dependencies: @qui/base, @qui/mdx-docs-common, @qui/react, @qui/react-table, @qui/styles, @qui/table-core
• deprecation (Tip): the tip component is now deprecated. Migrate to Alerts.
• feat: added CSS for blockquote alerts.
• feat: most mdx element top margins are now controlled via the --qui-mdx-margin-default CSS variable.
• feat: improved content filtering. Highlighted text content, if available, should now always be visible for result items.
• feat (CodeHighlight): added the collapsible prop, defaults to true (but only applied renders when label is supplied). When false, it disables the collapsible behavior.
• feat (DocsLayout): the user can now supply their own MDXComponents to override the QUI defaults.
• feat: the top margin for headings has increased to 32px to visually separate page sections.
• feat: nested lists now render with alternating list item styles.
• feat: search result item icons are now more accurate. Heading sections now show the corresponding heading's icon (i.e. H2, H3, H4).
• fix (Sidebar): fixed a bug that was causing page nav items with children to begin the collapse animation when clicked from another page.

Highlights

• Update dependencies: @qui/mdx-docs-common
• breaking: the @qui/react-table and @qui/table-core libraries are now mandatory dependencies.
• feat: added the ability to hide the page links per page using the hidePageLinks frontmatter/routeMeta.
• feat: added the ability to hide the side navigation per page using the hideSideNav frontmatter/routeMeta.
• feat: added the ability to hide a page from page links and the side navigation using the hidden frontmatter/routeMeta.
• feat (TreeFile): the icon is now configurable.
• feat (TreeFile): the default file icon has been changed to FileTextIcon.
• feat: side navigation width is now consolidated within a CSS variable.
• fix (CodeHighlight): non-JS languages are now applied as expected to the component's syntax highlighting.
• fix (PageLinks): the next/prev page links are now always the same width.

Highlights

• Update dependencies: @qui/react, @qui/styles
• feat (MDX): added support for code block meta
• feat: replaced default React import with named imports.
• feat: added mdx blockquote styles.
• fix (Tip): title font updated to the appropriate heading style.

Highlights

• Update dependencies: @qui/base, @qui/react
• fix (SearchResults): the desktop search bar's dropdown will now hide as expected when the viewport changes to mobile.
• feat (SearchResults): improved search result text truncation. Result item text will now span the entire width of the search result item.
• feat (CodeHighlight): now accepts label, collapsible and defaultCollapsed props. Can be collapsed/expanded if collapsible is provided.

Highlights

• Update dependencies: @qui/mdx-docs-common
• fix (TableOfContents): the window's current scroll position is now accounted for in the heading region calculation.
• feat (DocsFooter): added component. Simple element with a default className.
• feat (DocsLayout): added footer prop. The footer is no longer provided automatically.
• feat (SiteSearchDesktop): added noResults prop for customizing the rendering of the noResults label. Can be set to null to disable the message completely.
• feat (SiteSearchMobile): added reusable component that renders a search icon button, which activates a dialog on click. Uses the search index for results. Meant to be rendered on mobile viewports where rendering the full search bar in the header is not feasible.
• feat (SiteSearch): search results are now grouped by page. The ranking of the results was not impacted by this change.

Highlights

• Update dependencies: @qui/base, @qui/react
• fix (Breadcrumbs): fixed breadcrumb generation for intermediate routes (folders).
• feat (DocsLayout): added rootBreadcrumb prop for configuring the root breadcrumb.
• feat (DocsLayout): added TocHighlightStrategy prop for controlling the ToC element highlighting behavior.
• feat (NotFound): added component.
• feat (RenderLink): the link renderer is now passed to relevant child components via context instead of prop drilling.
• feat (TableOfContents): the default highlighting strategy has been updated to highlight the nearest ToC item instead of all items within the viewport.
• fix (SearchResults): the no-results label style is now applied correctly.
• fix (SearchResults): item title and categories now render in the correct order.
• fix (Sidebar): the routeMeta side nav expansion state is now only applied on first load. Previously it was being applied on every route change.

Highlights

• Update dependencies: @qui/react

Highlights

• Update dependencies: @qui/base, @qui/react

Highlights

• Update dependencies: @qui/base, @qui/react
• removed escape-string-regexp peerDependency.
• escape-string-regexp is now sourced from @qui/base.
• fix: added missing lodash-es peerDependency.

Highlights

• Update dependencies: @qui/react

Highlights

• Update dependencies: @qui/react

Highlights

• breaking: added @qui/mdx-docs-common peerDependency. Common types and utilities related to the search index, nav items, and page map have been moved to this package.
• Update dependencies: @qui/react

Highlights

• Update dependencies: @qui/react

Highlights

• fix: the main content section now extends to the full width of the page, even when the page content is too small to fill the viewport.