1.0.10 • Published 5 years ago

@shinabr2/react-material-daterange-picker v1.0.10

Weekly downloads
12
License
MIT
Repository
github
Last release
5 years ago

react-daterange-picker

A react date range picker using material-ui components.

Live Demo

Usage

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

Basic Example

import React from "react";
import { DateRangePicker, DateRange } from "@shinabr2/react-material-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 "@shinabr2/react-material-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

NameTypeRequiredDefault valueDescription
initialDateRangeDateRange{}initially selected date range
minDateDate | string10 years agomin date allowed in range
maxDateDate | string10 years from nowmax date allowed in range
onChange(DateRange) => voidrequired-handler function for providing selected date range
definedRangesDefinedRange[]-custom defined ranges to show in the list