@maxstudener/react-mui-daterange-picker
TypeScript icon, indicating that this package has built-in type declarations

0.0.2 • Public • Published

react-daterange-picker

A react date range picker using mui components forked from react-daterange-picker.

This repo was converted to use mui v5 instead of material-ui. It also removed modal functionality and made it a regular component.

Preview

Usage

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

Basic Example

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

type Props = {}
type State = {
    dateRange: DateRange
}

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

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

export default App;

Basic example using hooks

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

type Props = {}

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

	return (
		<DateRangePicker
			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 10 years ago min date allowed in range
maxDate Date 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

Package Sidebar

Install

npm i @maxstudener/react-mui-daterange-picker

Weekly Downloads

23

Version

0.0.2

License

MIT

Unpacked Size

227 kB

Total Files

45

Last publish

Collaborators

  • maxstudener