Skip to main content
Version: 3.xx.xx

Interface References

CrudFilters​

CrudFilter[]

CrudFilter​

KeyType
fieldstring
operatorCrudOperators
valueany

CrudOperators​

"eq" |
"ne" |
"lt" |
"gt" |
"lte" |
"gte" |
"in" |
"nin" |
"contains" |
"ncontains" |
"containss" |
"ncontainss" |
"between" |
"nbetween" |
"null" |
"nnull" |
"startswith" |
"nstartswith" |
"startswiths" |
"nstartswiths" |
"endswith" |
"nendswith" |
"endswiths" |
"nendswiths";
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
"between"Between
"nbetween"Doesn't between
"null"Is null
"nnull"Is not null
"startswith"Starts with
"nstartswith"Doesn't start with
"startswiths"Starts with, case sensitive
"nstartswiths"Doesn't start with, case sensitive
"endswith"Ends with
"nendswith"Doesn't end with
"endswiths"Ends with, case sensitive
"nendswiths"Doesn't end with, case sensitive

CrudSorting​

CrudSort[]

CrudSort​

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

SortOrder​

"desc" | "asc" | "null";

Pagination​

KeyType
currentnumber
pageSizenumber

BaseKey​

Type
string | number

BaseRecord​

KeyType
id?BaseKey
[key: string]any

HttpError​

KeyType
messagestring
statusCodenumber

Delete Button Props​

ButtonProps

KeyType
resourceName?string
recordItemId?BaseKey
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"

UseImportInputPropsType​

KeyType
type"file"
accept".cvs"
onChange(event: React.ChangeEvent<HTMLInputElement>) => void

SuccessErrorNotification​

KeyType
successNotification(data?: TData, values?: TVariables, resource?: string) => NotificationProperties | Notification Properties | false
errorNotification(error?: TError, values?: TVariables, resource?: string) => NotificationProperties | Notification Properties | false

MetaDataQuery​

KeyType
[k: string]any
operation?string
fields?Array<string | object | NestedField>
variables?VariableOptions
queryContext?Omit<QueryFunctionContext, "meta">

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?{ resource?: IResourceItem, id?: BaseKey, [key: string]: any }

CanReturnType​

KeyType
canboolean
reason?string

LiveEvent​

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

LiveModeProps​

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

OptionsProps​

KeyType
label?string
route?string
[key: string]any

ResourceItemProps​

KeyType
namestring
label ?string
route?string
icon?ReactNode
canCreate?boolean
canEdit?boolean
canShow?boolean
canDelete?boolean
options?object
parentName?string

SyncWithLocationParams​

KeyType
pagination?{ current?: number; pageSize?: number }
sorter?CrudSorting
filters?CrudSCrudFiltersorting