1.0.1 • Published 1 year ago

react-mui-daterange-picker v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

react-daterange-picker

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

This repo was converted to use MUI's tree shaking feature to reduce the bundle size.

Preview

Usage

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

Basic Example

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

NameTypeRequiredDefault valueDescription
initialDateRangeDateRange{}initially selected date range
minDateDate10 years agomin date allowed in range
maxDateDate10 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