Types of components
There are two types of components in the framework:
- Related with model fields
- Design components: container and widget components
Versioning
The components are versioned with the webclient version, we have three types of versions:
stable: v2.X and the components are tagged with green (or not tagged) v2.Xbeta: v2.X-rc.Y and the components are tagged with yellow v2.X-rc.Yalpha: v3.0.0-alpha.Z and the components are tagged with red v3.0.0-alpha.Z
API
Container components
| Property | Description | Type | Default | Version |
|---|
col | Number of columns that the container will have inside. | number | - | - |
| Property | Description | Type | Default | Version |
|---|
colspan | Number of columns that the widget will span | number | 1 (depends on the widget) | - |
readonly | Whether the widget is read-only | boolean | false | - |
invisible | Whether the widget is invisible | boolean | false | - |
attrs | Dynamic attributes to pass to the widget as boolean values. See the dynamic attributes for more information. | object | - | - |
| Property | Description | Type | Default | Version |
|---|
name | Name of the field | string | - | - |
domain | Domain to filter the records | array (domain format) | [] | - |
context | Context to pass to the field | object | {} | - |
string | Label for the field | string | The string defined in the model | - |
nolabel | Whether to show the label | boolean | false | - |
help | Help text for the field | string | '' | - |
help_inline | Whether to show the help text inline | boolean | false | - |
required | Whether the field is required | boolean | false (depends on the model) | - |
sum | Whether to show the sum of the field only for tree views | | - | - |
autorefresh | Whether the field will be refreshed automatically | boolean (1 | 0) | 0 | v2.40.0 |