Fumadocs

Navbar

Top navigation bar

Introduction

The navigation header provides common interactive elements.

On larger devices, it becomes a part of sidebar.

import { DocsLayout } from 'fumadocs-ui/layout';
 
<DocsLayout
  nav={{ title: <Logo />, githubUrl: 'https://github.com/fuma-nama/fumadocs' }}
/>;

Transparent Mode

To make the navbar background transparent, you can configure transparent mode. It uses the none mode by default.

import { DocsLayout } from 'fumadocs-ui/layout';
 
<DocsLayout nav={{ transparentMode: 'top' }} />;
ModeDescription
alwaysAlways use a transparent background
topWhen at the top of page
noneDisable transparent background

Reference

PropTypeDefault
enabled
boolean
-
component
ReactNode
-
enableSearch
boolean
-
children
ReactNode
-
title
ReactNode
-
url
string
'/'
transparentMode
"always" | "top" | "none"
none

Last updated on

On this page

Edit on Github