use-date-formatter

use-date-formatter is a library for formatting and managing dates in React applications. It provides a context and a hook to simplify date handling with custom formatting and localization settings.

Installation

You can install the package using npm:

npm i use-date-formatter

Usage

Context Provider

Wrap your application with the DateFormatterProvider to configure date, time formats, and localization:

import React from 'react';
import { DateFormatterProvider } from 'use-date-formatter';

const App = () => {
    return (
        <DateFormatterProvider formatDate="dd/MM/yyyy" formatTime="HH:mm:ss" locale="en">
            {/* Your application */}
        </DateFormatterProvider>
    );
};

export default App;

Hook useDateFormatter

The useDateFormatter hook provides functions to format and manipulate dates:

import React from 'react';
import { useDateFormatter } from 'use-date-formatter';

const ExampleComponent = () => {
    const { getNowDate, dateToString, formatToUtc } = useDateFormatter();

    return (
        <div>
            <p>Current date: {getNowDate()}</p>
            <p>Formatted date: {dateToString(new Date())}</p>
            <p>UTC date: {formatToUtc(new Date())}</p>
        </div>
    );
};

export default ExampleComponent;

Available Functions

The useDateFormatter hook includes the following functions:

• getNowDate(): Gets the current date and time in the configured format.
• dateToString(date): Converts a date to a string representing only the date.
• timeToString(date): Converts a date to a string representing only the time.
• dateFullToString(date): Converts a full date to a string with both date and time.
• formatToUtc(date): Converts a date to UTC format.
• formatToTimeZone(date, timeZone): Converts a date to a specific time zone.
• addToDate(date, properties): Adds a time interval to a date.
• substractFromDate(date, properties): Subtracts a time interval from a date.
• diffDates(startDate, endDate, properties): Calculates the difference between two dates in the specified units.
• dateToISO(date): Converts a date to ISO format.
• stringToJSDate(date): Converts an ISO string to a JavaScript Date object.
• toCustomFormat(date, format): Converts a date to a custom format.
• setDate(date, properties): Adjusts the properties of a date.

Repository

The source code for this project is available in the following repository:

https://gitlab.com/ikatech_solutions/date-manager

License

This project is licensed under the ISC license.