@lark-project/ui-kit-plugin
Version:
Lark Project UI Kit Plugin
61 lines (60 loc) • 2.24 kB
TypeScript
/**
* Copyright (c) 2024 Lark Technologies Pte. Ltd.
*
* Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted,provided that the above copyright notice and this permission notice appear in all copies.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
* IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO
* EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
* ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
import { User } from '@lark-project/js-sdk';
import { IBaseDOMProps, IBaseSelectProps } from '../../types';
export interface IUserSelectProps extends IBaseDOMProps, IBaseSelectProps {
/**
* 当前选中的用户 ids
*/
userIds?: string[];
/**
* userIds 变化时回调函数
* @param userIds
* @param users
* @returns
*/
onChange?: (userIds: string[], users: User[]) => void;
/**
* 自定义选项范围，限制可选的 userIds 范围
*/
optionIds?: string[];
/**
* 禁用的 userIds，不可选择 / 反选
*/
disabledIds?: string[];
/**
* 禁止弹出用户卡片
*/
userCardDisabled?: boolean;
/**
* 空间标识
* 1. 影响用户搜索范围：
*
* 1.1 非企业互联租户，无论是否提供 spaceId，搜索全租户
*
* 1.2 企业互联租户
*
* 1.2.1 提供 spaceId:
* a. spaceId 是开放空间：搜索本租户 + 协作租户开放名单
* b. spaceId 不是开放空间：只搜索本租户
*
* 1.2.2 不提供 spaceId: 搜索本租户 + 协作租户开放名单
* 2. 影响推荐用户列表:
*
* 2.1 提供 spaceId: 默认推荐用户列表对不同空间有区分
*
* 2.2 未提供 spaceId: 默认推荐用户列表对不同空间无区别
*/
spaceId?: string;
}