Member Search
@teamix/member-search
成员组件
Quick start
npm install --save @teamix/member-search
API
| 参数名 | 说明 | 必填 | 类型 | 默认值 | 备注 |
|---|---|---|---|---|---|
| trigger | / | true | any | / | / |
| className | / | false | string | / | / |
| id | / | false | string | / | / |
| dropdownProps | The props of Fusion Dropdown Component | false | object | / | / |
| inputProps | The props of Fusion Input Component | false | object | / | / |
| loadingProps | The props of Fusion Loading Component | false | object | / | / |
| selectedUsers | Selected users | false | UserType[] | [] | / |
| recentSelectedUsers | Recent selected users | false | UserType[] | / | / |
| multiple | / | false | boolean | false | / |
| debounceTime | The debounce time of typing text and searching | false | number | 500 | / |
| onCancel | The click event of cancel button | false | () => void | / | multiple only |
| onOk | The click event of done button | false | (selectedUsers: UserType[]) => void | / | / |
| onCancelButtonText | / | false | string | 'Cancel' | / |
| onOkButtonText | / | false | string | 'Done' | / |
| searchFn | Search function | true | (q: string) => Promise<UserType[]> | / | / |
| showSearch | Whether show search (input) component | false | boolean | true | / |
| showRecentSelectedUsers | Whether show recent selected users | false | boolean | true | / |
| onInputSearchIconClick | / | false | (e) => void | / | / |
| subMenuLabelRecentSelected | The label of recent selected users | false | string | 'Recent Selected Users' | / |
| subMenuLabelSearch | The label of search | false | string | 'Search Result' | / |
| subMenuLabelInitSearch | The label of init search | false | string | 'Init Search Result' | / |
| initSearch | Do searchFn when dropdown is visible | false | boolean | true | / |
| notFoundMessage | / | false | string / ReactNode | 'Not Found' | / |
| onVisibleChangeCallback | / | false | (visible: boolean) => void | / | / |
| renderDisplayName | 自定义渲染展示名 | false | (user: UserType) => string | / | / |
| inputAutoFocus | 是否开启 Input 自动聚焦 | false | boolean | true | / |
UserType
export interface UserType {
identifier: string,
displayName: string,
displayFullName?: string,
realName: string,
nickName: string,
avatar: string,
division?: {
displayFullName?: string,
},
}