Angular Navbar Component

Supported content

c-navbar comes with built-in support for a handful of sub-components. Choose from the following as needed:

• cNavbarBrand for your company, product, or project name.
• c-navbar-nav for a full-height and lightweight navigation (including support for dropdowns).
• c-navbar-toggler for use with our collapse plugin and other navigation toggling behaviors.
• Flex and spacing utilities for any form controls and actions.
• c-navbar-text for adding vertically centered strings of text.
• cCollapse for grouping and hiding navbar contents by a parent breakpoint.

Examples

Basic usage

Here's an example of all the sub-components included in a responsive light-themed navbar that automatically collapses at the lg (large) breakpoint.

Brand

The cNavbarBrand can be applied to most elements, but an anchor works best, as some elements might require utility classes or custom styles.

Adding cNavbarBrand to the images will likely always require custom styles or utilities to properly size. Here are some examples to demonstrate.

Nav

c-navbar navigation is based on `c-navbar-nav. Navigation in navbars will also grow to occupy as much horizontal space as possible to keep your navbar contents securely aligned.

You can avoid the list-based approach entirely if you prefere.

You can also use dropdowns in your navbar. Please note that c-dropdown component requires variant="nav-item".

Forms

Place various form controls and components within a navbar:

Immediate child elements of c-navbar use flex layout and will default to justify-content: space-between. Use additional flex utilities as needed to adjust this behavior.

Input groups work, too. If your navbar is an entire form, or mostly a form, you can use the cForm element as the cContainer and save some HTML.

Various buttons are supported as part of these navbar forms, too. This is also a great reminder that vertical alignment utilities can be used to align different sized elements.

Text

Navbars may contain bits of text with the help of c-navbar-text. It adjusts vertical alignment and horizontal spacing for strings of text.

Mix and match with other components and utilities as needed.

Color schemes

Theming the navbar has never been easier thanks to the combination of theming classes and background-color utilities. Set colorScheme="light" for use with light background colors, or colorScheme="dark" for dark background colors. Then, customize with .bg-* utilities.

Containers

Although it's not required, you can wrap a c-navbar in a c-container to center it on a page–though. Note that an inner container is still needed. Or you can add a container inside the c-navbar to only center the contents of a fixed or static top navbar.

Use any of the responsive containers to change how wide the content in your navbar is presented.

Placement

Use our placement properly to place navbars in non-static positions. Choose from fixed to the top, fixed to the bottom, or stickied to the top (scrolls with the page until it reaches the top, then stays there). Fixed navbars use position: fixed, meaning they're pulled from the normal flow of the DOM and may require custom CSS (e.g., padding-top on the body) to prevent overlap with other elements.

Also note that .sticky-top uses position: sticky, which isn't fully supported in every browser.

Scrolling

Add scroll prop to a c-navbar-nav to enable vertical scrolling within the toggleable contents of a collapsed navbar. By default, scrolling kicks in at 75vh (75% of the viewport height), but you can override that with the local CSS custom property --cui-navbar-height or custom styles. At larger viewports when the navbar is expanded, content will appear as it does in a default navbar.

Please note that this behavior comes with a potential drawback of overflow — when setting overflow-y: auto (required to scroll the content here), overflow-x is the equivalent of auto, which will crop some horizontal content.

The example navbar uses scroll with style="--cui-scroll-height: 80px;", with some extra margin utilities for optimum spacing.

Responsive behavior

Navbars can use cNavbarToggler, cCollapse, and expand="sm|md|lg|xl|xxl" property to determine when their content collapses behind a button. In combination with other utilities, you can easily choose when to show or hide particular elements.

For navbars that never collapse, add the expand boolean property on the c-navbar. For navbars that always collapse, don't add any property.

Toggler

Navbar togglers are left-aligned by default, but should they follow a sibling element like a cNavbarBrand, they'll automatically be aligned to the far right. Reversing your markup will reverse the placement of the toggler. Below are examples of different toggle styles.

With no cNavbarBrand shown at the smallest breakpoint:

With a brand name shown on the left and toggler on the right:

With a toggler on the left and brand name on the right:

External content

Sometimes you want to use the collapse plugin to trigger a container element for content that structurally sits outside of the c-navbar.

Do not forget about users of assistive technologies. In this case you should move the focus programmatically to the opened container. Make sure that the toggler has also the aria-controls attribute, pointing to the id of the content container.

Offcanvas

Transform your expanding and collapsing navbar into an offcanvas drawer. You can extend both the offcanvas default styles and use our expand="*" prop to create a custom navigation sidebar.

In the example below, to create an offcanvas navbar that is always collapsed across all breakpoints, omit the expand="*" prop entirely.

To create an offcanvas navbar that expands into a normal navbar at a specific breakpoint like xl, use expand="xl" property.

Customizing

CSS variables

Angular navbar uses local CSS variables on .navbar for enhanced real-time customization. Values for the CSS variables are set via Sass, so Sass customization is still supported, too.

Some additional CSS variables are also present on .navbar-nav:

How to use CSS variables

SASS variables

API reference

Navbar Module

c-navbar

component

Inputs

c-navbar-nav

component

Inputs

c-navbar-text

component

cNavbarToggler

directive

Inputs

cNavbarBrand

directive