chore(docs): Generated + Updated UI Reference (automated) (#13491)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-09-12 16:07:27 +02:00
committed by GitHub
parent ed0dafb24c
commit fcbb1008bf
24 changed files with 720 additions and 45 deletions

View File

@@ -16,9 +16,9 @@
"dependencies": {
"@mdx-js/loader": "^3.1.0",
"@mdx-js/react": "^3.1.0",
"@medusajs/icons": "2.10.1",
"@medusajs/ui": "4.0.21",
"@medusajs/ui-preset": "2.10.1",
"@medusajs/icons": "2.10.2",
"@medusajs/ui": "4.0.22",
"@medusajs/ui-preset": "2.10.2",
"@next/mdx": "15.3.5",
"@stefanprobst/rehype-extract-toc": "^3.0.0",
"clsx": "^2.1.0",

View File

@@ -16,6 +16,54 @@
"name": "unknown"
},
"description": ""
},
"isNew": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
},
"onRemove": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "() => void",
"signature": {
"arguments": [],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -13,6 +13,39 @@
"value": "\"Clear all\"",
"computed": false
}
},
"alwaysShow": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"sortingTooltip": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"columnsTooltip": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"children": {
"required": false,
"tsType": {
"name": "ReactReactNode",
"raw": "React.ReactNode"
},
"description": ""
}
}
}

View File

@@ -9,6 +9,34 @@
"name": "string"
},
"description": "The tooltip to show when hovering over the filter menu."
},
"onAddFilter": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(id: string, value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "string"
},
"name": "id"
},
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": "Callback when a filter is added"
}
}
}

View File

@@ -0,0 +1,21 @@
{
"description": "",
"methods": [],
"displayName": "DataTableColumnVisibilityMenu",
"props": {
"className": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"tooltip": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
}
}
}

View File

@@ -0,0 +1,131 @@
{
"description": "",
"methods": [],
"displayName": "DataTableFilterCustomContent",
"props": {
"id": {
"required": true,
"tsType": {
"name": "string"
},
"description": ""
},
"filter": {
"required": true,
"tsType": {
"name": "any"
},
"description": ""
},
"onRemove": {
"required": true,
"tsType": {
"name": "signature",
"type": "function",
"raw": "() => void",
"signature": {
"arguments": [],
"return": {
"name": "void"
}
}
},
"description": ""
},
"render": {
"required": true,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(props: {\n value: any\n onChange: (value: any) => void\n onRemove: () => void\n}) => React.ReactNode",
"signature": {
"arguments": [
{
"type": {
"name": "signature",
"type": "object",
"raw": "{\n value: any\n onChange: (value: any) => void\n onRemove: () => void\n}",
"signature": {
"properties": [
{
"key": "value",
"value": {
"name": "any",
"required": true
}
},
{
"key": "onChange",
"value": {
"name": "signature",
"type": "function",
"raw": "(value: any) => void",
"signature": {
"arguments": [
{
"type": {
"name": "any"
},
"name": "value"
}
],
"return": {
"name": "void"
}
},
"required": true
}
},
{
"key": "onRemove",
"value": {
"name": "signature",
"type": "function",
"raw": "() => void",
"signature": {
"arguments": [],
"return": {
"name": "void"
}
},
"required": true
}
}
]
}
},
"name": "props"
}
],
"return": {
"name": "ReactReactNode",
"raw": "React.ReactNode"
}
}
},
"description": ""
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -36,26 +36,26 @@
},
"description": ""
},
"isCustom": {
"isCustomRange": {
"required": true,
"tsType": {
"name": "boolean"
},
"description": ""
},
"setIsCustom": {
"required": true,
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(isCustom: boolean) => void",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "boolean"
"name": "unknown"
},
"name": "isCustom"
"name": "value"
}
],
"return": {

View File

@@ -0,0 +1,83 @@
{
"description": "",
"methods": [],
"displayName": "DataTableFilterMultiselectContent",
"props": {
"id": {
"required": true,
"tsType": {
"name": "string"
},
"description": ""
},
"filter": {
"required": false,
"tsType": {
"name": "Array",
"elements": [
{
"name": "string"
}
],
"raw": "string[]"
},
"description": "",
"defaultValue": {
"value": "[]",
"computed": false
}
},
"options": {
"required": true,
"tsType": {
"name": "Array",
"elements": [
{
"name": "DataTableFilterOption",
"elements": [
{
"name": "string"
}
],
"raw": "DataTableFilterOption<string>"
}
],
"raw": "DataTableFilterOption<string>[]"
},
"description": ""
},
"searchable": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -0,0 +1,65 @@
{
"description": "",
"methods": [],
"displayName": "DataTableFilterNumberContent",
"props": {
"id": {
"required": true,
"tsType": {
"name": "string"
},
"description": ""
},
"filter": {
"required": true,
"tsType": {
"name": "any"
},
"description": ""
},
"placeholder": {
"required": false,
"tsType": {
"name": "string"
},
"description": "",
"defaultValue": {
"value": "\"Enter number...\"",
"computed": false
}
},
"includeOperators": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "",
"defaultValue": {
"value": "true",
"computed": false
}
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -35,6 +35,28 @@
"raw": "DataTableFilterOption<string>[]"
},
"description": ""
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -45,6 +45,39 @@
"raw": "DataTableFilterOption<string>[]"
},
"description": ""
},
"isNew": {
"required": false,
"tsType": {
"name": "boolean"
},
"description": "",
"defaultValue": {
"value": "false",
"computed": false
}
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -0,0 +1,54 @@
{
"description": "",
"methods": [],
"displayName": "DataTableFilterStringContent",
"props": {
"id": {
"required": true,
"tsType": {
"name": "string"
},
"description": ""
},
"filter": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"placeholder": {
"required": false,
"tsType": {
"name": "string"
},
"description": "",
"defaultValue": {
"value": "\"Enter value...\"",
"computed": false
}
},
"onUpdate": {
"required": false,
"tsType": {
"name": "signature",
"type": "function",
"raw": "(value: unknown) => void",
"signature": {
"arguments": [
{
"type": {
"name": "unknown"
},
"name": "value"
}
],
"return": {
"name": "void"
}
}
},
"description": ""
}
}
}

View File

@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "DataTableNonSortableHeaderCell",
"props": {}
}

View File

@@ -0,0 +1,6 @@
{
"description": "",
"methods": [],
"displayName": "DataTableSortableHeaderCell",
"props": {}
}

View File

@@ -24,6 +24,14 @@
"name": "DataTableToolbarTranslations"
},
"description": "The translations of strings in the toolbar."
},
"filterBarContent": {
"required": false,
"tsType": {
"name": "ReactReactNode",
"raw": "React.ReactNode"
},
"description": "Custom content to render in the filter bar"
}
}
}