Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

react-time-input-polyfill

1.0.1 • Public • Published

react-time-input-polyfill

hits per month badge

This is a pre-built, plug-and-play, fully accessible React component that will produce an <input type="time"> element with a built in polyfill for IE and Safari support.

  • ✔️ Modeled after the Chrome 78 and Firefox 70 desktop implementations.
  • ✔️ Fully keyboard and screen reader accessible.
  • ✔️ Sends back the same values as real time inputs (24 hour time).
  • ✔️ Only downloads the full polyfill code in the browsers that need it

You may have already come across the plain JavaScript version. This is not just a wrapper component though. This package was built from the ground up in React, for React. It does import some functionality from the original though where it made sense to.

You can view a demo of react-time-input-polyfill in action here: https://dan503.github.io/react-time-input-polyfill/

You can view a demo of the original plain javascript version here: https://dan503.github.io/time-input-polyfill/

Install

The component needs an ES6 compatible environment to run in. It also needs React installed on the project. Take a look at create-react-app to get started with React.

You can then install this polyfill component with npm:

npm i react-time-input-polyfill

Usage

/* TimeInput.js */
 
import React from 'react'
 
// Import the component into your project
import TimeInputPolyfill from 'react-time-input-polyfill'
 
export const TimeInput = ({ label, currentValue, onInputChange }) => {
    return (
        <label>
            <span>{label}</span>
            <TimeInputPolyfill
 
                // set the value through props
                value={currentValue}
 
                // onChange will run every time the value is updated
                onChange={({ value, element }) => {
                    console.log({
 
                        // The current value in 24 hour time format
                        value,
 
                        // The <input> HTML element
                        element,
 
                    })
 
                    // Export the new value to the parent component
                    onInputChange(value)
                }}
            />
        </label>
    )
}
/* ExampleForm.js */
 
import React, { useState } from 'react'
 
// import your local time input component into your form component
import { TimeInput } from './TimeInput'
 
export const ExampleForm = ()=> {
 
    // Use state to keep track of the value
    const [inputValue, setInputValue] = useState('20:30') // default to 8:30 PM
 
    return (
        <form>
            <TimeInput
                label="Label text"
 
                // Use the state value to set the time
                currentValue={inputValue}
 
                // Use the set state function to update the time when it changes
                onInputChange={ newValue => setInputValue(newValue) }
            />
            <button type="submit">Submit</button>
        </form>
    )
}

You can also force-enable the polyfill so that it is active in modern browsers that support <input type="time"> natively. This is helpful when it comes to debugging since it gives you access to modern dev tools (just make sure to disable it again when you are done).

/* TimeInput.js */
 
import React from 'react'
import TimeInputPolyfill from 'react-time-input-polyfill'
 
export const TimeInput = ({ label, currentValue, onInputChange }) => {
    return (
        <label>
            <span>{label}</span>
            <TimeInputPolyfill
                value={currentValue}
 
                /*  Force browsers that support input[type=time]
                    to use the polyfill.
                    (useful for testing and debugging)
                */  forcePolyfill={true}
 
                onChange={({ value, element }) => {
                    onInputChange(value)
                }}
            />
        </label>
    )
}

Install

npm i react-time-input-polyfill

DownloadsWeekly Downloads

48

Version

1.0.1

License

MIT

Unpacked Size

2.03 MB

Total Files

50

Last publish

Collaborators

  • avatar