Skip to components
DEVELOPER REFERENCE · v4.0.0

AssigneePickerLayout API

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

AssigneePickerLayout15 props1 callbacks0 methods

Props15

AssigneePickerLayout props
NameTypeDescription
idRequiredstringIdentifier used to associate the control with labels, popup content or other elements.
optionsRequired
AssigneeOption[]Inspect type
Available choices or control configuration, according to the declared type; expand it to inspect each field.
valueRequired
AssigneeAssignment[]Inspect type
Value to display or edit. The declared type identifies the supported representation; change callbacks describe how edited values are emitted.
changeRequired
(value: AssigneeAssignment[]) => voidInspect type
Updates the draft assignee selection without committing the field.
applyRequired
() => voidInspect type
Commits the editor draft through the application-provided handler.
cancelRequired
() => voidInspect type
Cancel action or handler for discarding the current draft; false hides an action descriptor.
themeOptionalstring | undefinedTheme applied to popup content so it matches its surrounding application.
defaultUnitsRequirednumberDefault allocation units applied when assigning a resource.
showAvatarsOptionalboolean | undefinedDisplays resource avatars beside assignee labels.
textOptional
AssigneeText | undefinedInspect type
Display text or localized text overrides; expand the type when this prop accepts an object.
autoApplyOptionalboolean | undefinedApply completed edits automatically. Set false to require explicit Apply.
showActionsOptionalboolean | undefinedShow Apply/Cancel buttons. Defaults to true only when autoApply is false.
queryRequiredstringCurrent search query used to filter the available options.
searchRefOptional
RefObject<HTMLInputElement> | undefinedInspect type
Reference to the assignee search input.
childrenRequired
ComponentChildrenInspect type
Content rendered inside the component. Supply nodes from the framework adapter you are using.

Events and callbacks1

AssigneePickerLayout events and callbacks
NameTypeDescription
onQueryChangeRequired
(value: string) => voidInspect type
Receives the updated search text used to filter the available items.

Methods0

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