JSON representation of a Property.
Members
# availableValues
If property has restricted number of values
Properties:
| Name | Type | Description |
|---|---|---|
label |
string | |
value |
string |
# components Optional
All component names overridden by the user in PropertyOptions
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
string |
<optional> |
|
edit |
string |
<optional> |
|
filter |
string |
<optional> |
|
list |
string |
<optional> |
# custom
Custom parameters passed from the PropertyOptions.custom.
Properties:
| Name | Type | Description |
|---|---|---|
{...} |
any |
# isVirtual
Indicates if given property has been created in AdminBro PropertyOptions and hasn't been returned by the database adapter.
# path
Path of the actual value inside the record. It is usually the same as propertyPath, with the exception of array values.
# propertyPath
Property uniq path. For top level properties - the same as name, but for nested
properties it is separated with dot notation: nested.property
# props
Additional props passed to the actual react component
Properties:
| Name | Type | Description |
|---|---|---|
{...} |
any |
# reference
Has a name of a resource to which it is a reference.
For instance property userId will have here Users
# subProperties
Contain list of all sub properties. This is the case for nested schemas in MongoDB.
Type Definitions
# BasePropertyJSON
Property without the path. Defined as Omit<PropertyJSON, 'path'>
Properties:
| Name | Type | Description |
|---|---|---|
... |
any | properties from PropertyJSON except |
