Merge pull request #247 from qualcomm/dev

dev

Author: R-Bower

packages/common/mdx-common/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @qualcomm-ui/mdx-common Changelog
 
+## 2.2.0
+
+Apr 23rd, 2026
+
+### Features
+
+- [mdx-common]: add NavBadge type and isNavBadge type guard ([1ef8453](https://github.com/qualcomm/qualcomm-ui/commit/1ef8453))
+
+### Miscellaneous Chores
+
+- **deps:** update dependencies [@qualcomm-ui/typedoc-common]
+
 ## 2.1.3
 
 Apr 23rd, 2026

packages/common/mdx-common/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualcomm-ui/mdx-common",
-  "version": "2.1.3",
+  "version": "2.2.0",
   "description": "MDX common types and utilities",
   "author": "Ryan Bower",
   "license": "BSD-3-Clause-Clear",
@@ -38,15 +38,15 @@
     "@qualcomm-ui/cli": "catalog:",
     "@qualcomm-ui/esbuild": "catalog:",
     "@qualcomm-ui/tsconfig": "catalog:",
-    "@qualcomm-ui/typedoc-common": "workspace:^1.0.5",
+    "@qualcomm-ui/typedoc-common": "workspace:^1.0.6",
     "esbuild": "catalog:",
     "fuzzysort": "^3.0.1",
     "shx": "^0.4.0",
     "tsx": "catalog:",
     "vite": "catalog:"
   },
   "peerDependencies": {
-    "@qualcomm-ui/typedoc-common": "workspace:^1.0.5",
+    "@qualcomm-ui/typedoc-common": "workspace:^1.0.6",
     "fuzzysort": ">=3"
   }
 }

packages/common/mdx-common/src/docs-plugin.types.ts

@@ -207,6 +207,13 @@ export interface PageSection extends PageFrontmatter {
 export type PageMap = Record<string, PageSection>
 
 export interface NavItem {
+  /**
+   * Badges rendered in the sideNav
+   *
+   * @since 2.2.0
+   */
+  badges?: NavBadge[] | undefined
+
   /**
    * The depth of the nav item. The root nav item starts at 1. Each child has n+1
    * depth, where n is the depth of the parent item.
@@ -527,3 +534,42 @@ export interface KnowledgePages {
   totalPages: number
   version: 1
 }
+
+/**
+ * @since 2.2.0
+ */
+export interface NavBadge {
+  /**
+   * If true, this badge won't be displayed in the side nav.
+   */
+  hideFromNav?: boolean
+
+  /**
+   * Unique key for the badge.
+   */
+  id: string
+
+  /**
+   * Text rendered inside the badge.
+   */
+  label: string
+
+  /**
+   * Optional HTML title attribute to show on hover.
+   */
+  title?: string
+
+  /**
+   * Optional URL that the badge links to. To link to a local path, start the pathname with `/`. To link to an external URL, start the url with `https://`
+   *
+   * @example
+   * ```js
+   * // local path
+   * /guides/developer-preview
+   *
+   * // external
+   * https://github.com/qualcomm/qualcomm-ui
+   * ```
+   */
+  url?: string
+}

packages/common/mdx-common/src/docs-plugin.utils.ts

@@ -0,0 +1,19 @@
+// Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+// SPDX-License-Identifier: BSD-3-Clause-Clear
+
+import type {NavBadge} from "./docs-plugin.types"
+
+/**
+ * @since 2.2.0
+ */
+export function isNavBadge(obj: unknown): obj is NavBadge {
+  return (
+    typeof obj === "object" &&
+    !!obj &&
+    "label" in obj &&
+    "id" in obj &&
+    typeof obj.label === "string" &&
+    (!("url" in obj) ||
+      ("url" in obj && (typeof obj.url === "string" || !obj.url)))
+  )
+}

packages/common/mdx-common/src/index.ts

@@ -1,5 +1,6 @@
 export type * from "./demo-plugin.types"
 export type * from "./docs-plugin.types"
+export * from "./docs-plugin.utils"
 export * from "./id-service"
 export * from "./search"
 export * from "./shiki-themes"

packages/common/mdx-vite/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @qualcomm-ui/mdx-vite Changelog
 
+## 3.5.0
+
+Apr 23rd, 2026
+
+### Features
+
+- [mdx-vite]: extract badges from frontmatter in nav builder ([58ecfcd](https://github.com/qualcomm/qualcomm-ui/commit/58ecfcd))
+
+### Miscellaneous Chores
+
+- **deps:** update dependencies [@qualcomm-ui/mdx-common, @qualcomm-ui/typedoc-common]
+
 ## 3.4.0
 
 Apr 23rd, 2026

packages/common/mdx-vite/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualcomm-ui/mdx-vite",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Vite documentation plugin for applications that use MDX",
   "author": "Ryan Bower",
   "license": "BSD-3-Clause-Clear",
@@ -90,11 +90,11 @@
   "devDependencies": {
     "@qualcomm-ui/cli": "catalog:",
     "@qualcomm-ui/esbuild": "catalog:",
-    "@qualcomm-ui/mdx-common": "workspace:^2.1.3",
+    "@qualcomm-ui/mdx-common": "workspace:^2.2.0",
     "@qualcomm-ui/utils": "workspace:^1.2.3",
     "@qualcomm-ui/tsconfig": "catalog:",
     "@qualcomm-ui/tailwind-plugin": "workspace:^1.7.0",
-    "@qualcomm-ui/typedoc-common": "workspace:^1.0.5",
+    "@qualcomm-ui/typedoc-common": "workspace:^1.0.6",
     "@types/hast": "^3.0.4",
     "@types/lodash-es": "catalog:",
     "@types/mdast": "^4.0.4",
@@ -125,8 +125,8 @@
     "zod": "^4.1.13"
   },
   "peerDependencies": {
-    "@qualcomm-ui/mdx-common": "workspace:^2.1.3",
-    "@qualcomm-ui/typedoc-common": "workspace:^1.0.5",
+    "@qualcomm-ui/mdx-common": "workspace:^2.2.0",
+    "@qualcomm-ui/typedoc-common": "workspace:^1.0.6",
     "@qualcomm-ui/utils": "workspace:^1.2.3",
     "lodash-es": ">=4.17.21 <5",
     "minimatch": ">=10",

packages/common/mdx-vite/src/docs-plugin/nav-builder/nav-builder.ts

@@ -4,10 +4,12 @@
 import {sortBy} from "lodash-es"
 import {v4 as uuidv4} from "uuid"
 
-import type {
-  NavItem,
-  PageFrontmatter,
-  PageSection,
+import {
+  isNavBadge,
+  type NavBadge,
+  type NavItem,
+  type PageFrontmatter,
+  type PageSection,
 } from "@qualcomm-ui/mdx-common"
 import {capitalCase} from "@qualcomm-ui/utils/change-case"
 import {defined} from "@qualcomm-ui/utils/guard"
@@ -175,6 +177,7 @@ export class NavBuilder {
           ) ?? {}
 
         this.flatNavItems.push({
+          badges: isPage ? this.extractBadges(pageFrontmatter) : undefined,
           depth,
           expanded: routeMeta?.expanded || false,
           group: isPage
@@ -388,4 +391,16 @@ export class NavBuilder {
 
     return results
   }
+
+  private extractBadges(
+    pageFrontmatter: Partial<PageFrontmatter>,
+  ): NavBadge[] | undefined {
+    const badges = (
+      pageFrontmatter as Partial<PageFrontmatter> & Record<string, unknown>
+    ).badges
+    if (badges && typeof badges === "object" && Array.isArray(badges)) {
+      return badges.filter((badge) => isNavBadge(badge) && !badge.hideFromNav)
+    }
+    return undefined
+  }
 }

packages/common/qds-core/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @qualcomm-ui/qds-core Changelog
 
+## 1.26.1
+
+Apr 23rd, 2026
+
+### Bug Fixes
+
+- [qds-core]: remove hardcoded cursor default from badge component ([f7c0c0e](https://github.com/qualcomm/qualcomm-ui/commit/f7c0c0e))
+
 ## 1.26.0
 
 Apr 23rd, 2026

packages/common/qds-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qualcomm-ui/qds-core",
-  "version": "1.26.0",
+  "version": "1.26.1",
   "description": "qds core components",
   "author": "Ryan Bower",
   "license": "BSD-3-Clause-Clear",