chore(www): add package status badge

liferay · Jan 29, 2025 · 64ad22c · 64ad22c
1 parent 45adb4f
commit 64ad22c
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/www/app/_components/Heading.tsx b/www/app/_components/Heading.tsx
@@ -10,6 +10,7 @@ type Props = {
 	description?: string;
 	title: string;
 	path: Array<string>;
+	packageStatus?: string;
 	lexicon?: string;
 	markup?: boolean;
 	design?: boolean;
@@ -21,6 +22,7 @@ export default function Heading({
 	description,
 	title,
 	lexicon,
+	packageStatus,
 	path = [],
 	markup,
 	design,
@@ -70,6 +72,17 @@ export default function Heading({
 						View in Lexicon
 					</a>
 				)}
+				{packageStatus && (
+					<span
+						className={classNames('badge badge-translucent', {
+							'badge-success': packageStatus === 'Stable',
+							'badge-warning': packageStatus === 'Beta',
+							'badge-danger': packageStatus === 'Deprecated',
+						})}
+					>
+						{packageStatus}
+					</span>
+				)}
 			</div>
 			{description && (
 				<p className="text-6 text-secondary">{description}</p>

diff --git a/www/app/docs/(layout)/[...slug]/DocsLayout.tsx b/www/app/docs/(layout)/[...slug]/DocsLayout.tsx
@@ -67,6 +67,7 @@ export async function DocsLayout({slug}: Props) {
 					title={frontmatter.title}
 					description={frontmatter.description}
 					lexicon={frontmatter.lexiconDefinition}
+					packageStatus={frontmatter.packageStatus}
 					path={slug}
 					markup={!!fileMarkup}
 					design={!!fileDesign}

diff --git a/www/app/docs/(layout)/[...slug]/RemoteLayout.tsx b/www/app/docs/(layout)/[...slug]/RemoteLayout.tsx
@@ -33,6 +33,7 @@ export async function RemoteLayout({slug}: Props) {
 					title={frontmatter.title}
 					description={frontmatter.description}
 					lexicon={frontmatter.lexiconDefinition}
+					packageStatus={frontmatter.packageStatus}
 					path={slug}
 					design
 					markup={!!fileMarkup}

diff --git a/www/data.ts b/www/data.ts
@@ -10,6 +10,7 @@ import {z} from 'zod';
 const frontmatterSchema = z.object({
 	title: z.string(),
 	description: z.string(),
+	packageStatus: z.optional(z.string()),
 	packageNpm: z.optional(z.string()),
 	packageUse: z.optional(z.string()),
 	lexiconDefinition: z.optional(z.string()),