Class FileField

FileField defines "file" type field for managing record file(s).

Only the file name is stored as part of the record value. New files (aka. files to upload) are expected to be of *filesytem.File.

If MaxSelect is not set or <= 1, then the field value is expected to be a single record id.

If MaxSelect is > 1, then the field value is expected to be a slice of record ids.

The respective zero record field value is either empty string (single) or empty string slice (multiple).

The following additional setter keys are available:

  - "fieldName+" - append one or more files to the existing record one. For example:

    // []string{"old1.txt", "old2.txt", "new1_ajkvass.txt", "new2_klhfnwd.txt"}
    record.Set("documents+", []*filesystem.File{new1, new2})

  - "+fieldName" - prepend one or more files to the existing record one. For example:

    // []string{"new1_ajkvass.txt", "new2_klhfnwd.txt", "old1.txt", "old2.txt",}
    record.Set("+documents", []*filesystem.File{new1, new2})

  - "fieldName-" - subtract/delete one or more files from the existing record one. For example:

    // []string{"old2.txt",}
    record.Set("documents-", "old1.txt")

Hierarchy

Implements

Constructors

constructor

Methods

calculateMaxBodySize columnType driverValue findGetter findSetter getHidden getId getName getSystem intercept isMultiple prepareValue setHidden setId setName setSystem type validateSettings validateValue

Properties

hidden id maxSelect maxSize mimeTypes name presentable protected required system thumbs

Constructors

constructor

Methods

calculateMaxBodySize

columnType

driverValue

findGetter

findSetter

getHidden

getId

getName

getSystem

intercept

  • Intercept implements the [RecordInterceptor] interface.

    note: files delete after records deletion is handled globally by the app FileManager hook

    Parameters

    Returns void

isMultiple

  • IsMultiple implements MultiValuer interface and checks whether the current field options support multiple values.

    Returns boolean

prepareValue

setHidden

  • SetHidden implements [Field.SetHidden] interface method.

    Parameters

    • hidden: boolean

    Returns void

setId

  • SetId implements [Field.SetId] interface method.

    Parameters

    • id: string

    Returns void

setName

  • SetName implements [Field.SetName] interface method.

    Parameters

    • name: string

    Returns void

setSystem

  • SetSystem implements [Field.SetSystem] interface method.

    Parameters

    • system: boolean

    Returns void

type

validateSettings

validateValue

Properties

hidden

hidden: boolean

Hidden hides the field from the API response.

id

id: string

Id is the unique stable field identifier.

It is automatically generated from the name when adding to a collection FieldsList.

maxSelect

maxSelect: number

MaxSelect specifies the max allowed files.

For multiple files the value must be > 1, otherwise fallbacks to single (default).

maxSize

maxSize: number

MaxSize specifies the maximum size of a single uploaded file (in bytes).

If zero, a default limit of 5MB is applied.

mimeTypes

mimeTypes: string[]

MimeTypes specifies an optional list of the allowed file mime types.

Leave it empty to disable the validator.

name

name: string

Name (required) is the unique name of the field.

presentable

presentable: boolean

Presentable hints the Dashboard UI to use the underlying field record value in the relation preview label.

protected

protected: boolean

Protected will require the users to provide a special file token to access the file.

Note that by default all files are publicly accessible.

For the majority of the cases this is fine because by default all file names have random part appended to their name which need to be known by the user before accessing the file.

required

required: boolean

Required will require the field value to have at least one file.

system

system: boolean

System prevents the renaming and removal of the field.

thumbs

thumbs: string[]

Thumbs specifies an optional list of the supported thumbs for image based files.

Each entry must be in one of the following formats:

  - WxH  (eg. 100x300) - crop to WxH viewbox (from center)
  - WxHt (eg. 100x300t) - crop to WxH viewbox (from top)
  - WxHb (eg. 100x300b) - crop to WxH viewbox (from bottom)
  - WxHf (eg. 100x300f) - fit inside a WxH viewbox (without cropping)
  - 0xH  (eg. 0x300)    - resize to H height preserving the aspect ratio
  - Wx0  (eg. 100x0)    - resize to W width preserving the aspect ratio

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc