MUI Extended UI Components

Tree Menu With Links


Creates a Tree Menu with links. Uses TreeView component from MUI

Usage

import { TreeMenuWithNextLinks } from "mui-extended"; const treeMenuProps: TreeMenuWithNextLinksProps; const treeMenu = <TreeMenuWithNextLinks {...treeMenuProps} />;

Props

  • links array of string or { link: string; label?: string;}
    • Valid Values are
      • docs - points to ${basePath}/docs link
      • /docs/ - points to ${basePath}/docs link , leading and ending / are trimmed
      • /docs/getting-started - points to ${basePath}/docs/getting-started link
      • { link: "docs/install"} - points to ${basePath}/docs/install link
      • { link: "docs/install", label: "Documentaion/Installation"} - points to ${basePath}/docs/install link
    • Intermediate nodes will have link, if provided explicitly, Otherwise it acts as a normal Tree Node
    • right most label is applied to right most link
      • { link: "docs/install", label: "Installation"}
        • Generates 2 Nodes
          • docs
            • Installation - pointing to ${basePath}/docs/install
      • { link: "docs/install", label: "components/Documentation/Installation"}
        • Generates 2 Nodes
          • Documentation
            • Installation - pointing to ${basePath}/docs/install
  • basePath (Optional) string base path for the next link
  • improveLabels (Optional) boolean, if true lables are converted to UCFirst Words
  • TreeViewProps (Optional) TreeViewProps from MUI
  • TreeItemProps (Optional) TreeItemProps from MUI
Does this page need improvements?
Edit This Page in GitHub
Did this page help you?
Provide feedback in the GitHub Discussion Page
Need More help?

Write an email to opensource@sodaru.com