Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@meinefinsternis/react-horizontal-date-picker

meinefinsternis2.1kMIT1.0.1TypeScript support: included

A simple component that allows the user to choose a date from a scrollable monthly view.

react, datepicker, swipeable-datepicker, calendar, datetime, swipeable-calendar, range datepicker, react range datepicker, horizontal-calendar

readme

alt text

Installation

The package can be installed via npm:

npm install @meinefinsternis/react-horizontal-date-picker --save

Below is a simple example of how to use the Datepicker in a React view.

import React from "react";
import { Datepicker, DatepickerEvent} from "@meinefinsternis/react-horizontal-date-picker";
import { enUS } from "date-fns/locale";

const Example = () => {
  const [date, setDate] = React.useState<{
    endValue: Date | null;
    startValue: Date | null;
    rangeDates: Date[] | null;
  }>({
    startValue: null,
    endValue: null,
    rangeDates: [],
  });

  const handleChange = (d: DatepickerEvent) => {
    const [startValue, endValue, rangeDates] = d;
    setDate((prev) => ({ ...prev, endValue, startValue, rangeDates }));
  };

  return (
    <Datepicker
      onChange={handleChange}
      locale={enUS}
      startValue={date.startValue}
      endValue={date.endValue}
    />
  );
};

Props

Common props you may want to specify include:

  • locale: Locale - locales directly exported from date-fns/locales.
  • onChange: (d: [Date | null, Date | null, Date[] | null]) => void - subscribe to change events
  • startValue: Date | null - defines the initial start value
  • endValue: Date | null - defines the initial end value
  • startDate?: Date - defines minimum date. Default new Date().
  • endDate?: Date - defines maximum date. Default new Date() + 3 months
  • className?: object - apply a className to the customize
  • disabledDates?: Date[] - list of disabled dates

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.0.1 (2022-09-30)

1.0.0 (2022-09-30)