Sanity Library Reference Docs
    Preparing search index...

    Function AssigneePicker

    • A controlled picker for people and project roles. A nonempty role catalog supplies the role choices; otherwise the picker uses member-held roles. Your host owns the selected value and commits changes through the engine.

      Parameters

      • __namedParameters: ProjectMembersState & {
            eligibleRoles?: readonly string[];
            maxUsers?: number;
            onChange: (value: readonly Assignee[]) => void;
            roleAliases?: RoleAliases;
            value: readonly Assignee[];
        }
        • OptionaleligibleRoles?: readonly string[]

          Limit new choices to these role names and people who fulfill any of them. The role filter retains initial selections so they remain removable. Omit to offer all available people and roles.

        • OptionalmaxUsers?: number

          Set to 1 for a single person: choosing another replaces the selected person and preserves selected roles. Omit to allow multiple people. Only 1 is enforced as a limit. Do not rely on other values to limit selection.

        • onChange: (value: readonly Assignee[]) => void

          Receives the complete next selection, not an added or removed item.

        • OptionalroleAliases?: RoleAliases

          Normalized aliases from the workflow definition. They widen eligible people and role-member counts without changing literal inbox ownership.

        • value: readonly Assignee[]

      Returns Element

    Settings

    Member Visibility