gp-react-daterange-picker
TypeScript icon, indicating that this package has built-in type declarations

1.0.10 • Public • Published

gp-react-daterange-picker

A react date range picker using material-ui components.

Latest npm version

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

Usage

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

Screenshot

Basic Example

import React from "react";
import { DateRangePicker, DateRange } from "gp-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 "gp-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
maxDate `Date string` 10 years from now
onChange (DateRange) => void required - handler function for providing selected date range
definedRanges DefinedRange[] - custom defined ranges to show in the list
handleApply () => void - handler for Apply action
handleCancel () => void - handler for Cancel action

Package Sidebar

Install

npm i gp-react-daterange-picker

Weekly Downloads

18

Version

1.0.10

License

MIT

Unpacked Size

274 kB

Total Files

46

Last publish

Collaborators

  • ricardopaul