Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ultimate-react-multilevel-menu

MoIzadloo61MIT3.4.9TypeScript support: included

The Ultimate React Multilevel Menu

react menu, multilevel menu, react, react multilevel menu component, styleguide

readme

The Ultimate React Multilevel Menu

URMM is a responsive menu react component. It's designed to be customizable and user-friendly.

  • User-friendly simple and elegant
  • Customizable to be suited to your needs
  • RTL-Support to support different languages
  • Multi-level to go as deep as you want

Pros

  1. URMM is fully customizable thanks to different props
  2. URMM supports multi-level menus
  3. URMM is easy to implement

Demo

Documentation is here

Install

npm install --save ultimate-react-multilevel-menu

or

yarn add ultimate-react-multilevel-menu

Stylesheets

Make sure to include shipped CSS in your application to apply the correct styling to all components

{
  /* The following line can be included in your src/index.js or App.js file */
}
import 'ultimate-react-multilevel-menu/dist/esm/index.css'

Minimum Working Set Up

import {
  Navbar,
  Collapse,
  Item,
  Items,
  Logo
} from 'ultimate-react-multilevel-menu'

;<Navbar className={'navbar-light bg-white'}>
  <Logo href="/">Logo</Logo>
  <Collapse>
    <Item href={'#home'}>Home</Item>
    <Items href={'#articles'} title="Articles">
      <Items href={'#power-plant'} title="Power plant">
        <Item href={'#turbine'}>Turbine</Item>
      </Items>
    </Items>
    <Items href={'#about'} title="About">
      <Item href={'#introduction'}>Introduction</Item>
    </Items>
    <Item href={'#pricing'}>Pricing</Item>
  </Collapse>
</Navbar>

Componnents

The Navbar component is the container of all other components and you can change the color scheme by using the predefined CSS classes or your custom CSS classes

Props

Name Type Default Description
dir "rtl" | "ltr" "ltr" Menu direction
className "string" "" CSS class for nav tag

Collapse

The Collapse component is the container of the Nav component and it's responsible for making the menu responsive and elegant on small screens

Props

Name Type Default Description

The Nav component is a container of Item and Items components, in fact, the Collapse component uses the Nav component to wrap Item and Items components under the hood. in case you don't want the collapse toggle button you can use it directly instead.

Props

Name Type Default Description

The Logo component is the container of your logo which can be an image or simple text

Props

Name Type Default Description
href "string" "" Logo url link
as React.ElementType a The component that link render as
className "string" "" CSS class for container div tag

Item

The Item component is a single link

Props

Name Type Default Description
href "string" "" Item url link
as React.ElementType a The component that link render as
className "string" "" CSS class for container li tag

Items

The Items component is a link and a container for other Items or Item components

Props

Name Type Default Description
href "string" "" Url link for it self
as React.ElementType a The component that link render as
className "string" "" CSS class for container ul tag

Contact Me

Email: `moizadloo@gmail.com`

changelog

v3.4.9 (2023-12-05)

🐛 Bug Fixes

v3.4.8 (2023-11-12)

v3.4.7 (2023-11-12)

v3.4.6 (2023-11-12)

v3.4.5 (2023-10-16)

v3.4.4 (2023-10-15)

v3.4.3 (2023-10-07)

v3.4.2 (2023-09-30)

🐛 Bug Fixes

  • 5f757c3 fix: context.consumer setState warning fixed

v3.4.1 (2023-09-28)

🐛 Bug Fixes

  • b6d7f99 fix: multiple @types/react

v3.4.0 (2023-09-27)

✨ New Features

  • b9c02f0 feat: Reset collapse state onclick

v3.3.4 (2023-09-22)

🐛 Bug Fixes

  • 7225873 fix: Typescript forwardref return type in progress

v3.3.3 (2023-09-20)

🐛 Bug Fixes

  • f18490a fix: typescript as property errors

v3.3.2 (2023-09-19)

🐛 Bug Fixes

  • 697d438 fix: typescript hreflang problem

v3.3.1 (2023-09-17)

🐛 Bug Fixes

  • ece0154 fix: Use react context instead of window

v3.3.0 (2023-09-16)

✨ New Features

  • d783a64 feat: Collapse user-select disabled

v3.2.0 (2023-09-16)

✨ New Features

  • f44488f feat: Position utilities have been added

v3.1.0 (2023-09-14)

✨ New Features

  • 2615785 feat: Items component modified to support elements as input

v3.0.0 (2023-09-13)

💥 Breaking Changes

  • 87315e5 feat: Many problems have been solved

v2.0.0 (2023-09-10)

💥 Breaking Changes

  • b7bd9b0 feat: add rtl support and update README.md

v1.0.0 (2023-09-06)

✨ New Features

  • abf31d9 feat: yarn instead of npm

💥 Breaking Changes