Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 4.34 KB

README.md

File metadata and controls

119 lines (82 loc) · 4.34 KB
Raw

React Date Picker

npm version npm

The Headless Datepicker is a powerful and flexible tool designed for ReactJS applications. It allows developers to create customizable and visually appealing datepickers with ease. Unlike traditional datepickers, this component is "headless," meaning it provides the core functionality and logic while allowing developers to design their own user interface.

Features

  • Datepicker, Hourpicker, and Calendar Modes: The component supports multiple modes, including datepicker, hourpicker, and calendar modes, allowing users to select dates, hours, or navigate through a full calendar.

  • Headless Design: The component follows a headless architecture, separating the logic from the presentation layer. This enables developers to design and customize the user interface according to their application's specific needs.

  • Multi Picker Support: The component allows for nesting multiple pickers within each other, enabling advanced and complex selection scenarios.

  • Keyboard Navigation: Users can easily navigate and interact with the datepicker using keyboard shortcuts, enhancing accessibility and improving the user experience.

  • Written in TypeScript with Type Support: The component is written in TypeScript, providing strong typing and enabling developers to benefit from type-checking during development.

  • Support for other Calendar Types with Config: The component provides support for other calendar types through configuration options. Developers can customize the calendar type based on their requirements.

  • Built-in Config for Jalali Calendar: The component comes with a built-in configuration for the Jalali calendar, making it easy to implement and use the Jalali calendar system.

Installation

The package can be installed via npm:

npm install headless-datetimepicker --save

Or via yarn:

yarn add headless-datetimepicker

Usage

Import Datepicker component

import { Datepicker } from 'headless-datetimepicker';

Basic example

<Datepicker>
  <Datepicker.Input />
  <Datepicker.Picker defaultType="day">
    {({ monthName, hour, minute, year }) => (
      <>
        <Datepicker.Button action="prev">Prev</Datepicker.Button>
        <Datepicker.Button action="next">Next</Datepicker.Button>
        <Datepicker.Items>
          {({ items }) =>
            items.map((item) => (
              <Datepicker.Item key={item.key} item={item} action="close">
                {item.text}
              </Datepicker.Item>
            ))
          }
        </Datepicker.Items>
      </>
    )}
  </Datepicker.Picker>
</Datepicker>

Using other calendar types (e.g., Jalali) with Headless Datepicker

The Headless Datepicker library provides the flexibility to support various calendar types, allowing you to tailor the datepicker based on your specific regional requirements. To use a custom calendar type or the built-in Jalali calendar, follow these simple steps:

Configuration Object

Manually create a configuration object for your desired calendar type or use the internal Jalali configuration provided by the library.

  • For the Jalali calendar:

    import { config } from 'headless-datetimepicker/jalali';

  • For custom calendar:

    create a config object base on config

Pass Configuration to Datepicker

Use the config prop to pass your configuration to the Datepicker component.

<Datepicker config={config}>...</Datepicker>

The configuration object should remain unchanged during React re-renders to maintain consistent behavior, and it's recommended to declare it outside the component to avoid unnecessary re-creations.

Documentation

Please see the https://aliakbarazizi.github.io/headless-datepicker/

License

Licensed under MIT license, see LICENSE for the full license.