mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 02:09:32 -04:00
1207 lines
No EOL
43 KiB
JSON
1207 lines
No EOL
43 KiB
JSON
{
|
|
"id": "@kbn/user-profile-components",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.getUserDisplayName",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "getUserDisplayName",
|
|
"description": [
|
|
"\nDetermines the display name for the provided user information."
|
|
],
|
|
"signature": [
|
|
"(params: ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.GetUserDisplayNameParams",
|
|
"text": "GetUserDisplayNameParams"
|
|
},
|
|
") => string"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.getUserDisplayName.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "params",
|
|
"description": [
|
|
"Set of available user's name-related fields."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.GetUserDisplayNameParams",
|
|
"text": "GetUserDisplayNameParams"
|
|
}
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatar",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UserAvatar",
|
|
"description": [
|
|
"\nRenders an avatar given a user profile"
|
|
],
|
|
"signature": [
|
|
"({ user, avatar, ...rest }: React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserAvatarProps",
|
|
"text": "UserAvatarProps"
|
|
},
|
|
">) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatar.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{ user, avatar, ...rest }",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserAvatarProps",
|
|
"text": "UserAvatarProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatarTip",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UserAvatarTip",
|
|
"description": [
|
|
"\nRenders a user avatar with tooltip"
|
|
],
|
|
"signature": [
|
|
"({ user, avatar, ...rest }: React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserAvatarProps",
|
|
"text": "UserAvatarProps"
|
|
},
|
|
">) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar_tip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatarTip.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{ user, avatar, ...rest }",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserAvatarProps",
|
|
"text": "UserAvatarProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar_tip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesPopover",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UserProfilesPopover",
|
|
"description": [
|
|
"\nRenders a selectable component inside a popover given a list of user profiles"
|
|
],
|
|
"signature": [
|
|
"<Option extends ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileWithAvatar",
|
|
"text": "UserProfileWithAvatar"
|
|
},
|
|
" | null>({ title, selectableProps, ...popoverProps }: ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesPopoverProps",
|
|
"text": "UserProfilesPopoverProps"
|
|
},
|
|
"<Option>) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_popover.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesPopover.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n title,\n selectableProps,\n ...popoverProps\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesPopoverProps",
|
|
"text": "UserProfilesPopoverProps"
|
|
},
|
|
"<Option>"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_popover.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectable",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UserProfilesSelectable",
|
|
"description": [
|
|
"\nRenders a selectable component given a list of user profiles"
|
|
],
|
|
"signature": [
|
|
"<Option extends ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileWithAvatar",
|
|
"text": "UserProfileWithAvatar"
|
|
},
|
|
" | null>({ selectedOptions, defaultOptions, options, onChange, onSearchChange, isLoading, singleSelection, limit, height, loadingMessage, noMatchesMessage, emptyMessage, errorMessage, searchPlaceholder, searchInputId, selectedStatusMessage, limitReachedMessage, nullOptionLabel, defaultOptionsLabel, clearButtonLabel, }: ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesSelectableProps",
|
|
"text": "UserProfilesSelectableProps"
|
|
},
|
|
"<Option>) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectable.$1",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "{\n selectedOptions,\n defaultOptions,\n options,\n onChange,\n onSearchChange,\n isLoading = false,\n singleSelection = false,\n limit,\n height,\n loadingMessage,\n noMatchesMessage,\n emptyMessage,\n errorMessage,\n searchPlaceholder,\n searchInputId,\n selectedStatusMessage,\n limitReachedMessage,\n nullOptionLabel,\n defaultOptionsLabel,\n clearButtonLabel,\n}",
|
|
"description": [],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesSelectableProps",
|
|
"text": "UserProfilesSelectableProps"
|
|
},
|
|
"<Option>"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserToolTip",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "UserToolTip",
|
|
"description": [
|
|
"\nRenders a tooltip with user information"
|
|
],
|
|
"signature": [
|
|
"({ user, avatar, ...rest }: React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserToolTipProps",
|
|
"text": "UserToolTipProps"
|
|
},
|
|
">) => JSX.Element"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_tooltip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserToolTip.$1",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "{ user, avatar, ...rest }",
|
|
"description": [],
|
|
"signature": [
|
|
"React.PropsWithChildren<",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserToolTipProps",
|
|
"text": "UserToolTipProps"
|
|
},
|
|
">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_tooltip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": [],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"interfaces": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.GetUserDisplayNameParams",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "GetUserDisplayNameParams",
|
|
"description": [
|
|
"\nSet of available name-related fields to pick as display name."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.GetUserDisplayNameParams.username",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "username",
|
|
"description": [
|
|
"\nUsername of the user."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.GetUserDisplayNameParams.email",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "email",
|
|
"description": [
|
|
"\nOptional email of the user."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.GetUserDisplayNameParams.full_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "full_name",
|
|
"description": [
|
|
"\nOptional full name of the user."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatarProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserAvatarProps",
|
|
"description": [
|
|
"\nProps of {@link UserAvatar} component"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserAvatarProps",
|
|
"text": "UserAvatarProps"
|
|
},
|
|
" extends Omit<",
|
|
"EuiAvatarProps",
|
|
", \"name\" | \"type\" | \"color\" | \"iconColor\" | \"iconType\" | \"iconSize\" | \"initials\" | \"initialsLength\" | \"imageUrl\">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatarProps.user",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [
|
|
"\nUser to be rendered"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileUserInfo",
|
|
"text": "UserProfileUserInfo"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserAvatarProps.avatar",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "avatar",
|
|
"description": [
|
|
"\nAvatar data of user to be rendered"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileAvatarData",
|
|
"text": "UserProfileAvatarData"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfile",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProfile",
|
|
"description": [
|
|
"\nIMPORTANT:\n\nThe types in this file have been imported from\n`x-pack/plugins/security/common/model/user_profile.ts`\n\nWhen making changes please ensure to keep both files in sync.\n\nDescribes basic properties stored in user profile."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfile",
|
|
"text": "UserProfile"
|
|
},
|
|
"<D>"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfile.uid",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "uid",
|
|
"description": [
|
|
"\nUnique ID for of the user profile."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfile.enabled",
|
|
"type": "boolean",
|
|
"tags": [],
|
|
"label": "enabled",
|
|
"description": [
|
|
"\nIndicates whether user profile is enabled or not."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfile.user",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [
|
|
"\nInformation about the user that owns profile."
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileUserInfo",
|
|
"text": "UserProfileUserInfo"
|
|
}
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfile.data",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "data",
|
|
"description": [
|
|
"\nUser specific data associated with the profile."
|
|
],
|
|
"signature": [
|
|
"{ [P in keyof D]?: D[P] | undefined; }"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileAvatarData",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProfileAvatarData",
|
|
"description": [
|
|
"\nAvatar stored in user profile."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileAvatarData.initials",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "initials",
|
|
"description": [
|
|
"\nOptional initials (two letters) of the user to use as avatar if avatar picture isn't specified."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileAvatarData.color",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "color",
|
|
"description": [
|
|
"\nBackground color of the avatar when initials are used."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileAvatarData.imageUrl",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "imageUrl",
|
|
"description": [
|
|
"\nBase64 data URL for the user avatar image."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesPopoverProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProfilesPopoverProps",
|
|
"description": [
|
|
"\nProps of {@link UserProfilesPopover} component"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesPopoverProps",
|
|
"text": "UserProfilesPopoverProps"
|
|
},
|
|
"<Option> extends ",
|
|
"EuiPopoverProps"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_popover.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesPopoverProps.title",
|
|
"type": "CompoundType",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "title",
|
|
"description": [
|
|
"\nTitle of the popover"
|
|
],
|
|
"signature": [
|
|
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_popover.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesPopoverProps.selectableProps",
|
|
"type": "Object",
|
|
"tags": [
|
|
"see"
|
|
],
|
|
"label": "selectableProps",
|
|
"description": [
|
|
"\nProps forwarded to selectable component"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesSelectableProps",
|
|
"text": "UserProfilesSelectableProps"
|
|
},
|
|
"<Option>"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_popover.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProfilesSelectableProps",
|
|
"description": [
|
|
"\nProps of {@link UserProfilesSelectable} component"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfilesSelectableProps",
|
|
"text": "UserProfilesSelectableProps"
|
|
},
|
|
"<Option> extends Pick<",
|
|
"EuiSelectableProps",
|
|
"<{}>, \"height\" | \"errorMessage\" | \"singleSelection\" | \"loadingMessage\" | \"noMatchesMessage\" | \"emptyMessage\">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.defaultOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "defaultOptions",
|
|
"description": [
|
|
"\nList of users to be rendered as suggestions."
|
|
],
|
|
"signature": [
|
|
"Option[] | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.selectedOptions",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "selectedOptions",
|
|
"description": [
|
|
"\nList of selected users or `null` (no users)."
|
|
],
|
|
"signature": [
|
|
"Option[] | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.options",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"\nList of users from search results. Should be updated based on the search term provided by `onSearchChange` callback."
|
|
],
|
|
"signature": [
|
|
"Option[] | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.limit",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "limit",
|
|
"description": [
|
|
"\nMaximum number of users allowed to be selected.\n\nThis limit is not enforced and only used to show a warning message."
|
|
],
|
|
"signature": [
|
|
"number | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.onChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onChange",
|
|
"description": [
|
|
"\nPasses back the current selection."
|
|
],
|
|
"signature": [
|
|
"((options: Option[]) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.onChange.$1",
|
|
"type": "Array",
|
|
"tags": [],
|
|
"label": "options",
|
|
"description": [
|
|
"Either the list of selected users or `null` (no users)."
|
|
],
|
|
"signature": [
|
|
"Option[]"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.onSearchChange",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "onSearchChange",
|
|
"description": [
|
|
"\nPasses back the search term."
|
|
],
|
|
"signature": [
|
|
"((searchTerm: string) => void) | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.onSearchChange.$1",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchTerm",
|
|
"description": [
|
|
"Search term"
|
|
],
|
|
"signature": [
|
|
"string"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.isLoading",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "isLoading",
|
|
"description": [
|
|
"\nLoading indicator for asynchronous search operations."
|
|
],
|
|
"signature": [
|
|
"boolean | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.searchPlaceholder",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchPlaceholder",
|
|
"description": [
|
|
"\nPlaceholder text of search field."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.searchInputId",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "searchInputId",
|
|
"description": [
|
|
"\nIdentifier of search field."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.selectedStatusMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "selectedStatusMessage",
|
|
"description": [
|
|
"\nReturns message for number of selected users."
|
|
],
|
|
"signature": [
|
|
"((selectedCount: number) => React.ReactNode) | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.selectedStatusMessage.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "selectedCount",
|
|
"description": [
|
|
"Number of selected users"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.limitReachedMessage",
|
|
"type": "Function",
|
|
"tags": [],
|
|
"label": "limitReachedMessage",
|
|
"description": [
|
|
"\nReturns message when maximum number of selected users are reached."
|
|
],
|
|
"signature": [
|
|
"((limit: number) => React.ReactNode) | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.limitReachedMessage.$1",
|
|
"type": "number",
|
|
"tags": [],
|
|
"label": "limit",
|
|
"description": [
|
|
"Maximum number of users allowed to be selected"
|
|
],
|
|
"signature": [
|
|
"number"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"isRequired": true
|
|
}
|
|
],
|
|
"returnComment": []
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.clearButtonLabel",
|
|
"type": "CompoundType",
|
|
"tags": [],
|
|
"label": "clearButtonLabel",
|
|
"description": [
|
|
"\nLabel for clear button."
|
|
],
|
|
"signature": [
|
|
"boolean | React.ReactChild | React.ReactFragment | React.ReactPortal | null | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.nullOptionLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "nullOptionLabel",
|
|
"description": [
|
|
"\nLabel of \"no users\" option."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfilesSelectableProps.defaultOptionsLabel",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "defaultOptionsLabel",
|
|
"description": [
|
|
"\nLabel for default options group separator."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profiles_selectable.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileUserInfo",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserProfileUserInfo",
|
|
"description": [
|
|
"\nBasic user information returned in user profile."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileUserInfo.username",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "username",
|
|
"description": [
|
|
"\nUsername of the user."
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileUserInfo.email",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "email",
|
|
"description": [
|
|
"\nOptional email of the user."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileUserInfo.full_name",
|
|
"type": "string",
|
|
"tags": [],
|
|
"label": "full_name",
|
|
"description": [
|
|
"\nOptional full name of the user."
|
|
],
|
|
"signature": [
|
|
"string | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_profile.ts",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserToolTipProps",
|
|
"type": "Interface",
|
|
"tags": [],
|
|
"label": "UserToolTipProps",
|
|
"description": [
|
|
"\nProps of {@link UserToolTip} component"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserToolTipProps",
|
|
"text": "UserToolTipProps"
|
|
},
|
|
" extends Omit<",
|
|
"EuiToolTipProps",
|
|
", \"title\" | \"content\">"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_tooltip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"children": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserToolTipProps.user",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "user",
|
|
"description": [
|
|
"\nUser to be rendered"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileUserInfo",
|
|
"text": "UserProfileUserInfo"
|
|
}
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_tooltip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
},
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserToolTipProps.avatar",
|
|
"type": "Object",
|
|
"tags": [],
|
|
"label": "avatar",
|
|
"description": [
|
|
"\nAvatar data of user to be rendered"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileAvatarData",
|
|
"text": "UserProfileAvatarData"
|
|
},
|
|
" | undefined"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_tooltip.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false
|
|
}
|
|
],
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [
|
|
{
|
|
"parentPluginId": "@kbn/user-profile-components",
|
|
"id": "def-common.UserProfileWithAvatar",
|
|
"type": "Type",
|
|
"tags": [],
|
|
"label": "UserProfileWithAvatar",
|
|
"description": [
|
|
"\nConvenience type for a {@link UserProfile} with avatar data"
|
|
],
|
|
"signature": [
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfile",
|
|
"text": "UserProfile"
|
|
},
|
|
"<{ avatar?: ",
|
|
{
|
|
"pluginId": "@kbn/user-profile-components",
|
|
"scope": "common",
|
|
"docId": "kibKbnUserProfileComponentsPluginApi",
|
|
"section": "def-common.UserProfileAvatarData",
|
|
"text": "UserProfileAvatarData"
|
|
},
|
|
" | undefined; }>"
|
|
],
|
|
"path": "packages/kbn-user-profile-components/src/user_avatar.tsx",
|
|
"deprecated": false,
|
|
"trackAdoption": false,
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"objects": []
|
|
}
|
|
} |