react-hook-pickers v0.2.2

React Hook Pickers

Have you ever get tired of customizing the date and time pickers provided by the libraries? And you thought of building your own date picker, however you also don't have that much time or it's painful to build everything from scratch for you. All you just want to do is custom UI and forget about the state handling, generating the dates for each month, years, etc. But your UI/UX designers won't let you, because their design is cool. Here's the react-hook-pickers to rescue you from all the hassle.

react-hook-pickers provide hooks for building Custom Date Picker UI without worrying about handling states. This library is inspired by react-hook-form and downshift.

Installation

npm i react-hook-pickers

Usage

DatePicker

react-hook-pickers gives two primitive hooks for building date pickers, useDatePickerState and useDatePicker.

useDatePickerState

useDatePickerState exposes the necessary states that useDatePicker is needed. You can also control the states exposed by useDatePickerState hook too.

import { useDatePickerState } from 'react-hook-pickers'

const initialDate = new Date()
const datePickerStates = useDatePickerState(initialDate)

useDatePicker

This is the actual UI building block for the date picker. It exposes getCalendarProps and getCalendarViewControllers functions to build the DatePicker UI. getCalendarProps will give you the necessary data and props that is needed to build a Calendar UI. getCalendarViewControllers will give you the utilities functions to control the Calendar UI. While getCalendarViewControllers is not necessary if you know what you are doing, you can directly control the states given by the useDatePickerState.

import { useDatePickerState, useDatePicker } from 'react-hook-pickers'

const initialDate = new Date()
const datePickerStates = useDatePickerState(initialDate)
const { today, getCalendarProps, getCalendarViewControllers } = useDatePicker(
  datePickerStates,
)

DatePickerProvider and useDatePickerProvider

This is the Context wrapper for the useDatePicker. You just provide datePickerState from the useDatePickerState to DatePickerProvider and you can use useDatePickerProvider anywhere inside it. With this, you can forget about props drilling.

import {
  useDatePickerState,
  DatePickerProvider,
  useDatePickerProvider,
} from 'react-hook-pickers'

const ChildComponent = () => {
  const {
    datePickerState,
    today,
    getCalendarProps,
    getCalendarViewControllers,
  } = useDatePickerProvider()
  return <>...</>
}

const ParentComponent = () => {
  const initialDate = new Date()
  const datePickerState = useDatePickerState(initialDate)
  return (
    <DatePickerProvider datePickerState={datePickerState}>
      <ChildComponent />
    </DatePickerProvider>
  )
}

Example

API

• useDatePickerState function, required parameter Date object as initial date.

// useDatePickerState hook return values
selectedDate: Date;
viewDate: Date;
setSelectedDate: React.Dispatch<React.SetStateAction<Date>>;
setViewDate: React.Dispatch<React.SetStateAction<Date>>;
reset: () => void;

• useDatePicker function, required return values of useDatePickerState.

// useDatePicker hook return values
today: Date
getCalendarProps: () => {
    daysOfWeek: {
        DDDD: DDDD;
        DDD: DDD;
        D: D;
    }[];
    months: {
        MMMM: MMMM;
        MMM: MMM;
    }[];
    datesOfMonthBtnProps: ({ onClick, btnProps }: CalendarBtnProps) => {
      key: string;
      id: string;
      'data-testid': string;
      'data-day': 0 | 1 | 2 | 3 | 4 | 5 | 6;
      'data-date': string;
      children: string;
      isToday: boolean;
      isSelected: boolean;
      ...;
    }[];
    fillUpDatesOfPrevMonthBtnProps: ({ onClick, btnProps, }: CalendarBtnProps) => {
      key: string;
      id: string;
      'data-testid': string;
      'data-day': 0 | 1 | 2 | 3 | 4 | 5 | 6;
      'data-date': string;
      children: string;
      isToday: boolean;
      isSelected: boolean;
      ...;
    }[];
    fillUpDatesOfNextMonthBtnProps: ({ onClick, btnProps, }: CalendarBtnProps) => {
      key: string;
      id: string;
      'data-testid': string;
      'data-day': 0 | 1 | 2 | 3 | 4 | 5 | 6;
      'data-date': string;
      children: string;
      isToday: boolean;
      isSelected: boolean;
      ...;
    }[];
}
getCalendarViewControllers: () => {
  goToMonth: (month: Month) => void;
  goToYear: (year: number) => void;
  goToPrevMonth: () => void;
  goToNextMonth: () => void;
  goToToday: () => void;
  goToSelectedDate: () => void;
  resetCalendarView: () => void;
}

Types

// date
type D = 'S' | 'M' | 'T' | 'W' | 'F' // days of week shortest name
type DDD = 'Sun' | 'Mon' | ... | 'Sat' // days of week short names
type DDDD = 'Sunday' | 'Monday' | ... | 'Saturday' // days of week full names
type DateNumber = 1 | 2 | 3 | ... | 31 // all available dates
// month
type MMM = 'Jan' | 'Feb' | ... | 'Dec' // month short names
type MMMM = 'January' | 'February' | ... | 'December' // month full names
type Month = 0 | 1 | 2 | ... | 11 // JavaScript month indexes

Roadmap

• Date Picker (WIP)
• Documentation
• Date Range Picker (although it is possible to build date range picker with the current useDatePickerState hook, it would be nice to give the pre configured hooks for the date range picker.)
• Accessibility
• Time Picker
• Primitive UI Components