Caido

Slots ​

ButtonSlotContent ​

ButtonSlotContent = DefineSlotContent<"Button", { icon?: string; label: string; onClick: () => void; }>

Content for a button slot.

CommandSlotContent ​

CommandSlotContent = DefineSlotContent<"Command", { commandId: CommandID; icon?: string; }>

Content for a command slot.

CustomSlotContent ​

CustomSlotContent<TProps> = DefineSlotContent<"Custom", { definition: ComponentDefinition<TProps>; }>

Content for a custom component slot.

Type Parameters ​

Type ParameterDefault type
TProps extends SlotContentPropsGroupSlotContentProps

DefineAddToSlotFn() ​

DefineAddToSlotFn<TMap> = <K>(slot: K, spec: TMap[K]) => void

A function type for adding content to slots.

Type Parameters ​

Type Parameter
TMap extends Record<string, DefineSlotContent<string, Record<string, unknown>>>

Type Parameters ​

Type Parameter
K extends string | number | symbol

Parameters ​

ParameterType
slotK
specTMap[K]

Returns ​

void

SlotContent ​

SlotContent<TProps> = ButtonSlotContent | CustomSlotContent<TProps> | CommandSlotContent

Union type of all possible slot content types.

Type Parameters ​

Type ParameterDefault type
TProps extends SlotContentPropsGroupSlotContentProps

SlotContentProps ​

SlotContentProps = SlotContentPropsInternal & object

The props for a slot content.

Type Declaration ​

sdk ​

sdk: Caido

SlotContentPropsGroup ​

SlotContentPropsGroup = SlotContentProps | SlotContentPropsInternal

The props group for a slot content.

SlotContentPropsInternal ​

SlotContentPropsInternal = object

The internal props for a slot content.