INotificationsPanelProps
export interface INotificationsPanelProps extends INotificationsPanelCustomComponentsProps
Extends: INotificationsPanelCustomComponentsProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(Optional) Backend to use.
| |||
boolean | (Optional) Enable export to document storage.
| ||
number | (Optional) Height of the item in notifications list in pixels.
| ||
number | (Optional) Padding of the notification item (from left and right) in pixels.
| ||
number | (Optional) Gap between notification items in the list in pixels.
| ||
number | (Optional) Number of notifications to load per page.
| ||
(Optional) Locale to use. | |||
number | (Optional) Maximum height of the notifications list in pixels.
| ||
number | string | (Optional) Optionally override max width of the notifications panel.
| ||
(notification: INotification) => void | (Optional) Callback for notification click. | ||
number | (Optional) Refresh interval in milliseconds.
| ||
boolean | (Optional) Enable inline rendering of the notifications panel
| ||
number | (Optional) Number of skeleton items to render when loading notifications.
| ||
string | (Optional) Workspace ID to use.
|
Property details
INotificationsPanelProps.backendproperty
Backend to use.
- If not defined, the backend from the BackendProvider context will be used.
backend?: IAnalyticalBackend;
INotificationsPanelProps.enableScheduleNotificationsproperty
Enable export to document storage.
- Default: false
enableScheduleNotifications?: boolean;
INotificationsPanelProps.itemHeightproperty
Height of the item in notifications list in pixels.
- Default: 52
itemHeight?: number;
INotificationsPanelProps.itemPaddingproperty
Padding of the notification item (from left and right) in pixels.
- Default: 15
itemPadding?: number;
INotificationsPanelProps.itemsGapproperty
Gap between notification items in the list in pixels.
- Default: 10
itemsGap?: number;
INotificationsPanelProps.itemsPerPageproperty
Number of notifications to load per page.
- Default: 50
itemsPerPage?: number;
INotificationsPanelProps.localeproperty
Locale to use.
locale?: ILocale;
INotificationsPanelProps.maxListHeightproperty
Maximum height of the notifications list in pixels.
- Default: 527 - Does not have effect when renderInline is true - inline rendering always fills the parent container.
maxListHeight?: number;
INotificationsPanelProps.maxWidthproperty
Optionally override max width of the notifications panel.
- Does not have effect when renderInline is true - inline rendering always fills the parent container.
maxWidth?: number | string;
INotificationsPanelProps.onNotificationClickproperty
Callback for notification click.
onNotificationClick?: (notification: INotification) => void;
INotificationsPanelProps.refreshIntervalproperty
Refresh interval in milliseconds.
- Default: 600000 (10 minutes) - If set to 0, notifications won’t be refreshed automatically.
refreshInterval?: number;
INotificationsPanelProps.renderInlineproperty
Enable inline rendering of the notifications panel
- Default: false - If enabled, NotificationsPanelButton won’t be rendered, and NotificationsPanel won’t be rendered inside modal - This is useful when you want to render notifications panel in a custom modal.
renderInline?: boolean;
INotificationsPanelProps.skeletonItemsCountproperty
Number of skeleton items to render when loading notifications.
- Default: 5
skeletonItemsCount?: number;
INotificationsPanelProps.workspaceproperty
Workspace ID to use.
- If not defined, the workspace ID from the WorkspaceProvider context will be used. - If workspace is not defined and there is no WorkspaceProvider, notifications will be loaded from all workspaces.
workspace?: string;