@fusion.dev/helix-docs 0.207.2 → 0.208.1

package/dist/pages.generated.js

@@ -13,7 +13,7 @@ export const docPages = [
         title: 'Angular',
     },
     {
-        description: 'The browser features Helix uses, and the browser we test in.',
+        description: 'The browser features Helix uses, and the browsers we test in.',
         order: 5,
         section: 'Getting started',
         slug: 'browser-support',

package/dist/reference.d.ts

@@ -51,9 +51,13 @@ export interface ReferenceDeclaration {
     cssStates?: ReferenceEntry[];
     description?: string;
     events?: ReferenceEntry[];
-    /** The family the element joins from another package, from `@family`. */
+    /**
+     * The family the element joins from another package, from `@family`, and
+     * its stability, from `@status`.
+     */
     helix?: {
         family?: string;
+        status?: string;
     };
     members?: ReferenceMember[];
     slots?: ReferenceEntry[];

package/dist/reference.js

@@ -46,9 +46,13 @@ export const referenceFamilies = (manifest) => {
         parts: [...parts].sort((a, b) => a.part === 'root' ? -1 : b.part === 'root' ? 1 : a.part.localeCompare(b.part)),
     }));
 };
-const element = (depth, declaration, part) => {
+const element = (depth, declaration, part, family) => {
     const { attributes = [], cssParts = [], cssProperties = [], cssStates = [], description, events = [], members = [], slots = [], summary, superclass, tagName, } = declaration;
     const lines = [`${'#'.repeat(depth)} ${startCase(part)} (\`${tagName}\`)`, ''];
+    const status = declaration.helix?.status;
+    if (status && status !== family) {
+        lines.push(`**Status:** ${status}`, '');
+    }
     if (summary) {
         lines.push(summary, '');
     }
@@ -130,8 +134,9 @@ export const reference = (manifest, options = {}) => {
         if (usage.length > 0) {
             lines.push(`${'#'.repeat(depth)} Usage`, '', '```js', ...usage, '```', '');
         }
+        const status = parts.find((entry) => entry.part === 'root')?.declaration.helix?.status;
         for (const { declaration, part } of parts) {
-            lines.push(...element(depth, declaration, part));
+            lines.push(...element(depth, declaration, part, status));
         }
         lines.push(...shown(depth, family, options.examples?.[family] ?? []));
     }