Merge pull request #843 from etn-ccis/fix/blui-5255-missing-props

Add nav item props to shared props
etn-ccis · Feb 8, 2024 · 976ae15 · 976ae15
2 parents 1696092 + e985da3
commit 976ae15
Showing 1 changed file with 20 additions and 2 deletions.
diff --git a/docs/src/shared/markdown/SharedProps.mdx b/docs/src/shared/markdown/SharedProps.mdx
@@ -1,10 +1,10 @@
 import Box from '@mui/material/Box';
 
-## Shared Props
+## Drawer Shared Props
 
 The following props can be set at any level in the drawer hierarchy ([`<Drawer>`](/components/drawer/api-docs), [`<DrawerBody>`](/components/drawer-body/api-docs), [`<DrawerNavGroup>`](/components/drawer-nav-group/api-docs), [`<DrawerNavItem>`](/components/drawer-nav-item/api-docs), or [`<DrawerRailItem>`](/components/drawer-rail-item/api-docs)). If they are set on a parent, they will be used for all children. For more customization, you can set these props on individual children and they will override any value set on the parent.
 
-<Box id='shared-props'>
+<Box id='drawer-shared-props'>
 
 | Name                      | Description                                               | Type      | Required | Default                     |
 | :------------------------ | :-------------------------------------------------------- | :-------- | :------- | :-------------------------- |
@@ -18,3 +18,21 @@ The following props can be set at any level in the drawer hierarchy ([`<Drawer>`
 | ripple                    | Whether to apply material ripple effect to items on click | `boolean` | no       | true                        |
 
 </Box>
+
+## Drawer Nav Item Props
+
+<Box id='drawer-nav-item-props'>
+
+| Name                          | Description                                                                    | Type                    | Required | Default                          |
+| :---------------------------- | :----------------------------------------------------------------------------- | :---------------------- | :------- | :------------------------------- |
+| activeItemBackgroundShape     | Shape of the active item background                                            | `'round'` \| `'square'` | no       | `square`                         |
+| chevron                       | Whether to have chevrons for all menu items                                    | `boolean`               | no       | `false`                          |
+| chevronColor                  | Color override for the chevron icon                                            | `string`                | no       | `varies for light/dark theme`    |
+| collapseIcon                  | Icon used to collapse nav group                                                | `JSX.Element`           | no       | `expandIcon rotated 180 degrees` |
+| expandIcon                    | Icon used to expand nav group                                                  | `JSX.Element`           | no       |                                  |
+| hidePadding                   | Whether to hide the paddings reserved for menu item icons                      | `boolean`               | no       | `false`                          |
+| disableActiveItemParentStyles | Disables the semi-bold style on parent elements in the selected item hierarchy | `boolean`               | no       | `false`                          |
+| nestedBackgroundColor         | Background color for a nested section of menu items                            | `string`                | no       | `varies for light/dark theme`    |
+| nestedDivider                 | Whether to apply a dividing line under nested navigation items                 | `boolean`               | no       | `false`                          |
+
+</Box>