Skip to content

@pgege/kaboo-react


Interface: UploadReferenceProvider

Defined in: src/references/uploadProvider.tsx:31

A ReferenceProvider carrying its resolved upload config for the composer.

Extends

Properties

__kabooUpload

__kabooUpload: Required\<Pick\<UploadProviderConfig, "kind" | "maxSize">> & Pick\<UploadProviderConfig, "accept" | "onUpload">

Defined in: src/references/uploadProvider.tsx:33

Resolved upload config the composer reads to drive the file picker.


icon?

optional icon?: ReactNode

Defined in: src/references/types.ts:103

Optional icon rendered beside the group heading.

Inherited from

ReferenceProvider.icon


id

id: string

Defined in: src/references/types.ts:99

Stable provider id, e.g. "upload" | "table" | "dashboard".

Inherited from

ReferenceProvider.id


label

label: string

Defined in: src/references/types.ts:101

Group heading shown in the @ menu.

Inherited from

ReferenceProvider.label


onSelect?

optional onSelect?: (item) => void | Promise\<void>

Defined in: src/references/types.ts:115

Side effect when an item (or the action-only group row) is chosen, e.g. opening a file dialog or running an action. Called before toReference.

Parameters

item

ReferenceItem\<unknown>

Returns

void | Promise\<void>

Inherited from

ReferenceProvider.onSelect


renderItem?

optional renderItem?: (item) => ReactNode

Defined in: src/references/types.ts:110

Custom row renderer; falls back to label + description.

Parameters

item

ReferenceItem\<unknown>

Returns

ReactNode

Inherited from

ReferenceProvider.renderItem


optional search?: (query) => ReferenceItem\<unknown>[] | Promise\<ReferenceItem\<unknown>[]>

Defined in: src/references/types.ts:108

Return the items to list for the current query. Omit for an action-only provider (its group row triggers onSelect directly).

Parameters

query

string

Returns

ReferenceItem\<unknown>[] | Promise\<ReferenceItem\<unknown>[]>

Inherited from

ReferenceProvider.search


toReference?

optional toReference?: (item) => PendingReference

Defined in: src/references/types.ts:120

How a chosen item serializes onto the message. Omit for pure actions that produce their reference asynchronously (e.g. upload, via its own callback).

Parameters

item

ReferenceItem\<unknown>

Returns

PendingReference

Inherited from

ReferenceProvider.toReference