@rolfkoenders/react-daterange-picker

react-daterange-picker

A react date range picker using material-ui components.

Live Demo: https://flippingbitss.github.io/react-daterange-picker/

Usage

npm install @rolfkoenders/react-daterange-picker --save
# or with yarn
yarn add @rolfkoenders/react-daterange-picker

Basic Example

import React from "react";
import {
  DateRangePicker,
  DateRange,
} from "@rolfkoenders/react-daterange-picker";

type Props = {};
type State = {
  open: boolean;
  dateRange: DateRange;
};

class App extends React.Component<Props, State> {
  state = {
    open: true,
    dateRange: {},
  };

  render() {
    return (
      <DateRangePicker
        open={this.state.open}
        onChange={(range) => this.setState({ dateRange: range })}
      />
    );
  }
}

export default App;

Basic example using hooks

import React from "react";
import {
  DateRangePicker,
  DateRange,
} from "@rolfkoenders/react-daterange-picker";

type Props = {};

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

  return (
    <DateRangePicker open={open} 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 | | :----------------- | :-------------------- | :--------- | :------------ | :------------------------------------------------- | ------------------------- | | initialDateRange | DateRange | | {} | initially selected date range | | minDate | Date | string | | 10 years ago | min date allowed in range | | maxDate | Date | string | | 10 years from now | max date allowed in range | | onChange | (DateRange) => void | required | - | handler function for providing selected date range | | definedRanges | DefinedRange[] | | - | custom defined ranges to show in the list |