Package Exports
- @finnan444/material-ui-daterange-picker
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@finnan444/material-ui-daterange-picker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Material UI DateRange Picker
A react date range picker implementation using @material-ui.
Preview
Usage
npm i @finnan444/material-ui-daterange-picker
# or with yarn
yarn add @finnan444/material-ui-daterange-picker
Basic example
import React from "react";
import { DateRangePicker, DateRange } from '@finnan444/material-ui-daterange-picker';
type Props = {}
const App: React.FC<Props> = props => {
const [open, setOpen] = React.useState(false);
const [dateRange, setDateRange] = React.useState<DateRange>({});
const toggle = () => setOpen(!open);
return (
<DateRangePicker
open={open}
toggle={toggle}
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 |
---|---|---|---|---|
onChange |
(DateRange) => void |
required | - | handler function for providing selected date range |
toggle |
() => void |
required | - | function to show / hide the DateRangePicker |
initialDateRange |
DateRange |
optional | {} |
initially selected date range |
minDate |
Date |
optional | 10 years ago | min date allowed in range |
maxDate |
Date |
optional | 10 years from now | max date allowed in range |
locale |
Locale |
optional | enGB | the locale for date calculation |
definedRanges |
DefinedRange[] |
optional | - | custom defined ranges to show in the list |
closeOnClickOutside |
boolean |
optional | true |
defines if DateRangePicker will be closed when clicking outside of it |
wrapperClassName |
object |
optional | undefined |
defines additional wrapper style classes |