/atom-clock

Place a clock or calendar in your status bar

Primary LanguageJavaScriptMIT LicenseMIT

atom-clock

Travis! AppVeyor! Deps! Installs! Version! License

Display a customizable clock in the status bar.

Installation

The clock can be installed through Atom. Alternatively, you can use apm:

apm install atom-clock

Features

  • Customizable time format and locale: any format and locale supported by moment.js is supported by atom-clock as well!
  • i18n: specify any locale to get the date in your language.
  • UTC time: show the UTC time instead of the local time.
  • Multi-platform package: the clock works with Linux, Windows and macOS.

Settings

Time format

It specifies the format to use when displaying the time. The package uses moment.js to format the time, so please refer to the related moment.js documentation. The default value for the time format is H:mm.

Locale

It specifies the locale the clock will use when displaying the time. Its default value is en. Please check the moment.js locale folder for a complete list of all supported locales.

Clock interval

It specifies how many seconds should run between two time updates, and it is defaulted to 60 (one update per minute).

Tooltip

If enabled, a tooltip will be shown when you hover over the time in the status bar to display the time in an alternate format. By default the tooltip is disabled, and the format is LLLL.

UTC

If enabled, both the status bar clock and the tooltip clock (if enabled) will display UTC time instead of local time.

Show icon

If ticked, a clock icon will be shown to the left of the time. It is unticked by default.

Some examples

format description display
H:mm default date format Default format
h:mm a am/pm format AM/PM format
DD/MM/YYYY, H:mm short date format Short format
MMMM Do, dddd, h:mm:ss a long date format Long format
[Quarter] Q, MMMM Do YYYY, ddd, h:mm a space waster format Useless format

Locales

When a different locale is specified in the settings, the date language will change accordingly. A locale can be defined with its substring, and moment.js will take care of selecting the first locale it knows. A substring can be specified in many ways. As example, the Chinese locale for China can be expressed as zh-cn, zh_cn, zh-CN or zh_CN.

Here are some examples for locales different from English.

locale code display
Arabic ar Arabic
Belarusian be Belarusian
Tibetan bo Tibetan
Russian ru Russian
Chinese zh_CN Chinese_China

Tooltip

When enabled, the tooltip will contain an extended (and configurable) version of the current time/date.

Tooltip appearance

Contributing

Like what you see? Please, feel free to fork this repository, and make any change you like. If you want to propose a nice feature, please create a separate branch on your fork, named after the feature you want to implement, then make a pull request from that branch. Also, before actually getting to work, just consider I'm trying to keep this package as simple and minimal as possible!

Save the clock tower!

Beerpay Beerpay Flattr this git repo

Save the clock