@borgestj/react-daterange-picker-ptbr
v0.0.3
Published
A react date range picker using Material Design PT-BR
Downloads
3
Maintainers
Readme
react-daterange-picker-ptBR
A react date range picker using material-ui components in ptBR.
Usage
npm install @borgestj/react-daterange-picker-ptbr --save
# or with yarn
yarn add @borgestj/react-daterange-picker-ptbr
Basic Example
import React from 'react';
import {
DateRangePicker,
DateRange,
} from '@borgestj/react-daterange-picker-ptbr';
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 '@borgestj/react-daterange-picker-ptbr';
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 | min date allowed in range |
| maxDate
| Date | string
| | 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 |