Skip to content

Documentation / @jalali-js/react / UseCalendarResult

Interface: UseCalendarResult

Defined in: react/src/use-calendar.ts:21

Properties

date

date: CalendarDate

Defined in: react/src/use-calendar.ts:22


daysInMonth

daysInMonth: (year, month) => number

Defined in: react/src/use-calendar.ts:27

Parameters

year

number

month

number

Returns

number


format

format: (date?, options?) => string

Defined in: react/src/use-calendar.ts:24

Parameters

date?

CalendarDate

options?

FormatOptions

Returns

string


isLeapYear

isLeapYear: (year) => boolean

Defined in: react/src/use-calendar.ts:26

Parameters

year

number

Returns

boolean


locale

locale: LocalePack

Defined in: react/src/use-calendar.ts:28


setDate

setDate: (date) => void

Defined in: react/src/use-calendar.ts:23

Parameters

date

CalendarDate

Returns

void


today

today: () => CalendarDate

Defined in: react/src/use-calendar.ts:25

Returns

CalendarDate