UI Event Bus

Usage

Events bus is created by the AppLoader and passed down as a prop to both the registration function and to the root component.

For more information please see Event Bus section.

Type Aliases

EventDataTypes

EventDataTypes: object

Type defining global event data object

Type declaration

Member	Type
followId	string
isLoggedIn	boolean
itemId	string
itemType	EntityTypes
profileID	string
reflectId	string
version	string

Source

ui-events.ts:108

---

NotificationEvent

NotificationEvent: object

Type defining notification event object

Type declaration

Member	Type
data	object
data.dismissable	boolean
data.message	string
data.snackbarIcon	React.ReactElement
data.type	NotificationTypes
event	NotificationEvents

Source

ui-events.ts:68

---

RoutesRegisterEvent

RoutesRegisterEvent: object

Type defining route registration event

Type declaration

Member	Type
data	object
data.menuItems	IMenuItem | IMenuItem[]
data.name	string
data.navRoutes	Record<string, string>
event	RouteRegistrationEvents

Source

ui-events.ts:18

---

ThemingEvent

ThemingEvent: object

Type defining theming event object

Type declaration

Member	Type
data	object
data.name	string
event	ThemingEvents

Source

ui-events.ts:38

---

UIEventData

UIEventData: object | ContentBlockRegisterEvent | ExtensionRegisterEvent | WidgetRegisterEvent | AppRegisterEvent | RoutesRegisterEvent | AnalyticsEventData | ThemingEvent | NotificationEvent

Type defining global UI event data object

Source

ui-events.ts:123

Enumerations

EntityTypes

Enum defining entity types

Enumeration Members

Enumeration Member	Value
ARTICLE	4
BEAM	0
PROFILE	1
REFLECT	2
TAG	3

---

EventTypes

Enum defining global event types

Enumeration Members

Enumeration Member	Value
GoBackToPreviousRoute	"routing:go-back-to-previous-route"
HideSidebar	"hide-sidebar"
HideWidgets	"hide-widgets"
InstallIntegration	"install-integration"
Instantiated	"instantiated"
LayoutShowLoadingUser	"layout:show-loading-user"
SetInitialCookieType	"set-initial-cookie-type"
ShowSidebar	"show-sidebar"
ShowWidgets	"show-widgets"
UninstallIntegration	"uninstall-integration"

---

NotificationEvents

Enum defining notification events

Enumeration Members

Enumeration Member	Value
ShowNotification	"show-notification"
SnoozeNotifications	"snooze-notifications"
UnsnoozeNotifications	"unsnooze-notifications"

---

NotificationTypes

Enum defining notification types

Enumeration Members

Enumeration Member	Value
Alert	"alert"
Caution	"caution"
Error	"error"
Info	"info"
Success	"success"

---

RouteRegistrationEvents

Enum defining events related to loading and unloading of global routes

Enumeration Members

Enumeration Member	Value
RegisterRoutes	"register-routes"

---

ThemingEvents

Enum defining events related to theming

Enumeration Members

Enumeration Member	Value
ThemeChange	"theme-change"