Skip to main content

AdminForthResourceColumn

AdminForthResourceColumn: object

Column describes one field in the table or collection in database.

Type declaration​

_underlineType?​

optional _underlineType: string

Internal type which indicates original type of column in database.

allowMinMaxQuery?​

optional allowMinMaxQuery: boolean

Whether AdminForth will show this field in list view.

backendOnly?​

optional backendOnly: boolean

if true field will !not be passed to UI under no circumstances, but will be presented in hooks

components?​

optional components: AdminForthFieldComponents

Custom components which will be used to render this field in the admin panel.

editingNote?​

optional editingNote: string | object

Whether AdminForth will show editing note near the field in edit/create form.

enforceLowerCase?​

optional enforceLowerCase: boolean

Will automatically convert any capital letters to lowercase in input during editing

enum?​

optional enum: AdminForthColumnEnumItem[]

Enum of possible values for this field.

fillOnCreate?​

optional fillOnCreate: Function

Whether AdminForth will show this field in show view.

foreignResource?​

optional foreignResource: AdminForthForeignResource

Foreign resource which has pk column with values same that written in this column.

isUnique?​

optional isUnique: boolean

Whether AdminForth will request user to enter unique value during creating or editing record. This option causes AdminForth to make a request to database to check if value is unique. (Constraints are not used, so for large-tables performance make sure you have unique index in database if you set this option to true)

label?​

optional label: string

How column can be labled in the admin panel. Use it for renaming columns. Defaulted to column name with Uppercased first letter.

masked?​

optional masked: boolean

Masked fields will be displayed as ***** on Edit and Create pages.

max?​

optional max: number

maxLength?​

optional maxLength: number

Maximum length of string that can be entered in this field.

maxValue?​

optional maxValue: number

Maximum value that can be entered in this field.

min?​

optional min: number

minLength?​

optional minLength: number

Minimum length of string that can be entered in this field.

minValue?​

optional minValue: number

Minimum value that can be entered in this field.

name​

name: string

Column name in database.

primaryKey?​

optional primaryKey: boolean

Whether to use this column as record identifier. Only one column can be primary key. AdminForth tries to guess primary key automatically first.

required?​

optional required: boolean | object

Whether AdminForth will require this field to be filled in create and edit forms. Can be set to boolean or object with create and edit properties. If boolean, it will be used for both create and edit forms.

showIn?​

optional showIn: (AdminForthResourcePages | keyof typeof AdminForthResourcePages)[]

On which AdminForth pages this field will be shown. By default all. Example: if you want to show field only in create and edit pages, set it to

showIn: [AdminForthResourcePages.CREATE, AdminForthResourcePages.EDIT]

sortable?​

optional sortable: boolean

type?​

optional type: AdminForthDataTypes

Type of data in column. AdminForth will use this information to render proper input fields in the admin panel. AdminForth tries to guess type of data from database column type automatically for typed databases like SQL-based. However you can explicitly set it to any value. E.g. set AdminForthDataTypes.DATETIME for your string column in SQLite, which stores ISO date strings.

validation?​

optional validation: ValidationObject[]

Runtime validation Regexp rules for this field.

virtual?​

optional virtual: boolean

Allows to make the field which does not exist in database table. Examples: add custom show field with user country flag:

{
 label: 'Country Flag',
 type: AdminForthDataTypes.STRING,
 virtual: true,
 showIn: [AdminForthResourcePages.SHOW, AdminForthResourcePages.LIST],
 components: {
   show: '@@/CountryFlag.vue',
   list: '@@/CountryFlag.vue',
  },
}

This field will be displayed in show and list views with custom component CountryFlag.vue. CountryFlag.vue should be placed in custom folder and can be next:

<template>
 {{ getFlagEmojiFromIso(record.ipCountry) }}
</template>

<script setup>
const props = defineProps(['record']);

function getFlagEmojiFromIso(iso) {
   return iso.toUpperCase().replace(/./g, (char) => String.fromCodePoint(char.charCodeAt(0) + 127397));
}
</script>