Astro-Navbar is a fully responsive and accessible headless navigation bar for Astro, supporting nested dropdowns and mobile-responsive toggles.
npm install astro-navbar
# or
pnpm add astro-navbar
Ensure you have the .hidden
class in your CSS. If not, add the following:
.hidden {
display: none;
}
Then integrate the navigation bar:
---
import { Astronav, MenuItems, MenuIcon, Dropdown, DropdownItems, DropdownSubmenu } from "astro-navbar";
---
<div>
<Astronav>
<div class="flex justify-between">
<a>Your Logo</a>
<MenuIcon class="w-4 h-4 text-gray-800" />
</div>
<MenuItems class="hidden lg:flex">
<ul>
<li>Home</li>
<li>About</li>
<li>
<Dropdown class="group">
<button>
<span> Services </span>
<!-- You can style when dropdown is `open` -->
<svg class="group-open:rotate-180">...arrow..</svg>
</button>
<DropdownItems>
<div class="absolute top-0">
<ul>
<li>Menu 1</li>
<li>Menu 2</li>
<li>
<DropdownSubmenu>
<button>Submenu</button>
<DropdownItems>
<ul>
<li>Sub Menu 1</li>
<li>Sub Menu 2</li>
</ul>
</DropdownItems>
</DropdownSubmenu>
</li>
</ul>
</div>
</DropdownItems>
</Dropdown>
</li>
</ul>
</MenuItems>
</Astronav>
</div>
Every component, except Astronav
, supports the class
attribute for custom styling. The <Dropdown/>
component will have an aria-expanded
attribute for accessibility and an open
class & attribute when shown. This can be styled with CSS or utilities like Tailwind CSS's group-open
.
To use custom icons:
---
import { Astronav, MenuIcon, OpenIcon, CloseIcon } from "astro-navbar";
---
<Astronav>
...
<MenuIcon>
<OpenIcon>
<svg>...</svg>
</OpenIcon>
<CloseIcon>
<svg>...</svg>
</CloseIcon>
</MenuIcon>
...
</Astronav>
To add custom icons for menu, you can use OpenIcon
and CloseIcon
inside MenuIcon
. Here's an example. You can also pass custom icon components like astro-icon
here.
---
import { Astronav, MenuIcon, OpenIcon, CloseIcon } from "astro-navbar";
---
<Astronav>
...
<MenuIcon>
<OpenIcon>
<svg>...</svg>
</OpenIcon>
<CloseIcon>
<svg>...</svg>
</CloseIcon>
</MenuIcon>
...
</Astronav>
Astro-Navbar pairs well with Tailwind CSS.
Minimal Usage Example with Tailwind CSS
---
import { Astronav, MenuItems, MenuIcon, Dropdown, DropdownItems } from "astro-navbar";
---
<header class="lg:flex p-5 gap-5">
<Astronav>
<div class="flex w-full justify-between">
<a>Your Logo</a>
<div class="block lg:hidden">
<MenuIcon class="w-4 h-4 text-gray-800" />
</div>
</div>
<MenuItems class="hidden lg:flex">
<ul class="flex flex-col lg:flex-row lg:gap-5">
<li>Home</li>
<li>About</li>
<li>
<Dropdown class="group">
<button class="flex items-center">
<span> Services </span>
<svg
xmlns="http://www.w3.org/2000/svg"
fill="none"
viewBox="0 0 24 24"
stroke-width="3"
stroke="currentColor"
class="w-3 h-3 mt-0.5 group-open:rotate-180">
<path
stroke-linecap="round"
stroke-linejoin="round"
d="M19.5 8.25l-7.5 7.5-7.5-7.5"></path>
</svg>
</button>
<DropdownItems class="relative">
<div class="absolute top-0">
<ul>
<li>Menu 1</li>
<li>Menu 2</li>
<li>Menu 3</li>
</ul>
</div>
</DropdownItems>
</Dropdown>
</li>
</ul>
</MenuItems>
</Astronav>
</header>
Here are the supported options / props for this plugin.
You can add the closeOnClick
props to the Astronav
component if you want to close the menu on clicking the item. This is useful on mobile where you have links to the same page like #about
and want to close menu after click.
// Close whole menu on clicking a menu item inside (on mobile)
<Astronav closeOnClick>...</Astronav>
Please create an issue.
Copyright ©️ 2023-2099. Surjith S M.