[docs-infra] Mark unstable components with a chip in the nav drawer (#…

…38573)
mui · Aug 29, 2023 · a392609 · a392609
1 parent 2ae2e79
commit a392609
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 1 deletion.
diff --git a/docs/data/base/pages.ts b/docs/data/base/pages.ts
@@ -25,7 +25,7 @@ const pages: readonly MuiPage[] = [
           { pathname: '/base-ui/react-button', title: 'Button' },
           { pathname: '/base-ui/react-checkbox', title: 'Checkbox', planned: true },
           { pathname: '/base-ui/react-input', title: 'Input' },
-          { pathname: '/base-ui/react-number-input', title: 'Number Input' },
+          { pathname: '/base-ui/react-number-input', title: 'Number Input', unstable: true },
           { pathname: '/base-ui/react-radio-button', title: 'Radio Button', planned: true },
           { pathname: '/base-ui/react-rating', title: 'Rating', planned: true },
           { pathname: '/base-ui/react-select', title: 'Select' },

diff --git a/docs/src/MuiPage.ts b/docs/src/MuiPage.ts
@@ -49,6 +49,10 @@ export interface MuiPage {
    * @default false
    */
   planned?: boolean;
+  /**
+   * Indicates if the component/hook is not stable yet.
+   */
+  unstable?: boolean;
 }
 
 export interface OrderedMuiPage extends MuiPage {

diff --git a/docs/src/modules/components/AppNavDrawer.js b/docs/src/modules/components/AppNavDrawer.js
@@ -259,6 +259,7 @@ function reduceChildRoutes(context) {
         legacy={page.legacy}
         newFeature={page.newFeature}
         planned={page.planned}
+        unstable={page.unstable}
         plan={page.plan}
         icon={page.icon}
         subheader={subheader}
@@ -291,6 +292,7 @@ function reduceChildRoutes(context) {
         legacy={page.legacy}
         newFeature={page.newFeature}
         planned={page.planned}
+        unstable={page.unstable}
         plan={page.plan}
         icon={page.icon}
         subheader={Boolean(page.subheader)}

diff --git a/docs/src/modules/components/AppNavDrawerItem.js b/docs/src/modules/components/AppNavDrawerItem.js
@@ -260,6 +260,7 @@ export default function AppNavDrawerItem(props) {
     legacy,
     newFeature,
     planned,
+    unstable,
     linkProps,
     onClick,
     initiallyExpanded = false,
@@ -328,6 +329,7 @@ export default function AppNavDrawerItem(props) {
         {legacy && <Chip label="Legacy" sx={sxChip('warning')} />}
         {newFeature && <Chip label="New" sx={sxChip('success')} />}
         {planned && <Chip label="Planned" sx={sxChip('grey')} />}
+        {unstable && <Chip label="Preview" sx={sxChip('primary')} />}
       </Item>
       {expandable ? (
         <Collapse in={open} timeout="auto" unmountOnExit>
@@ -356,4 +358,5 @@ AppNavDrawerItem.propTypes = {
   subheader: PropTypes.bool.isRequired,
   title: PropTypes.string.isRequired,
   topLevel: PropTypes.bool,
+  unstable: PropTypes.bool,
 };