react react-hook ironman30

useDate

A hook aims for manipulate date.

LINKS

const [date, dateDispatch] = useDate(configs)

//implented with [`date-fns`](https://date-fns.org/)

libs

date-fns

Configs

name	type	default	description
`defaultDate`	`Date Object \| string`	null
`formatPattern`	`string`	yyyy-MM-dd	see date-fns doc
`transitionUnit`	`string`	days	see date-fns doc
`offsetUnit`	`string`	days	see date-fns doc
`offsetValue`	`number`	0

Return

name	type	description
`date`	`string`
`dateDispatch`	`function`	dateDispatch(type, payload), see below

Method

`dateDispatch(type, payload)`

type	payload	description
`BACKWARD`	`number \| void`	payload default as 1 when not provided
`FORWARD`	`number \| void`	payload default as 1 when not provided
`NOW`		To NOW
`TO`	`Date Object \| string`	To specific date

Default Config

Date: 2024-05-17

const defaultConfigs = {
  defaultDate: null,
  formatPattern: "yyyy-MM-dd",
  transitionUnit: "days",
  offsetUnit: "days",
  offsetValue: 0,
}

Custom Config

Date: 2022-08-28

const defaultConfigs = {
  defaultDate: "2022-08-30",
  formatPattern: "yyyy-MM-dd",
  transitionUnit: "months",
  offsetUnit: "days",
  offsetValue: -2,
}