Files
medusa-store/www/apps/ui/src/specs/SingleDatePicker/SingleDatePicker.json
T
github-actions[bot] dfd9e7c772 chore(docs): Updated UI Reference (#6221)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2024-01-29 08:20:51 +00:00

268 lines
5.9 KiB
JSON

{
"description": "",
"methods": [],
"displayName": "SingleDatePicker",
"props": {
"fromYear": {
"required": false,
"tsType": {
"name": "number"
},
"description": "The year to start showing the dates from."
},
"toYear": {
"required": false,
"tsType": {
"name": "number"
},
"description": "The year to show dates to."
},
"fromMonth": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The month to start showing dates from."
},
"toMonth": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The month to show dates to."
},
"fromDay": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The day to start showing dates from."
},
"toDay": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The day to show dates to."
},
"fromDate": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The date to show dates from."
},
"toDate": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The date to show dates to."
},
"locale": {
"required": false,
"tsType": {
"name": "Locale"
},
"description": "The locale to use for formatting dates. To change the locale pass a date-fns locale object."
},
"className": {
"required": false,
"tsType": {
"name": "string"
},
"description": "The class name to apply on the date picker."
},
"disabled": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "Whether the date picker's input is disabled."
},
"required": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "Whether the date picker's input is required."
},
"placeholder": {
"required": false,
"tsType": {
"name": "string"
},
"description": "The date picker's placeholder."
},
"size": {
"required": false,
"tsType": {
"name": "union",
"raw": "\"small\" | \"base\"",
"elements": [
{
"name": "literal",
"value": "\"small\""
},
{
"name": "literal",
"value": "\"base\""
}
]
},
"description": "The date picker's size.",
"defaultValue": {
"value": "\"base\"",
"computed": false
}
},
"showTimePicker": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "Whether to show a time picker along with the date picker."
},
"translations": {
"required": false,
"tsType": {
"name": "signature",
"type": "object",
"raw": "{\n cancel?: string\n apply?: string\n start?: string\n end?: string\n range?: string\n}",
"signature": {
"properties": [
{
"key": "cancel",
"value": {
"name": "string",
"required": false
}
},
{
"key": "apply",
"value": {
"name": "string",
"required": false
}
},
{
"key": "start",
"value": {
"name": "string",
"required": false
}
},
{
"key": "end",
"value": {
"name": "string",
"required": false
}
},
{
"key": "range",
"value": {
"name": "string",
"required": false
}
}
]
}
},
"description": "Translation keys for the date picker. Use this to localize the date picker."
},
"id": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"aria-invalid": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": ""
},
"aria-label": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"aria-labelledby": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"aria-required": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": ""
},
"presets": {
"required": false,
"tsType": {
"name": "Array",
"elements": [
{
"name": "DatePreset"
}
],
"raw": "DatePreset[]"
},
"description": ""
},
"defaultValue": {
"required": false,
"tsType": {
"name": "Date"
},
"description": ""
},
"value": {
"required": false,
"tsType": {
"name": "Date"
},
"description": ""
},
"onChange": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(date: Date | undefined) => void",
"signature": {
"arguments": [
{
"type": {
"name": "union",
"raw": "Date | undefined",
"elements": [
{
"name": "Date"
},
{
"name": "undefined"
}
]
},
"name": "date"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}