Usable, dynamic React Timezone Select
npm install cads-timezone-select
Another react timezone select component, I know.. However this one has a few key benefits!
While looking around for a good option, I had trouble finding a timezone select components which:
1) Adjusted the choices automatically with Daylight Savings Time (DST)
2) Didn't have a huge list of choices to scroll through when technically only 24 (ish) are necessary
#### Demo: ndom91.github.io/react-timezone-select
> This demo is also available in the ./examples directory. Simply run npm start in the root of the repository after installing everything in the examples subdirectory and snowpack dev will begin, where you can find the demo at localhost:8080.
We also have some more examples available on Codesandbox using this component with the datetime library spacetime (example) as well as with moment (example), as well as in Typescript using the new Intl browser API (example) showing how one might use this component in a real application.
``bash`
npm install react-timezone-select
`jsx
import React, { useState } from "react"
import ReactDOM from "react-dom"
import TimezoneSelect from "react-timezone-select"
const App = () => {
const [selectedTimezone, setSelectedTimezone] = useState({})
return (
Please make a selection
const rootElement = document.getElementById("root")
ReactDOM.render(
`
If you'd like the user's own timezone to be set as the initially selected option on render, we can make use of the new Intl browser API by setting the default state value to Intl.DateTimeFormat().resolvedOptions().timeZone.
`jsx`
const [timezone, setTimezone] = useState(
Intl.DateTimeFormat().resolvedOptions().timeZone
)
Thanks @ndrwksr!
For now, Next.js isn't great about handling ESM packages. Until this gets fixed, there is a workaround for using this and other ESM packages via next-transpile-modules.
`js
// next.config.js
const withTM = require("next-transpile-modules")(["react-timezone-select"])
module.exports = withTM({
// ...further Next.js config
})
`
Update: Next.js 11.1.0 now supports ESM packages natively! Until 12.0.0 you need to include esmExternals: true in your next.js.config though.
You can append custom choices of your own, or fully replace the listed timezone options.
The timezones prop takes a dictionary of timezones. Don't worry, we'll prepend the (GMT...) part, you just have to pass the city(s) or region(s) you want in your label.
`jsx`
import TimezoneSelect, { allTimezones } from "react-timezone-select"
;
onChange={setSelectedTimezone}
timezones={{
...allTimezones,
"America/Lima": "Pittsburgh",
"Europe/Berlin": "Frankfurt",
}}
/>
The above example will generate two additional choices in the select options, one with the label '(GMT-5:00) Pittsburgh' and another with '(GMT+1:00) Frankfurt'. You can omit spreading in the allTimezones object and then only your custom timezone options get rendered in the select component.
- value - Initial Timezone string, i.e. 'Europe/Amsterdam' or the full object from the onChange function: { value: string, label: string, abbrev: string, altName: string }
- - () => void
- - (timezone) => void
- Example parameter:`
{
value: 'America/Juneau'
label: '(GMT-8:00) Alaska,
abbrev: 'AHST',
offset: -8,
altName: 'Alaskan Standard Time'
}
- - 'original' | 'altName' | 'abbrev'
- - Custom Timezone Objectreact-select
- Any other props
Pull requests are always welcome! Please stick to the prettier` settings, and if adding new features, please consider adding test(s) and documentation where appropriate!
- All Contributors
- Carlos Matallin
- spacetime
- react-select