Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IWorkspaceConfigField

The configuration of a metadata field.

Hierarchy

  • IWorkspaceConfigField

Properties

Optional additionalProps

additionalProps: any

Depending on the field type, additional information on how the field should behave are configured.

Optional defaultValue

defaultValue: any

Defines an optional default value for the field.

id

id: string

A unique identifier for the field. Used for metadata column names in SharePoint. Certain id and type combinations have additional logic attached. See ReservedFieldIds and FieldTypes for more info on ids with additional logic.

label

label: MuiString

A multi-language label that the user sees when creating or editing this field in the UI of a workspace type.

mandatory

mandatory: FormStatus

Defines in which FormStatus this field will be mandatory

readonly

readonly: FormStatus

Defines in which FormStatus this field will be readonly

type

The type of field, determines if and how the additionalProps need to be configured.

visibility

visibility: FormStatus

Defines in which FormStatus this field will be visible