Options passed to a given property
Members
Array.<object>
# availableValues Optional
If options should be limited to finite set. After setting this
in the UI you will see select box instead of the input
Properties:
| Name | Type | Description |
|---|---|---|
value |
string
|
number
|
|
label |
string
|
object
# components Optional
List of possible overridden components for given property.
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
string
|
<optional> |
|
list |
string
|
<optional> |
|
edit |
string
|
<optional> |
|
filter |
string
|
<optional> |
object
# custom Optional
Custom properties passed to the frontend in PropertyJSON
Properties:
| Name | Type | Description |
|---|---|---|
{...} |
any
|
string
# description Optional
Description of field. Shown as hoverable hint after label.
To use translations provide it in locale with specified options key from resource
Example
```js
new AdminJS({
resources: [
{
resource: myResource,
options: {
properties: {
myAwesomeProperty: {
description: "Plane description" || "awesomeHint", // <- message key in locale
},
},
},
},
],
locale: {
translations: {
resources: {
myResource: {
messages: {
awesomeHint: "Locale description",
},
},
},
},
},
});
```boolean
# isDraggable Optional
Indicates if array elements should be draggable when editing.
It is only usable if the property is an array.
boolean
# isTitle Optional
One of given property should be treated as an "title property". Title property is "clickable"
when user sees the record in a list or show views.
boolean
|
object
# isVisible Optional
if given property should be visible. It can be either boolean for all possible views, or
you can verify which view in particular should be hidden/shown.
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
show |
boolean
|
<optional> |
|
list |
boolean
|
<optional> |
|
edit |
boolean
|
<optional> |
|
filter |
boolean
|
<optional> |
number
# position Optional
position of the field in a list,
title field (isTitle) gets position -1 by default other fields gets position = 100.
object
# props Optional
Additional props passed to the actual React component rendering given property in Edit
component.
Properties:
| Name | Type | Description |
|---|---|---|
{...} |
any
|
string
# reference Optional
Name of the resource to which this property should be a reference.
If set - PropertyOptions.type always returns reference