asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

docs: add missing props to UI components (#13247)

Browse Source
This commit is contained in:
Shahed Nasser authored and GitHub committed 2025-08-20 12:36:57 +03:00
1 parent d1a1135328
commit 69d22213f4
10 files changed
+309 -443
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/apps/ui/specs/components/Calendar/Calendar.json
+71 -70
View File
@@ -3,103 +3,104 @@
"methods": [],
"displayName": "Calendar",
"props": {
"autoFocus": {
"description": "Whether to automatically focus the calendar when it mounts.",
"value": {
"required": false,
"tsType": {
"name": "boolean"
}
"name": "union",
"raw": "Date | null",
"elements": [
{
"name": "Date"
},
{
"name": "null"
}
]
},
"description": "The currently selected date."
},
"defaultFocusedValue": {
"description": "The date that is focused when the calendar first mounts (uncountrolled).",
"defaultValue": {
"required": false,
"tsType": {
"name": "DateValue",
"elements": [],
"raw": "DateValue"
}
"name": "union",
"raw": "Date | null",
"elements": [
{
"name": "Date"
},
{
"name": "null"
}
]
},
"description": "The date that is selected when the calendar first mounts (uncontrolled)."
},
"errorMessage": {
"description": "An error message to display when the selected value is invalid.",
"required": false,
"tsType": {
"name": "ReactNode",
"elements": [],
"raw": "ReactNode"
}
},
"focusedValue": {
"description": "Controls the currently focused date within the calendar.",
"required": false,
"tsType": {
"name": "DateValue",
"elements": [],
"raw": "DateValue"
}
},
"isDisabled": {
"description": "Whether the calendar is disabled.",
"required": false,
"tsType": {
"name": "boolean"
}
},
"isInvalid": {
"description": "Whether the current selection is invalid according to application logic.",
"required": false,
"tsType": {
"name": "boolean"
}
},
"isReadOnly": {
"description": "Whether the calendar value is immutable.",
"required": false,
"tsType": {
"name": "boolean"
}
},
"onFocusChange": {
"description": "Handler that is called when the focused date changes.",
"onChange": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(date: CalendarDate) => void",
"raw": "(value: Date | null) => void",
"signature": {
"arguments": [
{
"name": "date",
"type": {
"name": "CalendarDate",
"elements": [],
"raw": "CalendarDate"
"name": "union",
"raw": "Date | null",
"elements": [
{
"name": "Date"
},
{
"name": "null"
}
]
},
"rest": false
"name": "value"
}
],
"return": {
"name": "void"
}
}
}
},
"description": "A function that is triggered when the selected date changes."
},
"pageBehavior": {
"description": "Controls the behavior of paging. Pagination either works by advancing the visible page by visibleDuration (default) or one unit of visibleDuration.",
"isDateUnavailable": {
"required": false,
"tsType": {
"name": "PageBehavior",
"elements": [],
"raw": "PageBehavior"
}
"name": "signature",
"type": "function",
"raw": "(date: Date) => boolean",
"signature": {
"arguments": [
{
"type": {
"name": "Date"
},
"name": "date"
}
],
"return": {
"name": "boolean"
}
}
},
"description": "A function that determines whether a date is unavailable for selection."
},
"validationState": {
"description": "Whether the current selection is valid or invalid according to application logic.",
"minValue": {
"required": false,
"tsType": {
"name": "ValidationState",
"elements": [],
"raw": "ValidationState"
}
"name": "Date"
},
"description": "The minimum date that can be selected."
},
"maxValue": {
"required": false,
"tsType": {
"name": "Date"
},
"description": "The maximum date that can be selected."
}
},
"composes": [