Skip to content

Commit 0a7a6c2

Browse files
authored
Merge pull request #265 from qualcomm/feature/configurable-nav-badges
feature/configurable-nav-badges
2 parents c0bb122 + f4215ef commit 0a7a6c2

38 files changed

Lines changed: 362 additions & 231 deletions

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@
5252
"check-updates": "ncu -c 2 -w",
5353
"doc-gen": "turbo run build:typedoc",
5454
"publish:all": "pnpm changeset publish && pnpm -r run publish-angular-package",
55-
"bump": "pnpm qui-changesets prep-release --include-commit-links"
55+
"bump": "pnpm qui-changesets prep-release --include-commit-links && pnpm qui-changesets update-jsdoc-since-tags"
5656
},
5757
"devDependencies": {
5858
"@changesets/cli": "^2.29.7",
5959
"@clack/prompts": "1.0.0-alpha.6",
6060
"@commander-js/extra-typings": "catalog:",
6161
"@eslint/js": "catalog:",
6262
"@manypkg/get-packages": "^3.1.0",
63-
"@qualcomm-ui/changesets-cli": "^1.0.4",
63+
"@qualcomm-ui/changesets-cli": "^1.1.0",
6464
"@qualcomm-ui/eslint-config-angular": "workspace:*",
6565
"@qualcomm-ui/eslint-config-mdx": "workspace:*",
6666
"@qualcomm-ui/eslint-config-react": "workspace:*",

packages/common/mdx-common/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# @qualcomm-ui/mdx-common Changelog
22

3+
## 2.4.0
4+
5+
May 14th, 2026
6+
7+
### Features
8+
9+
- [docs-layout]: add configurable badge renderers ([b2e87d5](https://github.com/qualcomm/qualcomm-ui/commit/b2e87d5))
10+
311
## 2.3.0
412

513
Apr 29th, 2026

packages/common/mdx-common/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@qualcomm-ui/mdx-common",
3-
"version": "2.3.0",
3+
"version": "2.4.0",
44
"description": "MDX common types and utilities",
55
"author": "Ryan Bower",
66
"license": "BSD-3-Clause-Clear",

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

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -560,6 +560,15 @@ export interface NavBadge {
560560
*/
561561
label: string
562562

563+
/**
564+
* Optional label override for the side nav. Set to false to prevent the badge from
565+
* appearing in the side nav. When not defined, the side nav will render the
566+
* {@link label}.
567+
*
568+
* @since 2.4.0
569+
*/
570+
sideNavLabel?: string | false
571+
563572
/**
564573
* Optional HTML title attribute to show on hover.
565574
*/

packages/common/mdx-vite/CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
# @qualcomm-ui/mdx-vite Changelog
22

3+
## 3.7.3
4+
5+
May 14th, 2026
6+
7+
### Miscellaneous Chores
8+
9+
- **deps:** update dependencies [@qualcomm-ui/mdx-common]
10+
311
## 3.7.2
412

513
May 10th, 2026

packages/common/mdx-vite/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@qualcomm-ui/mdx-vite",
3-
"version": "3.7.2",
3+
"version": "3.7.3",
44
"description": "Vite documentation plugin for applications that use MDX",
55
"author": "Ryan Bower",
66
"license": "BSD-3-Clause-Clear",
@@ -90,7 +90,7 @@
9090
"devDependencies": {
9191
"@qualcomm-ui/cli": "catalog:",
9292
"@qualcomm-ui/esbuild": "catalog:",
93-
"@qualcomm-ui/mdx-common": "workspace:^2.3.0",
93+
"@qualcomm-ui/mdx-common": "workspace:^2.4.0",
9494
"@qualcomm-ui/utils": "workspace:^1.2.4",
9595
"@qualcomm-ui/tsconfig": "catalog:",
9696
"@qualcomm-ui/tailwind-plugin": "workspace:^1.7.1",
@@ -125,7 +125,7 @@
125125
"zod": "^4.1.13"
126126
},
127127
"peerDependencies": {
128-
"@qualcomm-ui/mdx-common": "workspace:^2.3.0",
128+
"@qualcomm-ui/mdx-common": "workspace:^2.4.0",
129129
"@qualcomm-ui/typedoc-common": "workspace:^1.0.6",
130130
"@qualcomm-ui/utils": "workspace:^1.2.4",
131131
"lodash-es": ">=4.17.21 <5",

packages/docs/angular-docs/qui-docs.config.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ const navConfig: NavConfig[] = [
1616
{
1717
id: "installation",
1818
},
19+
{
20+
id: "versioning",
21+
},
1922

2023
{separator: true},
2124
{sectionTitle: "Integrations"},
@@ -47,9 +50,6 @@ const navConfig: NavConfig[] = [
4750
{
4851
id: "pitfalls",
4952
},
50-
{
51-
id: "developer-previews",
52-
},
5353
{
5454
separator: true,
5555
},

packages/docs/angular-docs/src/components/layout/app-docs-layout.tsx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,12 @@ import {
1515
HeaderAiLink,
1616
HeaderLogo,
1717
HeaderRepositoryLink,
18+
PageHeaderBadges,
1819
QuiEcosystemMenu,
20+
SideNavBadges,
1921
ThemeToggle,
2022
} from "@qualcomm-ui/react-internal/layout"
23+
import type {LayoutComponents} from "@qualcomm-ui/react-mdx/context"
2124
import {
2225
DocsLayout,
2326
type DocsLayoutSettings,
@@ -32,6 +35,11 @@ import {useAngularDemoReloader} from "./use-angular-demo-reloader"
3235
import {useRouterLinkInterceptor} from "./use-router-link-interceptor"
3336
import {useThemeSwitchInterceptor} from "./use-theme-switch-interceptor"
3437

38+
const layoutComponents: LayoutComponents = {
39+
PageHeaderBadges,
40+
SideNavBadges,
41+
}
42+
3543
interface Props extends Partial<DocsLayoutSettings> {
3644
/**
3745
* React {@link https://react.dev/learn/passing-props-to-a-component#passing-jsx-as-children children} prop.
@@ -96,6 +104,7 @@ export function AppDocsLayout({children, ...props}: Props): ReactNode {
96104
</HeaderBar.Root>
97105
</div>
98106
}
107+
layoutComponents={layoutComponents}
99108
pathname={location.pathname}
100109
renderLink={DocLink}
101110
rootBreadcrumb={{

packages/docs/angular-docs/src/routes/components+/card+/_card.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ aliases: [tile, panel, content card, media card, container]
66
badges:
77
- id: since
88
label: 2.4.0
9-
- id: developerPreview
10-
label: Developer Preview
11-
url: /developer-previews
9+
- id: beta
10+
label: Beta
11+
url: /versioning#beta
1212
---
1313

1414
import {

packages/docs/angular-docs/src/routes/components+/stepper+/_stepper.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ badges:
66
- id: since
77
label: 2.3.0
88
url: https://github.com/qualcomm/qualcomm-ui/blob/main/packages/frameworks/angular/CHANGELOG.md#230
9-
- id: developerPreview
10-
label: Developer Preview
11-
url: /developer-previews
9+
- id: beta
10+
label: Beta
11+
url: /versioning#beta
1212
---
1313

1414
import {QdsDemo, ComponentExplorer} from "~components/demo"

0 commit comments

Comments
 (0)