Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 1.75 KB

README.md

File metadata and controls

55 lines (39 loc) · 1.75 KB
Raw

react-native-device-time-format

This package was inspired by react-native-device-clock-format, which is "no longer actively maintained", and only supported iOS.

On mobile devices users have the option to opt in, or out, pf the predefined locale used for their language settings (12/24 hour clock):

12/24 time format iOS settings

This package exposes this device setting for iOS & Android.

Supported platforms

  • iOS
  • Android
  • Windows

Getting started

Install with your preferred package manager:

yarn add react-native-device-time-format

or

npm install react-native-device-time-format --save

And link the module by:

react-native link react-native-device-time-format

Should the automatic linking fail (in case of folder structure mismatch or various other reasons), please follow the manual installation guide.

Usage

Bellow is an example of fetching the hours & minutes string representation from a date, with the device time format (using moment for date/time formatting):

import DeviceTimeFormat from 'react-native-device-time-format'
import moment from 'moment'

/**
 * @function getCurrentHourFormat
 * @param  {Date} date Date to format
 * @return {Promise<string>} formatted string HH:mm / h:mm A, depending on device setting
 */
const getCurrentHourFormat = async (date) => {
  const using24HourFormat = await DeviceTimeFormat.is24HourFormat()
  return moment(date).format(using24HourFormat ? 'HH:mm' : 'h:mm A'))
}

All native modules runs asynchronous, we suggest updating an internal state in your app when AppState changes to active.