{
"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.UserProfilesKibanaProvider",
"type": "Function",
"tags": [],
"label": "UserProfilesKibanaProvider",
"description": [
"\nKibana-specific Provider that maps to known dependency types."
],
"signature": [
"({ children, ...services }: React.PropsWithChildren<",
{
"pluginId": "@kbn/user-profile-components",
"scope": "common",
"docId": "kibKbnUserProfileComponentsPluginApi",
"section": "def-common.UserProfilesKibanaDependencies",
"text": "UserProfilesKibanaDependencies"
},
">) => JSX.Element"
],
"path": "packages/kbn-user-profile-components/src/services.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/user-profile-components",
"id": "def-common.UserProfilesKibanaProvider.$1",
"type": "CompoundType",
"tags": [],
"label": "{\n children,\n ...services\n}",
"description": [],
"signature": [
"React.PropsWithChildren<",
{
"pluginId": "@kbn/user-profile-components",
"scope": "common",
"docId": "kibKbnUserProfileComponentsPluginApi",
"section": "def-common.UserProfilesKibanaDependencies",
"text": "UserProfilesKibanaDependencies"
},
">"
],
"path": "packages/kbn-user-profile-components/src/services.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": [
"