Skip to main content
Version: 2.xx.xx

Interface References

CrudFilters

CrudFilter[]

CrudFilter

KeyType
fieldstring
operatorCrudOperators
valueany

CrudOperators

"eq" |
"ne" |
"lt" |
"gt" |
"lte" |
"gte" |
"in" |
"nin" |
"contains" |
"ncontains" |
"containss" |
"ncontainss" |
"null";
TypeDescription
"eq"Equal
"ne"Not equal
"lt"Less than
"gt"Greater than
"lte"Less than or equal to
"gte"Greater than or equal to
"in"Included in an array
"nin"Not included in an array
"contains"Contains
"ncontains"Doesn't contain
"containss"Contains, case sensitive
"ncontainss"Doesn't contain, case sensitive
"null"Is null or not null

CrudSorting

CrudSort[]

CrudSort

KeyType
fieldstring
order"asc" | "desc"
order typeDescription
"asc"Ascending order
"desc"Descending order

Pagination

KeyType
currentnumber
pageSizenumber

BaseRecord

KeyType
id?string | number
[key: string]any

HttpError

KeyType
messagestring
statusCodenumber

Delete Button Props

ButtonProps

KeyType
resourceName?string
recordItemId?string | number
onSuccess?<TData = BaseRecord>(value: { data: TData; }) => void;
mutationMode?MutationMode
hideText?boolean

MutationMode

"pessimistic" | "optimistic" | "undoable";

UploadedFile

KeyType
uidstring
namestring
urlstring
typestring
sizenumber
percentnumber
status"error" | "success" | "done" | "uploading" | "removed"

SuccessErrorNotification

KeyType
successNotificationNotification Properties & false
errorNotificationNotification Properties & false

MetaDataQuery

KeyType
[k: string]any
operation?string
fields?Array<string | object | NestedField>
variables?VariableOptions

NestedField

KeyType
operationstring
variablesVariableOptions[]
fieldsArray<string | object | NestedField>

QueryBuilderOptions

KeyType
operationstring
variablesVariableOptions
fieldsArray<string | object | NestedField>

VariableOptions

KeyType
type?string
name?string
value?any
list?bool
required?bool
[k: string]any

PromptProps

KeyType
messagestring
when?boolean
setWarnWhen?(warnWhen: boolean) => void

CanParams

KeyType
resourcestring
actionstring
params?any

CanReturnType

KeyType
canboolean
reason?string

LiveEvent

KeyType
channelstring
typesArray<"deleted" | "updated" | "created" | "*" | string>
payload{ids?: string[]; [x: string]: any; }
dateDate

LiveModeProps

KeyType
liveMode?"auto"Β | "manual" | "off"
liveParams?{ids?: string[]; [x: string]: any; }
onLiveEvent?(event: LiveEvent) => void