Skip to content

Commit 64ae62c

Browse files
hotlonghotlong
authored
Merge pull request #94 from objectstack-ai/copilot/enhance-list-form-protocols
2 parents 03cd66a + 84a6427 commit 64ae62c

23 files changed

+2735
-23
lines changed

‎content/docs/references/ui/api/HttpMethod.mdx‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: HttpMethod
3+
description: HttpMethod Schema Reference
4+
---
5+
6+
## Allowed Values
7+
8+
* `GET`
9+
* `POST`
10+
* `PUT`
11+
* `PATCH`
12+
* `DELETE`

‎content/docs/references/ui/view/FormField.mdx‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: FormField
3+
description: FormField Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **field** | `string` | ✅ | Field name (snake_case) |
11+
| **label** | `string` | optional | Display label override |
12+
| **placeholder** | `string` | optional | Placeholder text |
13+
| **helpText** | `string` | optional | Help/hint text |
14+
| **readonly** | `boolean` | optional | Read-only override |
15+
| **required** | `boolean` | optional | Required override |
16+
| **hidden** | `boolean` | optional | Hidden override |
17+
| **colSpan** | `integer` | optional | Column span in grid layout (1-4) |
18+
| **widget** | `string` | optional | Custom widget/component name |
19+
| **dependsOn** | `string` | optional | Parent field name for cascading |
20+
| **visibleOn** | `string` | optional | Visibility condition expression |

‎content/docs/references/ui/view/FormSection.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ description: FormSection Schema Reference
1111
| **collapsible** | `boolean` | optional | |
1212
| **collapsed** | `boolean` | optional | |
1313
| **columns** | `Enum<'1' \| '2' \| '3' \| '4'>` | optional | |
14-
| **fields** | `string[]` | ✅ | |
14+
| **fields** | `string \| object[]` | ✅ | |

‎content/docs/references/ui/view/FormView.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@ description: FormView Schema Reference
88
| Property | Type | Required | Description |
99
| :--- | :--- | :--- | :--- |
1010
| **type** | `Enum<'simple' \| 'tabbed' \| 'wizard'>` | optional | |
11+
| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) |
1112
| **sections** | `object[]` | optional | |
1213
| **groups** | `object[]` | optional | |

‎content/docs/references/ui/view/HttpRequest.mdx‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: HttpRequest
3+
description: HttpRequest Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **url** | `string` | ✅ | API endpoint URL |
11+
| **method** | `Enum<'GET' \| 'POST' \| 'PUT' \| 'PATCH' \| 'DELETE'>` | optional | HTTP method |
12+
| **headers** | `Record<string, string>` | optional | Custom HTTP headers |
13+
| **params** | `Record<string, any>` | optional | Query parameters |
14+
| **body** | `any` | optional | Request body for POST/PUT/PATCH |

‎content/docs/references/ui/view/ListColumn.mdx‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: ListColumn
3+
description: ListColumn Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **field** | `string` | ✅ | Field name (snake_case) |
11+
| **label** | `string` | optional | Display label override |
12+
| **width** | `number` | optional | Column width in pixels |
13+
| **align** | `Enum<'left' \| 'center' \| 'right'>` | optional | Text alignment |
14+
| **hidden** | `boolean` | optional | Hide column by default |
15+
| **sortable** | `boolean` | optional | Allow sorting by this column |
16+
| **resizable** | `boolean` | optional | Allow resizing this column |
17+
| **wrap** | `boolean` | optional | Allow text wrapping |
18+
| **type** | `string` | optional | Renderer type override (e.g., "currency", "date") |

‎content/docs/references/ui/view/ListView.mdx‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,16 @@ description: ListView Schema Reference
1010
| **name** | `string` | optional | |
1111
| **label** | `string` | optional | |
1212
| **type** | `Enum<'grid' \| 'kanban' \| 'calendar' \| 'gantt' \| 'map'>` | optional | |
13-
| **columns** | `string[]` | ✅ | Fields to display as columns |
13+
| **data** | `object \| object \| object` | optional | Data source configuration (defaults to "object" provider) |
14+
| **columns** | `string[] \| object[]` | ✅ | Fields to display as columns |
1415
| **filter** | `any[]` | optional | Filter criteria (JSON Rules) |
1516
| **sort** | `string \| object[]` | optional | |
1617
| **searchableFields** | `string[]` | optional | Fields enabled for search |
18+
| **resizable** | `boolean` | optional | Enable column resizing |
19+
| **striped** | `boolean` | optional | Striped row styling |
20+
| **bordered** | `boolean` | optional | Show borders |
21+
| **selection** | `object` | optional | Row selection configuration |
22+
| **pagination** | `object` | optional | Pagination configuration |
1723
| **kanban** | `object` | optional | |
1824
| **calendar** | `object` | optional | |
1925
| **gantt** | `object` | optional | |

‎content/docs/references/ui/view/PaginationConfig.mdx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: PaginationConfig
3+
description: PaginationConfig Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **pageSize** | `integer` | optional | Number of records per page |
11+
| **pageSizeOptions** | `integer[]` | optional | Available page size options |

‎content/docs/references/ui/view/SelectionConfig.mdx‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: SelectionConfig
3+
description: SelectionConfig Schema Reference
4+
---
5+
6+
## Properties
7+
8+
| Property | Type | Required | Description |
9+
| :--- | :--- | :--- | :--- |
10+
| **type** | `Enum<'none' \| 'single' \| 'multiple'>` | optional | Selection mode |

‎content/docs/references/ui/view/ViewData.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: ViewData
3+
description: ViewData Schema Reference
4+
---
5+

0 commit comments

Comments
 (0)