Interface References

CrudFilters

CrudFilter[]

CrudFilter

Key	Type
field	`string`
operator	`CrudOperators`
value	`any`

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";

Type	Description
`"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

Key	Type
field	`string`
order	`"asc"` \| `"desc"`

`order` type	Description
`"asc"`	Ascending order
`"desc"`	Descending order

SortOrder

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

Pagination

Key	Type
current	`number`
pageSize	`number`
mode	`"client"` \| `"server"` \| `"off"`

BaseKey

Type
`string` \| `number`

BaseRecord

Key	Type
id?	`BaseKey`
`[key: string]`	`any`

HttpError

Key	Type
message	`string`
statusCode	`number`
errors	`ValidationErrors`

ValidationErrors

Key	Type
`[field: string]`	`string` \| `string[]` \| `boolean` \| `{ key: string; message: string }`

Delete Button Props

ButtonProps

Key	Type
resourceName?	`string`
recordItemId?	`BaseKey`
onSuccess?	`<TData = BaseRecord>(value: { data: TData; }) => void;`
mutationMode?	`MutationMode`
hideText?	`boolean`

MutationMode

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

UploadedFile

Key	Type
uid	`string`
name	`string`
url	`string`
type	`string`
size	`number`
percent	`number`
status	`"error"` \| `"success"` \| `"done"` \| `"uploading"` \| `"removed"`

UseImportInputPropsType

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

SuccessErrorNotification

Key	Type
successNotification	OpenNotificationParams \| `false` \| `(data?: TData, values?: TVariables, resource?: string) =>` OpenNotificationParams \| `false`
errorNotification	OpenNotificationParams \| `false` \| `(data?: TData, values?: TVariables, resource?: string) =>` OpenNotificationParams \| `false`

OpenNotificationParams

Key	Type
key?	`string`
type	`"success"` \| `"error"` \| `"progress"`
description?	`string`
cancelMutation?	`() => void`
undoableTimeout?	`number`

MetaDataQuery

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

NestedField

Key	Type
operation	`string`
variables	VariableOptions[]
fields	`Array<string` \| `object` \| NestedField>

QueryBuilderOptions

Key	Type
operation	`string`
variables	VariableOptions
fields	`Array<string` \| `object` \| `NestedField>`

VariableOptions

Key	Type
type?	`string`
name?	`string`
value?	`any`
list?	`bool`
required?	`bool`
[k: string]	`any`

PromptProps

Key	Type
message	`string`
when?	`boolean`
setWarnWhen?	`(warnWhen: boolean) => void`

CanParams

Key	Type
resource	`string`
action	`string`
params?	{ `resource`?: IResourceItem, `id`?: BaseKey, `[key: string]: any` }

CanReturnType

Key	Type
can	`boolean`
reason?	`string`

LiveEvent

Key	Type
channel	`string`
type	`"deleted"` \| `"updated"` \| `"created"` \| "`*`" \| `string`
payload	`{ids?: BaseKey[]; [x: string]: any; }`
date	`Date`

LiveModeProps

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

MetaProps

Key	Type
label?	`string`
icon?	`React.ReactNode`
audit?	`string[]`
parent?:	`string`
dataProviderName?	`string`
[key: string]	`any`

ResourceItemProps

Key	Type
name	`string`
identifier?	`string`
meta?	`MetaProps`

SyncWithLocationParams

Key	Type
pagination?	`{ current?: number; pageSize?: number }`
sorter?	`CrudSorting`
filters?	`CrudSCrudFiltersorting`

Open Notification Params

Key	Type
key?	`string`
type	`"success"` \| `"error"` \| `"progress"`
message	`string`
description?	`string`
cancelMutation?	`() => void`
undoableTimeout?	`number`

Close Notification Params

Key	Type
key	`string`

CrudFilters​

CrudFilter​

CrudOperators​

CrudSorting​

CrudSort​

SortOrder​

Pagination​

BaseKey​

BaseRecord​

HttpError​

ValidationErrors​

Delete Button Props​

MutationMode​

UploadedFile​

UseImportInputPropsType​

SuccessErrorNotification​

OpenNotificationParams​

MetaDataQuery​

NestedField​

QueryBuilderOptions​

VariableOptions​

PromptProps​

CanParams​

CanReturnType​

LiveEvent​

LiveModeProps​

MetaProps​

ResourceItemProps​

SyncWithLocationParams​

Open Notification Params​

Close Notification Params​

CrudFilters

CrudFilter

CrudOperators

CrudSorting

CrudSort

SortOrder

Pagination

BaseKey

BaseRecord

HttpError

ValidationErrors

Delete Button Props

MutationMode

UploadedFile

UseImportInputPropsType

SuccessErrorNotification

OpenNotificationParams

MetaDataQuery

NestedField

QueryBuilderOptions

VariableOptions

PromptProps

CanParams

CanReturnType

LiveEvent

LiveModeProps

MetaProps

ResourceItemProps

SyncWithLocationParams

Open Notification Params

Close Notification Params