1.0.20 • Published 5 years ago
react-responsive-navbar-ts v1.0.20
react-responsive-navbar
This is a TypeScript rewrite of a React hooks version of react-responsive-navbar.
Nothing crazy, nothing flashy, just a simple, flexible & completely customisable responsive navigation bar component. Check out this demo.
Install
pnpm i react-responsive-navbar-ts
Usage
import React from 'react'
import ResponsiveMenu from 'react-responsive-navbar'
const Example = () => (
<ResponsiveMenu
menuOpenButton={<div />}
menuCloseButton={<div />}
changeMenuOn="500px"
largeMenuClassName="large-menu-classname"
smallMenuClassName="small-menu-classname"
menu={
<ul>
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
<li>Item 4</li>
</ul>
}
/>
)
Props
- menuOpenButton & menuCloseButton: the icons for small screens. I use
react-icons
in the example however you are free to use anydiv
that you please. - changeMenuOn: specify the page width as a string in
px
that you would like to switch between the small and large menu. - menu: takes in any
div
to create your menu content. - You can also specify individual stylings for each of the large or small menus
by adding a
className
to largeMenuClassName or smallMenuClassName
License
MIT © Paige Williams