materialui-daterange-picker

Material UI DateRange Picker

A react date range picker implementation using @material-ui.

Live Demo

Check out the project running at https://pedro-lb.github.io/materialui-daterange-picker/

Usage

npm install materialui-daterange-picker --save

# or with yarn
yarn add materialui-daterange-picker

Basic example

import React from "react";
import { DateRangePicker, DateRange } from "materialui-daterange-picker";

type Props = {}

const App: React.FunctionComponent<Props> = props => {
  const [open, setOpen] = React.useState(false);
  const [dateRange, setDateRange] = React.useState<DateRange>({});

  const toggle = () => setOpen(!open);

  return (
    <DateRangePicker
      open={open}
      toggle={toggle}
      onChange={(range) => setDateRange(range)}
    />
  );
}

export default App;

Types

interface DateRange {
    startDate?: Date,
    endDate?: Date
}

interface DefinedRange {
    label: string,
    startDate: Date,
    endDate: Date
}

Props

Name	Type	Required	Default value	Description
onChange	(DateRange) => void	required	-	handler function for providing selected date range
toggle	() => void	required	-	function to show / hide the DateRangePicker
initialDateRange	DateRange		{}	initially selected date range
minDate	`Date	string`		10 years ago
maxDate	`Date	string`		10 years from now
definedRanges	DefinedRange[]		-	custom defined ranges to show in the list
definedRanges	DefinedRange[]		-	custom defined ranges to show in the list
closeOnClickOutside	boolean		true	defines if DateRangePicker will be closed when clicking outside of it
wrapperClassName	object			defines additional wrapper classes