Interface

PropertyJSON

PropertyJSON

Members

Array.<object> | null

# availableValues

If property has restricted number of values
Properties:
Name Type Description
label string
value string | number

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 40

object

# 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>

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 136

object

# custom

Custom parameters passed from the PropertyOptions.custom.
Properties:
Name Type Description
{...} any

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 146

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

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 71

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

# hideLabel

if label above the input should be hidden

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 169

boolean

# isArray

Indicates if property is an array of properties

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 119

boolean

# isDisabled

Whether the field should be disabled in edition

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 159

boolean

# isDraggable

Indicates if array elements should be draggable when editing.

It is only usable if the property is an array.

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 124

boolean

# isId

If given property should be treated as a Id field

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 25

boolean

# isRequired

Whether the field should be marked as required (with a star)

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 164

boolean

# isTitle

If given property should be treated as a title

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 20

boolean

# isVirtual

Indicates if given property has been created in AdminJS PropertyOptions and hasn't

been returned by the database adapter.

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 179

string

# path

Path of the actual value inside the record. It is usually the same as propertyPath, with the

exception of array values.

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 59

string

# propertyPath

Property uniq path. For top level properties - the same as name, but for nested

properties it is separated with dot notation: nested.property

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 52

object

# props

Additional props passed to the actual react component
Properties:
Name Type Description
{...} any

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 152

string | null

# reference

Has a name of a resource to which it is a reference.

For instance property userId will have here Users

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 113

string

# resourceId

Resource to which given property belongs

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 174

Array.<BasePropertyJSON>

# subProperties

Contain list of all sub properties.

This is the case for nested schemas in MongoDB.

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 130

Type Definitions

Object

# BasePropertyJSON

Property without the path. Defined as `Omit`
Properties:
Name Type Description
... any

properties from PropertyJSON except path

View Source adminjs/src/frontend/interfaces/property-json/property-json.interface.ts, line 3