Skip to content
Caps0.4.0
API reference

blocks/resource-select

Import

Section titled “Import”
Import
import * as api from "@fungi.computer/caps/blocks/resource-select";

Exports

Section titled “Exports”
Kind Export Description
type alias ResourceOption Caller-provided resource option data.
type alias ResourceSelectProps Props accepted by ResourceSelect.
type alias DataAttributes Native data-* attribute map accepted alongside typed props.
constant ResourceSelect A resource-selection block with caller-owned options and selected value.

ResourceOptiontype alias

Section titled “ResourceOption”
Signature
type ResourceOption = object;

Caller-provided resource option data.

Properties

Section titled “Properties”

disabled?

Section titled “disabled?”
Signature
optional disabled?: boolean;

id

Section titled “id”
Signature
id: string;

label

Section titled “label”
Signature
label: string;

searchText?

Section titled “searchText?”
Signature
optional searchText?: string;

ResourceSelectPropstype alias

Section titled “ResourceSelectProps”
Signature
type ResourceSelectProps = object;

Props accepted by ResourceSelect.

Properties

Section titled “Properties”

onSelect

Section titled “onSelect”
Signature
onSelect: (option) => void;

Called after an option is selected.

Parameters
Section titled “Parameters”
Parameter Type
option ResourceOption
Returns
Section titled “Returns”

void

options

Section titled “options”
Signature
options: readonly ResourceOption[];

placeholder?

Section titled “placeholder?”
Signature
optional placeholder?: string;

triggerProps?

Section titled “triggerProps?”
Signature
optional triggerProps?: ButtonHTMLAttributes<HTMLButtonElement> & DataAttributes;

Native caller metadata, including data-* attributes.

value?

Section titled “value?”
Signature
optional value?: string;

DataAttributestype alias

Section titled “DataAttributes”
Signature
type DataAttributes = Record<
  `data-${string}`,
  boolean | number | string | undefined
>;

Native data-* attribute map accepted alongside typed props.

ResourceSelectconstant

Section titled “ResourceSelect”
Signature
const ResourceSelect: ForwardRefExoticComponent<
  ResourceSelectProps & RefAttributes<HTMLButtonElement>
>;

A resource-selection block with caller-owned options and selected value.