Docs / Panel / UI Plugins Development / Plugins API Reference / InternalTypes

InternalTypes

class ContentObject

inherits from Record<string, any>

Properties

Name	Type	Description
id	string
internal	ContentObjectInternalProps
key: string (optional)	any

function ContentObjectCustomValidateFn

Function that will be called on form validate. If there will be no result, there will be zod validation based on schema. If returns errors, they will be passed to form. Errors should be an object with field names as flat keys and error messages as values.

Returns - Promise<Record<string, string \| string[]> \| null>

Parameters

Name	Type	Description
values	WithoutInternalProps<ContentObject>

function ContentObjectSubmitFn

Function that will be called on form submit. Should return array with new object data and errors.

Returns - Promise<[WithOptionalInternalProps<ContentObject> \| null, Record<string, string \| string[]> \| null, boolean]>

Parameters

Name	Type	Description
values	WithoutInternalProps<ContentObject>
disableLoader	boolean	(optional)

class ContentTypeDefinition

inherits from InternalProps

Properties

Name	Type	Description
name	string
label	string
internal	boolean
draftPublic	boolean
autoSave	boolean
schemaDefinition	{ type: "object"; allOf: [{ $ref: string }, { type: "object"; properties: Record<string,ContentTypePropertySchema> }]; required: string[]; additionalProperties: false }
metaDefinition	{ order: string[]; propertiesConfig: Record<string,ContentTypePropertyConfig> }
featuredImage (optional)	RelationWithoutHydration[]
slugs	SlugRule[]

Inherited properties

Name	Type	Description
id	string	**
createdAt	string	**
updatedAt	string|null	**
deletedAt	string|null	**

class ContentTypePropertyConfig

Properties

Name	Type	Description
inputType	string
label	string
isPassword (optional)	boolean
helpText (optional)	string
hidden (optional)	boolean
isTitlePart (optional)	boolean
readonly (optional)	boolean
unique (optional)	boolean
showTime (optional)	boolean
blockEditorTypes (optional)	string[]
optionsWithLabels (optional)	{ label: string; value: string }[]
useOptionsWithLabels (optional)	boolean
options (optional)	string[]
isMultiple (optional)	boolean
multiple (optional)	boolean
validation (optional)	{ relationContenttype?: string; relationMultiple?: boolean }
items (optional)	{ order: string[]; propertiesConfig: Record<string, T> }

class ContentTypePropertySchema

Properties

Name	Type	Description
type	string
default (optional)	unknown
minLength (optional)	number
pattern (optional)	string
minItems (optional)	number
required (optional)	string[]
items (optional)	{ type?: ("object" \| "string"); $ref?: string; required?: string[]; properties?: Record<string, T>; pattern?: string }
properties (optional)	Record<string, T>
additionalProperties (optional)	boolean

class GridFilters

This class doesn't have own properties.

function GridFiltersChangeFn

Returns - void

Parameters

Name	Type	Description
filters	GridFilters

class ListingPagination

Properties

Name	Type	Description
count	number
current_page	number
total_count	number
total_pages	number

function LockFormFn

Returns - void

Parameters

Name	Type	Description
lock	(PluginFormLock\| null)

class Media

inherits from MediaBase

Properties

Name	Type	Description
tags	RelationWithoutHydration[]
variants	Variant[]

Inherited properties

Name	Type	Description
id	string	**
internal	ContentObjectInternalProps	**
url	string	**
size	number	**
type	string	**
width	number	**
height	number	**
source	string	**
fileName	string	**
mimeType	string	**
extension	string	**
externalId	string	**
alt (optional)	string	**
title (optional)	string	**
key: string (optional)	any	**
id	string	**
internal	ContentObjectInternalProps	**
key: string (optional)	any	**

class ModalInstance

Single modal instance context

Properties

Name	Type	Description
resolve (optional)	resolve	Function to close a modal and resolve its promise

function resolve

Function to close a modal and resolve its promise

Returns - void

Parameters

Name	Type	Description
value	any

function NewMediaUploadFn

Returns - Promise<NewMediaObject[] \| undefined>

Parameters

Name	Type	Description
files	(null \| FileList \| File[])

function PageChangeFn

Returns - void

Parameters

Name	Type	Description
pageNumber	number

class PluginContentObject

inherits from ContentObject

Properties

Name	Type	Description
url	string
name	string
enabled	boolean
version	string
manifest	string
settings	string
description	string

Inherited properties

Name	Type	Description
id	string	**
internal	ContentObjectInternalProps	**
key: string (optional)	any	**

class RelationWithoutHydration

Properties

Name	Type	Description
dataUrl	string
type	string

function ReloadContentObjectFn

Returns - Promise<Media\| undefined>

class SchemaModalFormConfig

Properties

Name	Type	Description
schema	WithOptionalInternalProps<ContentTypeDefinition>	Schema object compatible flotiq api. All passed schema gets nonCtdSchema value set on true.
initialData (optional)	WithOptionalInternalProps<ContentObject>	Initial data for form
options (optional)	SchemaModalFormConfigOptions	Additional options passed to settings form
labels (optional)	SchemaModalFormConfigLabels	Custom labels for modal buttons

class VariantModalConfig

Properties

Name	Type	Description
presets	{ key: string; label: string; name: string; ratio: number }[]

class WithOptionalInternalProps

Marks the internal properties of a type as optional.

Properties

Name	Type	Description
id (optional)
internal (optional)
createdAt (optional)
updatedAt (optional)
deletedAt (optional)