timezone-picker-svelte
v1.0.2
Published
Timezone picker for Svelte
Downloads
15
Readme
Updated/Extended version of svelte-timezone-picker
Timezone Picker Svelte
You need a timezone picker that will allow the user to pick a timezone from a list. You want it to be accessible and follow the ARIA design pattern for a select.
This is a component that controls all user interactions and state for you. It follows best practices and accessibility guidelines.
The timezones are all valid IANA time zones.
Installation
This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies:
yarn add timezone-picker-svelte
npm i timezone-picker-svelte
If you are going to use the svelte component, make sure you have svelte installed as well.
Usage
Svelte component
To use it in your Svelte app, simply import it as a component.
<script>
import TimezonePicker from 'timezone-picker-svelte'
let timezone = 'Europe/London'
function update(ev) {
console.log(ev.detail.timezone)
}
</script>
<TimezonePicker {timezone} on:update="{update}" />
Props
| Property | Type | Required? | Description | Default |
| :----------------- | :------ | :-------: | :------------------------------------------------------------------------------- | :------------------------------------------------- |
| timezone
| String | | The current timezone. Must be a valid timezone from IANA. | Intl.DateTimeFormat().resolvedOptions().timeZone
|
| expanded
| Boolean | | Whether the dropdown should be automatically expanded or not. | false
|
| allowedTimezones
| Array | | Control which timezones display in the list. Must be a valid timezone from IANA. | null
|
Events
| Name | Description | Return |
| :------- | :--------------------------------------------- | :------------------------------------ |
| update
| Dispatched every time you change the timezone. | An object with the selected timezone. |
Styling
You can use CSS variables to style the DOM elements of timezone-picker.
:root {
--color-white: #fff;
--color-info-900: #076196;
--color-gray-100: rgba(0, 0, 0, 0.2);
--color-gray-400: #acacac;
--color-gray-600: #757575;
--color-gray-900: #292929;
}
License
MIT License - fork, modify and use however you want.