Sidebar Skeleton

Simple and fast sidebar skeleton built on Bootstrap 5.

Installation

npm install sidebar-skeleton-compostrap

Usage

Import the styles and initialize the components in your JavaScript entry point:

import 'sidebar-skeleton-compostrap/sidebar.css';
import { SidebarSkeleton } from 'sidebar-skeleton-compostrap';

// Initialize both Sidebar and ThemeSwitcher
SidebarSkeleton.init();

Alternatively, you can initialize components individually:

import { Sidebar, ThemeSwitcher } from 'sidebar-skeleton-compostrap';

Sidebar.init();
ThemeSwitcher.init();

Built on

• Bootstrap 5

Demo

• Live demo

Introduction

Simple and fast sidebar skeleton is built on Bootstrap. You should be familiar with Bootstrap usage and have basic knowledge of Sass, npm.

Customize sidebar when navbar is used

When using a navbar, extend the class called wrapper:

Navbar	Class
unused	wrapper
Used	wrapper-navbar-used
Used (fixed)	wrapper-navbar-fixed

Other classes

Description	Class
Right top rounded in sidebar	sidebar-rounded-top-right
Fixed menu in sidebar	sidebar-menu-fixed

Sidebar themes

The sidebar supports light and dark themes via the data-sidebar-theme attribute. The theme switcher (theme-switcher.js) automatically persists the user's choice in the browser's localStorage, so the selected theme is remembered on subsequent visits.

Theme	Attribute
Light	data-sidebar-theme="light"
Dark	data-sidebar-theme="dark"

Sidebar menu toggle

If you want your own toggle button visible at all resolutions, update the class in sidebar.js:

Description	Class
Visible in small devices	sidebar-toggle
Visible all resolution	sidebar-toggle-visible