logo
DocsIntroduction

Introduction

nepali-bs-calendar-react is a lightweight, responsive React Nepali Bikram Sambat calendar and date picker component.

This package provides a Nepali BS date picker with support for dynamic calendar data via React Context, static calendar components, controlled values, and custom styling overrides.

Key Features

  • Dynamic Calendar Data: Provide custom calendar data via React Context.
  • Static Calendar: Support for rendering static (non-popup) calendar components.
  • Bikram Sambat Dates: Full support for Nepali BS calendar dates.
  • Validation & Limits: Minimum and maximum date limits, disabled dates, and custom date disabling logic.
  • Validation Feedback: Support for form error messages and touched state.
  • Responsive Popup: Auto-adjusts positioning, stays in viewport, and uses portal-based rendering.
  • CSS Variable Styling: Customize the layout and colors with ease using CSS variables.

New in Version 1.0.0

  • Stable v1.0.0 release.
  • Added support for the custom calendarComponent prop.
  • Improved portal-based dropdown rendering and responsive positioning behavior.

Example

View the example here

Preview

Interactive Demo

Baisakh 2076
Sun
Mon
Tue
Wed
Thu
Fri
Sat
 TSXimport { Calendar } from 'nepali-bs-calendar-react'

export default function Demo() {
  return <Calendar onChange={(date) => console.log(date)} />
}