Skip to components
DEVELOPER REFERENCE · v4.0.0

AiRequestTrail API

Props, callbacks and methods. Select an underlined type to explore its fields, allowed values and callback arguments.

AiRequestTrail11 props3 callbacks0 methods

Props11

AiRequestTrail props
NameTypeDescription
translationsOptional
AiUiTranslationsInspect type
Overrides the default UI strings. Supply only the entries you want to translate and retain any placeholders.
itemsRequired
readonly AiRequestTrailItem[]Inspect type
Ordered items to render. Each item follows the shape shown in the expanded type.
disabledOptionalboolean | undefinedDisables user interaction with the control.
removalsDisabledOptionalboolean | undefinedPrevents removing request-trail steps while leaving the remaining presentation available.
labelOptionalstring | undefinedLabel content or accessible name for the component, as rendered by this control.
triggerLabelOptional
((count: number) => string) | undefinedInspect type
Formats the number of applied requests into the request-trail trigger label.
clearLabelOptionalstring | undefinedText for the clear-all action.
clearDescriptionOptionalstring | undefinedAccessible explanation of what clearing the request trail does.
removeLabelOptional
((item: AiRequestTrailItem) => string) | undefinedInspect type
Accessible text or formatter for the remove-item action.
countLabelOptional
((count: number) => string) | undefinedInspect type
Formats a count into localized display text.
changedMessageOptionalstring | undefinedMessage shown when manual changes invalidate the current AI request trail.

Events and callbacks3

AiRequestTrail events and callbacks
NameTypeDescription
onRemoveRequired
(id: string) => voidInspect type
Requests removal of the indicated item; the application owns updating its data.
onClearRequired
() => voidInspect type
Requests that the application clear the current list or selection.
onEmptyOptional
(() => void) | undefinedInspect type
Called when removing the final request leaves the request trail empty.

Methods0

No component-specific imperative methods. Use props and callbacks to control this component.