Skip to content

io.input.date ​

Represents a date component.

Usage ​

ts
const value = await io.input.date("Date")
python
value = await io.input.date("Date")

example of Forge app with date component

Props ​

defaultValue Optional ​

Date | object
Default value for the input.

Date | {
  year: number;
  month: number; // 1-12
  day: number;
}

disabled Optional ​

boolean
Whether the input is disabled, preventing changes from the defaultValue.

helpText Optional ​

string Optional label providing additional context. Supports inline markdown elements like bold, italics, and links.

max Optional ​

Date | object Latest possible date value for the input.

Date | {
  year: number;
  month: number; // 1-12
  day: number;
}

min Optional ​

Date | object Earliest possible date value for the input.

Date | {
  year: number;
  month: number; // 1-12
  day: number;
}

Returns object ​

day ​

number
The day of the month of the provided date.

jsDate ​

Date
JavaScript Date object containing the date value.

month ​

number
The calendar month of the provided date, 1-12.

year ​

number
The year of the provided date.