2.0.6 • Published 5 years ago

yardtp-datetimepicker v2.0.6

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

yardtp-datetimepicker - Yet Another React Datetime Picker

yardtp-datetimepicker is a blazingly unbenchmarked Datetime Picker component for React 16.8+ focusing on simplicity and accessiblity.

NPM SIZE

Install

npm install --save yardtp-datetimepicker

Dependencies

  • Version date-fns
  • Version react-jss

Peer Dependencies

  • npm version React 16.8+ (hooks)

Usage

Go to Live Examples

import React from 'react';
import { DatePicker, useDatePickerState } from 'yardtp-datetimepicker/';
import format from 'date-fns/format';

// EXAMPLE 1: DatePicker basic usage

export default function Example1 (props) {

    // useDatePickerState will default to today
    const state = useDatePickerState(); 
    // The output of useDatePickerState is an array with values and setFunctions for 
    // the currently selected day and the date for the calendar to display
    const [selectedValue, setSelectedValue, calendarValue, setCalendarValue] = state;

    return (
        <>
        {format(selectedValue, 'MMMM d, y')} - {format(calendarValue, 'MMMM d, y')}
        <DatePicker state={state} />
        </>
    );
}

Options

DateTimePicker

NameDefault
stateThis is an array containing: selected datetime, set selected datetime function, calendar display datetime, set calendar display datetime function. You can create this via the helper function useDatePickerState, or by spreading two useState calls (...useState(selectedDateTime), ....useState(calendarDateTime)). State is passed through to both DatePicker and TimePicker, and is therefor common to both.

The props listed below can be passed to DateTimePicker and will be passed through to DatePicker and TimePicker.

DatePicker

NameDefault
earliestDate01/01/0001The earliest selectable datetime. Expects a vanilla Javascript Date object.
latestDate12/31/9999The latest selectable datetime. Expects a vanilla Javascript Date object.
monthFormat"MMMM"Format that gets passed to date-fns format function when displaying the month. See: Unicode Date Field Symbol Table
yearFormat"yyyy"Format that gets passed to date-fns format function when displaying the year. See: Unicode Date Field Symbol Table

TimePicker

NameDefault
restrictTimeToDaytrueIf true, the Selected Calendar Day won't advance to next day when the time selected increases past 12:00am, nor retreat to the previous day when selected time decreases before 12:00am.
intervalStep15Number of minutes to advance or retreat the selected time.
format"p"Format that gets passed to date-fns format function when displaying the time. See: Unicode Date Field Symbol Table

Styling

See: https://nuclearhorsestudios.github.io/yardtp-datetimepicker/#styling

License

MIT © Michael Lasky

2.0.6

5 years ago

2.0.5

5 years ago

2.0.4

5 years ago

2.0.3

5 years ago

2.0.2

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.2.3

5 years ago

1.2.2

5 years ago

1.2.1

5 years ago

1.2.0

5 years ago

1.1.1

5 years ago

1.1.0

5 years ago

1.0.12

5 years ago

1.0.11

5 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago