Skip to content

jozefcipa/react-tpick

Repository files navigation

react-tpick

Actions Status semantic-release

NPM

A dead simple time picker component for React

Installation

The package can be installed via npm:

npm install react-tpick --save

Or via yarn:

yarn add react-tpick

This package requires react and styled-components installed

Example

import React from 'react'
import { TimePicker } from 'react-tpick'

const TimePickerDemo = () => {
  const [time, setTime] = React.useState({ hours: 10, minutes: 45 })

  return (
    <TimePicker
      hours={time.hours}
      minutes={time.minutes}
      onChange={({ hours, minutes }) => {
        console.log(`New time is ${hours}:${minutes}`)
        setTime({ hours, minutes })
      }}
    />
  )
}

Properties

Name Type Description Required
hours Number (0-23) Specifies hours Yes
minutes Number (0-59) Specifies minutes Yes
onChange ({ hours, minutes }) => void Time change handler function Yes
hoursStep Number (1-23) Specifies hours step. Default is 1 No
minutesStep Number (1-59) Specifies minutes step. Default is 1 No