docs(development): Notate usage of dict for table field

ref: #679 nofusscomputing/centurion_erp_ui#95 closes #669
This commit is contained in:
2025-03-16 11:09:15 +09:30
parent 9c65d7f355
commit 0452293546

View File

@ -132,7 +132,22 @@ page_layout: list = [
## table_fields Attributes
The `table_fields` attribute within a model is what the UI List View or section table uses as the fields to add to the table. The `table_fields` attribute is a python list of strings that are the field names as are defined within the serializer.
The `table_fields` attribute within a model is what the UI List View or section table uses as the fields to add to the table. The `table_fields` attribute is a python list of string/dictionary that are the field names as are defined within the serializer. If the field is defined as a dictionary, the field is formatted as per the definition. for example:
``` py
table_fields: list = [
'organization',
'name'
{
'field': 'display_name', # String, Name of the field to use
'type': 'link', # Choice, (link = anchor link) definition type
'key': '_self' # String, Dictionary key to use, in case of link. in this case will expand to `_urls._self`
},
'created'
]
```
## History