grassroot
Install

DocsAPI referenceHeadlessnotification-center

notification-center headless API

The core connector and vanilla mount are always visible. Use the framework choice to inspect native composition, props, outputs, context and hooks for the selected adapter.

Machine APIPlatform contract

@grassroot/ui-headless-core/notification-center

Core connector and vanilla API

35 exports
View source packages/ui-headless/core/src/notification-center/index.ts

applyNotificationIntent

function
DeclarationView source
applyNotificationIntentts
declare function applyNotificationIntent<TContent>(items: readonly NotificationHostItem<TContent>[], action: NotificationAction): NotificationHostItem<TContent>[];
Name
Kind
Type
Requirement
items
parameter
readonly NotificationHostItem<TContent>[]
required
action
parameter
NotificationAction
required
return
return value
NotificationHostItem<TContent>[]
n/a
Name
items
Kind
parameter
Type
readonly NotificationHostItem<TContent>[]
Requirement
required
Name
action
Kind
parameter
Type
NotificationAction
Requirement
required
Name
return
Kind
return value
Type
NotificationHostItem<TContent>[]
Requirement
n/a

connectNotificationCenter

function
DeclarationView source
connectNotificationCenterts
declare function connectNotificationCenter<TContent = unknown>(service: NotificationCenterService, scope: PartScope, options?: NotificationCenterConnectOptions<TContent>): NotificationCenterApi<TContent>;
Name
Kind
Type
Requirement
service
parameter
NotificationCenterService
required
scope
parameter
PartScope
required
options
parameter
NotificationCenterConnectOptions<TContent>
optional
return
return value
NotificationCenterApi<TContent>
n/a
Name
service
Kind
parameter
Type
NotificationCenterService
Requirement
required
Name
scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
NotificationCenterConnectOptions<TContent>
Requirement
optional
Name
return
Kind
return value
Type
NotificationCenterApi<TContent>
Requirement
n/a

countUnreadNotificationProjections

function

Duplicate of frozen `countUnreadNotifications`.

DeclarationView source
countUnreadNotificationProjectionsts
declare function countUnreadNotificationProjections(items: readonly NotificationItemProjection[]): number;
Name
Kind
Type
Requirement
items
parameter
readonly NotificationItemProjection[]
required
return
return value
number
n/a
Name
items
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
return
Kind
return value
Type
number
Requirement
n/a

groupNotificationProjections

function

Duplicate of frozen `groupNotifications`.

DeclarationView source
groupNotificationProjectionsts
declare function groupNotificationProjections(items: readonly NotificationItemProjection[]): readonly NotificationGroupProjection[];
Name
Kind
Type
Requirement
items
parameter
readonly NotificationItemProjection[]
required
return
return value
readonly NotificationGroupProjection[]
n/a
Name
items
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
return
Kind
return value
Type
readonly NotificationGroupProjection[]
Requirement
n/a

ingestNotificationMessages

function
DeclarationView source
ingestNotificationMessagests
declare function ingestNotificationMessages<TContent>(sidecar: NotificationMessageSidecar<TContent>, items: readonly NotificationHostItem<TContent>[]): void;
Name
Kind
Type
Requirement
sidecar
parameter
NotificationMessageSidecar<TContent>
required
items
parameter
readonly NotificationHostItem<TContent>[]
required
return
return value
void
n/a
Name
sidecar
Kind
parameter
Type
NotificationMessageSidecar<TContent>
Requirement
required
Name
items
Kind
parameter
Type
readonly NotificationHostItem<TContent>[]
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

materializeNotificationItems

function
DeclarationView source
materializeNotificationItemsts
declare function materializeNotificationItems<TContent>(projections: readonly NotificationItemProjection[], sidecar: NotificationMessageSidecar<TContent>): NotificationHostItem<TContent>[];
Name
Kind
Type
Requirement
projections
parameter
readonly NotificationItemProjection[]
required
sidecar
parameter
NotificationMessageSidecar<TContent>
required
return
return value
NotificationHostItem<TContent>[]
n/a
Name
projections
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
sidecar
Kind
parameter
Type
NotificationMessageSidecar<TContent>
Requirement
required
Name
return
Kind
return value
Type
NotificationHostItem<TContent>[]
Requirement
n/a

mountNotificationCenter

function
DeclarationView source
mountNotificationCenterts
declare function mountNotificationCenter(container: HTMLElement, options?: MountNotificationCenterOptions): NotificationCenterMount;
Name
Kind
Type
Requirement
container
parameter
HTMLElement
required
options
parameter
MountNotificationCenterOptions
optional
return
return value
NotificationCenterMount
n/a
Name
container
Kind
parameter
Type
HTMLElement
Requirement
required
Name
options
Kind
parameter
Type
MountNotificationCenterOptions
Requirement
optional
Name
return
Kind
return value
Type
NotificationCenterMount
Requirement
n/a

MountNotificationCenterOptions

interface
DeclarationView source
MountNotificationCenterOptionsts
interface MountNotificationCenterOptions {
  readonly items?: readonly NotificationHostItem<string>[];
  readonly defaultItems?: readonly NotificationHostItem<string>[];
  readonly title?: string;
  readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<string>) => void;
  readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
defaultItems
property
readonly NotificationHostItem<string>[]
optional
items
property
readonly NotificationHostItem<string>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<string>) => void
optional
onOpen
property
(id: string) => void
optional
title
property
string
optional
Name
defaultItems
Kind
property
Type
readonly NotificationHostItem<string>[]
Requirement
optional
Name
items
Kind
property
Type
readonly NotificationHostItem<string>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<string>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional

NotificationAction

type
DeclarationView source
NotificationActionts
type NotificationAction = {
  readonly type: "markAllRead";
} | {
  readonly type: "dismiss";
  readonly id: string;
};

notificationCenterAnatomy

value
DeclarationView source
notificationCenterAnatomyts
export declare const notificationCenterAnatomy: {
  readonly scope: "notification-center";
  readonly parts: readonly ["root", "header", "title", "badge", "mark-all", "list", "group", "group-name", "group-list", "row", "unread-dot", "icon", "body", "message", "time", "open", "dismiss", "empty"];
};
Name
Kind
Type
Requirement
parts
property
readonly ["root", "header", "title", "badge", "mark-all", "list", "group", "group-name", "group-list", "row", "unread-dot", "icon", "body", "message", "time", "open", "dismiss", "empty"]
required
scope
property
"notification-center"
required
Name
parts
Kind
property
Type
readonly ["root", "header", "title", "badge", "mark-all", "list", "group", "group-name", "group-list", "row", "unread-dot", "icon", "body", "message", "time", "open", "dismiss", "empty"]
Requirement
required
Name
scope
Kind
property
Type
"notification-center"
Requirement
required

NotificationCenterApi

interface
DeclarationView source
NotificationCenterApits
interface NotificationCenterApi<TContent = unknown> {
  rootProps(): PartProps;
  headerProps(): PartProps;
  titleProps(): PartProps;
  badgeProps(): PartProps;
  markAllProps(): PartProps;
  listProps(): PartProps;
  groupProps(name: string): PartProps;
  groupNameProps(name: string): PartProps;
  groupListProps(name: string): PartProps;
  rowProps(id: string): PartProps;
  unreadDotProps(id: string): PartProps;
  iconProps(id: string): PartProps;
  bodyProps(id: string): PartProps;
  messageProps(id: string): PartProps;
  timeProps(id: string): PartProps;
  openProps(id: string): PartProps;
  dismissProps(id: string): PartProps;
  emptyProps(): PartProps;
  readonly items: readonly NotificationItemProjection[];
  readonly hostItems: readonly NotificationHostItem<TContent>[];
  readonly groups: readonly NotificationGroupProjection[];
  readonly unreadCount: number;
  readonly title: string;
  readonly empty: boolean;
}
Name
Kind
Type
Requirement
badgeProps
method
() => PartProps
required
bodyProps
method
(id: string) => PartProps
required
dismissProps
method
(id: string) => PartProps
required
empty
property
boolean
required
emptyProps
method
() => PartProps
required
groupListProps
method
(name: string) => PartProps
required
groupNameProps
method
(name: string) => PartProps
required
groupProps
method
(name: string) => PartProps
required
groups
property
readonly NotificationGroupProjection[]
required
headerProps
method
() => PartProps
required
hostItems
property
readonly NotificationHostItem<TContent>[]
required
iconProps
method
(id: string) => PartProps
required
items
property
readonly NotificationItemProjection[]
required
listProps
method
() => PartProps
required
Name
badgeProps
Kind
method
Type
() => PartProps
Requirement
required
Name
bodyProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
dismissProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
empty
Kind
property
Type
boolean
Requirement
required
Name
emptyProps
Kind
method
Type
() => PartProps
Requirement
required
Name
groupListProps
Kind
method
Type
(name: string) => PartProps
Requirement
required
Name
groupNameProps
Kind
method
Type
(name: string) => PartProps
Requirement
required
Name
groupProps
Kind
method
Type
(name: string) => PartProps
Requirement
required
Name
groups
Kind
property
Type
readonly NotificationGroupProjection[]
Requirement
required
Name
headerProps
Kind
method
Type
() => PartProps
Requirement
required
Name
hostItems
Kind
property
Type
readonly NotificationHostItem<TContent>[]
Requirement
required
Name
iconProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
items
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
required
Name
listProps
Kind
method
Type
() => PartProps
Requirement
required
Name
markAllProps
Kind
method
Type
() => PartProps
Requirement
required
Name
messageProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
openProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
rootProps
Kind
method
Type
() => PartProps
Requirement
required
Name
rowProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
timeProps
Kind
method
Type
(id: string) => PartProps
Requirement
required
Name
title
Kind
property
Type
string
Requirement
required
Name
titleProps
Kind
method
Type
() => PartProps
Requirement
required
Name
unreadCount
Kind
property
Type
number
Requirement
required
Name
unreadDotProps
Kind
method
Type
(id: string) => PartProps
Requirement
required

NotificationCenterChangeReason

type
DeclarationView source
NotificationCenterChangeReasonts
type NotificationCenterChangeReason = "pointer" | "keyboard" | "programmatic";

NotificationCenterCommand

type
DeclarationView source
NotificationCenterCommandts
type NotificationCenterCommand = CommandObject & {
  readonly type: "ITEMS_CHANGE_REQUEST";
  readonly items: readonly NotificationItemProjection[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterChangeReason;
};
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
readonly NotificationItemProjection[]
required
reason
property
NotificationCenterChangeReason
required
type
property
string
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterChangeReason
Requirement
required
Name
type
Kind
property
Type
string
Requirement
required

NotificationCenterConnectOptions

interface
DeclarationView source
NotificationCenterConnectOptionsts
interface NotificationCenterConnectOptions<TContent = unknown> {
  readonly sidecar?: NotificationMessageSidecar<TContent>;
  readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<TContent>) => void;
  readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
optional
onOpen
property
(id: string) => void
optional
sidecar
property
NotificationMessageSidecar<TContent>
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional
Name
sidecar
Kind
property
Type
NotificationMessageSidecar<TContent>
Requirement
optional

NotificationCenterContext

type
DeclarationView source
NotificationCenterContextts
type NotificationCenterContext = {
  readonly mode: BindingMode;
  readonly items: readonly NotificationItemProjection[];
};
Name
Kind
Type
Requirement
items
property
readonly NotificationItemProjection[]
required
mode
property
BindingMode
required
Name
items
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
required
Name
mode
Kind
property
Type
BindingMode
Requirement
required

NotificationCenterEvent

type
DeclarationView source
NotificationCenterEventts
type NotificationCenterEvent = {
  readonly type: "MARK_ALL_READ";
  readonly reason: NotificationCenterChangeReason;
} | {
  readonly type: "DISMISS";
  readonly id: string;
  readonly reason: NotificationCenterChangeReason;
} | {
  readonly type: "RESET";
};

NotificationCenterInput

type
DeclarationView source
NotificationCenterInputts
type NotificationCenterInput = {
  /** Controlled committed projections. Defining it (including `[]`) fixes controlled mode. */
  readonly items?: readonly NotificationItemProjection[];
  /** Uncontrolled initial projections. @default [] */
  readonly defaultItems?: readonly NotificationItemProjection[];
  /** Accessible name. Presentation-only; the machine ignores it. @default "Notifications" */
  readonly title?: string;
};
Name
Kind
Type
Requirement
Description
defaultItems
property
readonly NotificationItemProjection[]
optional
Uncontrolled initial projections.
items
property
readonly NotificationItemProjection[]
optional
Controlled committed projections. Defining it (including `[]`) fixes controlled mode.
title
property
string
optional
Accessible name. Presentation-only; the machine ignores it.
Name
defaultItems
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
optional
Description
Uncontrolled initial projections.
Name
items
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
optional
Description
Controlled committed projections. Defining it (including `[]`) fixes controlled mode.
Name
title
Kind
property
Type
string
Requirement
optional
Description
Accessible name. Presentation-only; the machine ignores it.

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

notificationCenterMachine

value
DeclarationView source
notificationCenterMachinets
export declare const notificationCenterMachine: NotificationCenterMachine;

NotificationCenterMount

interface
DeclarationView source
NotificationCenterMountts
interface NotificationCenterMount {
  readonly service: NotificationCenterService;
  readonly connector: NotificationCenterApi<string>;
  readonly root: HTMLElement;
  setHostItems(items: readonly NotificationHostItem<string>[]): void;
  destroy(): void;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi<string>
required
destroy
method
() => void
required
root
property
HTMLElement
required
service
property
NotificationCenterService
required
setHostItems
method
(items: readonly NotificationHostItem<string>[]) => void
required
Name
connector
Kind
property
Type
NotificationCenterApi<string>
Requirement
required
Name
destroy
Kind
method
Type
() => void
Requirement
required
Name
root
Kind
property
Type
HTMLElement
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
setHostItems
Kind
method
Type
(items: readonly NotificationHostItem<string>[]) => void
Requirement
required

NotificationCenterPart

type
DeclarationView source
NotificationCenterPartts
type NotificationCenterPart = (typeof notificationCenterAnatomy.parts)[number];

notificationCenterSelectors

value
DeclarationView source
notificationCenterSelectorsts
export declare const notificationCenterSelectors: {
  items: (snapshot: NotificationCenterSnapshot) => readonly NotificationItemProjection[];
  mode: (snapshot: NotificationCenterSnapshot) => BindingMode;
  unreadCount: (snapshot: NotificationCenterSnapshot) => number;
  groups: (snapshot: NotificationCenterSnapshot) => readonly NotificationGroupProjection[];
};
Name
Kind
Type
Requirement
groups
property
(snapshot: NotificationCenterSnapshot) => readonly NotificationGroupProjection[]
required
items
property
(snapshot: NotificationCenterSnapshot) => readonly NotificationItemProjection[]
required
mode
property
(snapshot: NotificationCenterSnapshot) => BindingMode
required
unreadCount
property
(snapshot: NotificationCenterSnapshot) => number
required
Name
groups
Kind
property
Type
(snapshot: NotificationCenterSnapshot) => readonly NotificationGroupProjection[]
Requirement
required
Name
items
Kind
property
Type
(snapshot: NotificationCenterSnapshot) => readonly NotificationItemProjection[]
Requirement
required
Name
mode
Kind
property
Type
(snapshot: NotificationCenterSnapshot) => BindingMode
Requirement
required
Name
unreadCount
Kind
property
Type
(snapshot: NotificationCenterSnapshot) => number
Requirement
required

NotificationCenterService

type
DeclarationView source
NotificationCenterServicets
type NotificationCenterService = Service<NotificationCenterInput, NotificationCenterStateValue, NotificationCenterContext, NotificationCenterEvent, NotificationCenterCommand>;

NotificationCenterSnapshot

type
DeclarationView source
NotificationCenterSnapshotts
type NotificationCenterSnapshot = Snapshot<NotificationCenterStateValue, NotificationCenterContext>;

NotificationCenterStateValue

type
DeclarationView source
NotificationCenterStateValuets
type NotificationCenterStateValue = "active";

NotificationGroupProjection

type
DeclarationView source
NotificationGroupProjectionts
type NotificationGroupProjection = {
  readonly name: string;
  readonly rows: readonly NotificationItemProjection[];
};
Name
Kind
Type
Requirement
name
property
string
required
rows
property
readonly NotificationItemProjection[]
required
Name
name
Kind
property
Type
string
Requirement
required
Name
rows
Kind
property
Type
readonly NotificationItemProjection[]
Requirement
required

NotificationHostItem

interface
DeclarationView source
NotificationHostItemts
interface NotificationHostItem<TContent = unknown> {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly message: TContent;
  readonly time: string;
  readonly unread?: boolean;
}
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
message
property
TContent
required
time
property
string
required
unread
property
boolean
optional
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
message
Kind
property
Type
TContent
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
optional

NotificationItemProjection

type
DeclarationView source
NotificationItemProjectionts
type NotificationItemProjection = {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly time: string;
  readonly unread: boolean;
};
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
time
property
string
required
unread
property
boolean
required
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
required

NotificationKind

type
DeclarationView source
NotificationKindts
type NotificationKind = "deploy" | "alert" | "mention" | "pr" | "error";

NotificationMessageSidecar

interface
DeclarationView source
NotificationMessageSidecarts
interface NotificationMessageSidecar<TContent = unknown> {
  readonly messages: Map<string, TContent>;
}
Name
Kind
Type
Requirement
messages
property
Map<string, TContent>
required
Name
messages
Kind
property
Type
Map<string, TContent>
Requirement
required

notificationProjectionsEqual

function
DeclarationView source
notificationProjectionsEqualts
declare function notificationProjectionsEqual(left: readonly NotificationItemProjection[], right: readonly NotificationItemProjection[]): boolean;
Name
Kind
Type
Requirement
left
parameter
readonly NotificationItemProjection[]
required
right
parameter
readonly NotificationItemProjection[]
required
return
return value
boolean
n/a
Name
left
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
right
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
return
Kind
return value
Type
boolean
Requirement
n/a

projectNotificationItem

function
DeclarationView source
projectNotificationItemts
declare function projectNotificationItem(item: {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly time: string;
  readonly unread?: boolean;
}): NotificationItemProjection;
Name
Kind
Type
Requirement
item
parameter
{ readonly id: string; readonly group: string; readonly kind: NotificationKind; readonly time: string; readonly unread?: boolean; }
required
return
return value
NotificationItemProjection
n/a
Name
item
Kind
parameter
Type
{ readonly id: string; readonly group: string; readonly kind: NotificationKind; readonly time: string; readonly unread?: boolean; }
Requirement
required
Name
return
Kind
return value
Type
NotificationItemProjection
Requirement
n/a

projectNotificationItems

function
DeclarationView source
projectNotificationItemsts
declare function projectNotificationItems(items: readonly {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly time: string;
  readonly unread?: boolean;
}[]): NotificationItemProjection[];
Name
Kind
Type
Requirement
items
parameter
readonly { readonly id: string; readonly group: string; readonly kind: NotificationKind; readonly time: string; readonly unread?: boolean; }[]
required
return
return value
NotificationItemProjection[]
n/a
Name
items
Kind
parameter
Type
readonly { readonly id: string; readonly group: string; readonly kind: NotificationKind; readonly time: string; readonly unread?: boolean; }[]
Requirement
required
Name
return
Kind
return value
Type
NotificationItemProjection[]
Requirement
n/a

reduceNotificationProjections

function

Duplicate of frozen `reduceNotifications`, with S6 same-reference no-ops.

DeclarationView source
reduceNotificationProjectionsts
declare function reduceNotificationProjections(items: readonly NotificationItemProjection[], action: NotificationAction): readonly NotificationItemProjection[];
Name
Kind
Type
Requirement
items
parameter
readonly NotificationItemProjection[]
required
action
parameter
NotificationAction
required
return
return value
readonly NotificationItemProjection[]
n/a
Name
items
Kind
parameter
Type
readonly NotificationItemProjection[]
Requirement
required
Name
action
Kind
parameter
Type
NotificationAction
Requirement
required
Name
return
Kind
return value
Type
readonly NotificationItemProjection[]
Requirement
n/a

runNotificationCenterCommand

function
DeclarationView source
runNotificationCenterCommandts
declare function runNotificationCenterCommand<TContent = unknown>(command: NotificationCenterCommand, _scope: PartScope, options?: NotificationCenterConnectOptions<TContent>): void;
Name
Kind
Type
Requirement
command
parameter
NotificationCenterCommand
required
_scope
parameter
PartScope
required
options
parameter
NotificationCenterConnectOptions<TContent>
optional
return
return value
void
n/a
Name
command
Kind
parameter
Type
NotificationCenterCommand
Requirement
required
Name
_scope
Kind
parameter
Type
PartScope
Requirement
required
Name
options
Kind
parameter
Type
NotificationCenterConnectOptions<TContent>
Requirement
optional
Name
return
Kind
return value
Type
void
Requirement
n/a

Framework adapters

Each panel keeps its adapter's public vocabulary. React compound exports, Vue composables, standalone Angular declarations, Svelte components, and Solid hooks stay native to their framework.

React example follows below.

React imports

@grassroot/ui-headless-react/notification-centerts
import { Badge, Body, Dismiss, Empty, Group, GroupList, GroupName, Header } from "@grassroot/ui-headless-react/notification-center"; // +11 more exports

Vue imports

@grassroot/ui-headless-vue/notification-centerts
<script setup lang="ts">
import { NotificationCenterBadge, NotificationCenterBody, NotificationCenterDismiss, NotificationCenterEmpty, NotificationCenterGroup, NotificationCenterGroupList, NotificationCenterGroupName, NotificationCenterHeader } from "@grassroot/ui-headless-vue/notification-center"; // +10 more exports
</script>

Angular imports

@grassroot/ui-headless-angular/notification-centerts
import { Component } from "@angular/core";
import { GR_NOTIFICATION_CENTER_DECLARATIONS } from "@grassroot/ui-headless-angular/notification-center";
 
@Component({ standalone: true, imports: [GR_NOTIFICATION_CENTER_DECLARATIONS], template: `<!-- compose the notification-center parts here -->` })
export class Example {}

Svelte imports

@grassroot/ui-headless-svelte/notification-centerts
<script lang="ts">
  import { NotificationCenterBadge, NotificationCenterBody, NotificationCenterDismiss, NotificationCenterEmpty, NotificationCenterGroup, NotificationCenterGroupList, NotificationCenterGroupName, NotificationCenterHeader } from "@grassroot/ui-headless-svelte/notification-center"; // +10 more exports
</script>

Solid imports

@grassroot/ui-headless-solid/notification-centerts
import { NotificationCenterBadge, NotificationCenterBody, NotificationCenterDismiss, NotificationCenterEmpty, NotificationCenterGroup, NotificationCenterGroupList, NotificationCenterGroupName, NotificationCenterHeader } from "@grassroot/ui-headless-solid/notification-center"; // +10 more exports

@grassroot/ui-headless-react/notification-center

React adapter

34 exports
View source packages/ui-headless/react/src/notification-center/index.ts

Badge

value
DeclarationView source
Badgets
export declare const Badge: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Body

value
DeclarationView source
Bodyts
export declare const Body: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Dismiss

value
DeclarationView source
Dismissts
export declare const Dismiss: import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Empty

value
DeclarationView source
Emptyts
export declare const Empty: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Group

value
DeclarationView source
Groupts
export declare const Group: import("react").ForwardRefExoticComponent<NotificationCenterGroupProps & import("react").RefAttributes<HTMLLIElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

GroupList

value
DeclarationView source
GroupListts
export declare const GroupList: import("react").ForwardRefExoticComponent<NotificationCenterGroupListProps & import("react").RefAttributes<HTMLUListElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

GroupName

value
DeclarationView source
GroupNamets
export declare const GroupName: import("react").ForwardRefExoticComponent<NotificationCenterKeyedDivProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Header

value
DeclarationView source
Headerts
export declare const Header: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Icon

value
DeclarationView source
Iconts
export declare const Icon: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

List

value
DeclarationView source
Listts
export declare const List: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLUListElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

MarkAll

value
DeclarationView source
MarkAllts
export declare const MarkAll: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Message

value
DeclarationView source
Messagets
export declare const Message: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

NotificationCenter

value
DeclarationView source
NotificationCenterts
export declare const NotificationCenter: {
  Root: import("react").ForwardRefExoticComponent<NotificationCenterRootProps & import("react").RefAttributes<HTMLDivElement>>;
  Header: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLDivElement>>;
  Title: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLSpanElement>>;
  Badge: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLSpanElement>>;
  MarkAll: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLButtonElement>>;
  List: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLUListElement>>;
  Group: import("react").ForwardRefExoticComponent<NotificationCenterGroupProps & import("react").RefAttributes<HTMLLIElement>>;
  GroupName: import("react").ForwardRefExoticComponent<NotificationCenterKeyedDivProps & import("react").RefAttributes<HTMLDivElement>>;
  GroupList: import("react").ForwardRefExoticComponent<NotificationCenterGroupListProps & import("react").RefAttributes<HTMLUListElement>>;
  Row: import("react").ForwardRefExoticComponent<NotificationCenterRowProps & import("react").RefAttributes<HTMLLIElement>>;
  UnreadDot: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>;
  Icon: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>;
  Body: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
  Message: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
  Time: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
  Open: import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
  Dismiss: import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
  Empty: import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
    asChild?: boolean;
    children?: import("react").ReactNode;
  }) & import("react").RefAttributes<HTMLDivElement>>;
};
Name
Kind
Type
Requirement
Badge
property
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLSpanElement>>
required
Body
property
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>
required
Dismiss
property
import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>
required
Empty
property
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLDivElement>>
required
Group
property
import("react").ForwardRefExoticComponent<NotificationCenterGroupProps & import("react").RefAttributes<HTMLLIElement>>
required
GroupList
property
import("react").ForwardRefExoticComponent<NotificationCenterGroupListProps & import("react").RefAttributes<HTMLUListElement>>
required
GroupName
property
import("react").ForwardRefExoticComponent<NotificationCenterKeyedDivProps & import("react").RefAttributes<HTMLDivElement>>
required
Header
property
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLDivElement>>
required
Icon
property
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>
required
List
property
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLUListElement>>
required
MarkAll
property
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLButtonElement>>
required
Message
property
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>
required
Open
property
import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>
required
Root
property
import("react").ForwardRefExoticComponent<NotificationCenterRootProps & import("react").RefAttributes<HTMLDivElement>>
required
Name
Badge
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLSpanElement>>
Requirement
required
Name
Body
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Dismiss
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
Name
Empty
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Group
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterGroupProps & import("react").RefAttributes<HTMLLIElement>>
Requirement
required
Name
GroupList
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterGroupListProps & import("react").RefAttributes<HTMLUListElement>>
Requirement
required
Name
GroupName
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterKeyedDivProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Header
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Icon
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>
Requirement
required
Name
List
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLUListElement>>
Requirement
required
Name
MarkAll
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
Name
Message
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Open
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>
Requirement
required
Name
Root
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterRootProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Row
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterRowProps & import("react").RefAttributes<HTMLLIElement>>
Requirement
required
Name
Time
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>
Requirement
required
Name
Title
Kind
property
Type
import("react").ForwardRefExoticComponent<(import("react").ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & { asChild?: boolean; children?: import("react").ReactNode; }) & import("react").RefAttributes<HTMLSpanElement>>
Requirement
required
Name
UnreadDot
Kind
property
Type
import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>
Requirement
required

NotificationCenterButtonProps

interface
DeclarationView source
NotificationCenterButtonPropsts
interface NotificationCenterButtonProps extends Omit<ComponentPropsWithoutRef<"button">, "type"> {
  readonly asChild?: boolean;
  readonly id: string;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

NotificationCenterContext

value
DeclarationView source
NotificationCenterContextts
export declare const NotificationCenterContext: import("react").Context<NotificationCenterContextValue | null>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

NotificationCenterContextValue

interface
DeclarationView source
NotificationCenterContextValuets
interface NotificationCenterContextValue {
  readonly service: NotificationCenterService;
  readonly connector: NotificationCenterApi;
  readonly scope: PartScope;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required

NotificationCenterGroupListProps

interface
DeclarationView source
NotificationCenterGroupListPropsts
interface NotificationCenterGroupListProps extends ComponentPropsWithoutRef<"ul"> {
  readonly asChild?: boolean;
  readonly name: string;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
name
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
required

NotificationCenterGroupProps

interface
DeclarationView source
NotificationCenterGroupPropsts
interface NotificationCenterGroupProps extends ComponentPropsWithoutRef<"li"> {
  readonly asChild?: boolean;
  readonly name: string;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
name
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
required

NotificationCenterItemProps

interface
DeclarationView source
NotificationCenterItemPropsts
interface NotificationCenterItemProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
  readonly id: string;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

NotificationCenterKeyedDivProps

interface
DeclarationView source
NotificationCenterKeyedDivPropsts
interface NotificationCenterKeyedDivProps extends ComponentPropsWithoutRef<"div"> {
  readonly asChild?: boolean;
  readonly name: string;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
name
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
name
Kind
property
Type
string
Requirement
required

NotificationCenterRootProps

interface
DeclarationView source
NotificationCenterRootPropsts
interface NotificationCenterRootProps extends Omit<ComponentPropsWithoutRef<"div">, "onChange"> {
  readonly asChild?: boolean;
  readonly items?: readonly NotificationHostItem<ReactNode>[];
  readonly defaultItems?: readonly NotificationHostItem<ReactNode>[];
  readonly title?: string;
  readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<ReactNode>) => void;
  readonly onOpen?: (id: string) => void;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
defaultItems
property
readonly NotificationHostItem<ReactNode>[]
optional
items
property
readonly NotificationHostItem<ReactNode>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<ReactNode>) => void
optional
onOpen
property
(id: string) => void
optional
title
property
string
optional
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
defaultItems
Kind
property
Type
readonly NotificationHostItem<ReactNode>[]
Requirement
optional
Name
items
Kind
property
Type
readonly NotificationHostItem<ReactNode>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<ReactNode>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional

NotificationCenterRowProps

interface
DeclarationView source
NotificationCenterRowPropsts
interface NotificationCenterRowProps extends ComponentPropsWithoutRef<"li"> {
  readonly asChild?: boolean;
  readonly id: string;
  readonly children?: ReactNode;
}
Name
Kind
Type
Requirement
asChild
property
boolean
optional
children
property
ReactNode
optional
id
property
string
required
Name
asChild
Kind
property
Type
boolean
Requirement
optional
Name
children
Kind
property
Type
ReactNode
Requirement
optional
Name
id
Kind
property
Type
string
Requirement
required

NotificationHostItem

interface
DeclarationView source
NotificationHostItemts
interface NotificationHostItem<TContent = unknown> {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly message: TContent;
  readonly time: string;
  readonly unread?: boolean;
}
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
message
property
TContent
required
time
property
string
required
unread
property
boolean
optional
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
message
Kind
property
Type
TContent
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
optional

Open

value
DeclarationView source
Opents
export declare const Open: import("react").ForwardRefExoticComponent<NotificationCenterButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Root

value
DeclarationView source
Rootts
export declare const Root: import("react").ForwardRefExoticComponent<NotificationCenterRootProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Row

value
DeclarationView source
Rowts
export declare const Row: import("react").ForwardRefExoticComponent<NotificationCenterRowProps & import("react").RefAttributes<HTMLLIElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Time

value
DeclarationView source
Timets
export declare const Time: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLDivElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

Title

value
DeclarationView source
Titlets
export declare const Title: import("react").ForwardRefExoticComponent<(ComponentPropsWithoutRef<keyof HTMLElementTagNameMap> & {
  asChild?: boolean;
  children?: ReactNode;
}) & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

UnreadDot

value
DeclarationView source
UnreadDotts
export declare const UnreadDot: import("react").ForwardRefExoticComponent<NotificationCenterItemProps & import("react").RefAttributes<HTMLSpanElement>>;
Name
Kind
Type
Requirement
props
parameter
P
required
return
return value
ReactNode
n/a
Name
props
Kind
parameter
Type
P
Requirement
required
Name
return
Kind
return value
Type
ReactNode
Requirement
n/a

useNotificationCenter

function
DeclarationView source
useNotificationCenterts
declare function useNotificationCenter<TContent = unknown>(input: NotificationCenterInput, options?: UseNotificationCenterOptions<TContent>): UseNotificationCenterResult<TContent>;
Name
Kind
Type
Requirement
input
parameter
NotificationCenterInput
required
options
parameter
UseNotificationCenterOptions<TContent>
optional
return
return value
UseNotificationCenterResult<TContent>
n/a
Name
input
Kind
parameter
Type
NotificationCenterInput
Requirement
required
Name
options
Kind
parameter
Type
UseNotificationCenterOptions<TContent>
Requirement
optional
Name
return
Kind
return value
Type
UseNotificationCenterResult<TContent>
Requirement
n/a

useNotificationCenterContext

function
DeclarationView source
useNotificationCenterContextts
declare function useNotificationCenterContext(partName: string): NotificationCenterContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
NotificationCenterContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
NotificationCenterContextValue
Requirement
n/a

UseNotificationCenterOptions

interface
DeclarationView source
UseNotificationCenterOptionsts
interface UseNotificationCenterOptions<TContent = unknown> {
  readonly hostItems?: readonly NotificationHostItem<TContent>[];
  readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<TContent>) => void;
  readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
hostItems
property
readonly NotificationHostItem<TContent>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
optional
onOpen
property
(id: string) => void
optional
Name
hostItems
Kind
property
Type
readonly NotificationHostItem<TContent>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional

UseNotificationCenterResult

interface
DeclarationView source
UseNotificationCenterResultts
interface UseNotificationCenterResult<TContent = unknown> {
  readonly service: NotificationCenterService;
  readonly connector: NotificationCenterApi<TContent>;
  readonly scope: PartScope;
  readonly snapshot: NotificationCenterSnapshot;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi<TContent>
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
snapshot
property
NotificationCenterSnapshot
required
Name
connector
Kind
property
Type
NotificationCenterApi<TContent>
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
snapshot
Kind
property
Type
NotificationCenterSnapshot
Requirement
required

@grassroot/ui-headless-vue/notification-center

Vue adapter

26 exports
View source packages/ui-headless/vue/src/notification-center/index.ts

NotificationCenterBadge

value
DeclarationView source
NotificationCenterBadgets
export declare const NotificationCenterBadge: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterBody

value
DeclarationView source
NotificationCenterBodyts
export declare const NotificationCenterBody: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterContextKey

value
DeclarationView source
NotificationCenterContextKeyts
export declare const NotificationCenterContextKey: InjectionKey<NotificationCenterContextValue>;

NotificationCenterContextValue

interface
DeclarationView source
NotificationCenterContextValuets
interface NotificationCenterContextValue {
  readonly service: NotificationCenterService;
  readonly connector: NotificationCenterApi;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<NotificationCenterSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
snapshot
property
ShallowRef<NotificationCenterSnapshot>
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<NotificationCenterSnapshot>
Requirement
required

NotificationCenterDismiss

value
DeclarationView source
NotificationCenterDismissts
export declare const NotificationCenterDismiss: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterEmpty

value
DeclarationView source
NotificationCenterEmptyts
export declare const NotificationCenterEmpty: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterGroup

value
DeclarationView source
NotificationCenterGroupts
export declare const NotificationCenterGroup: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterGroupList

value
DeclarationView source
NotificationCenterGroupListts
export declare const NotificationCenterGroupList: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterGroupName

value
DeclarationView source
NotificationCenterGroupNamets
export declare const NotificationCenterGroupName: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterHeader

value
DeclarationView source
NotificationCenterHeaderts
export declare const NotificationCenterHeader: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterIcon

value
DeclarationView source
NotificationCenterIconts
export declare const NotificationCenterIcon: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

NotificationCenterList

value
DeclarationView source
NotificationCenterListts
export declare const NotificationCenterList: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterMarkAll

value
DeclarationView source
NotificationCenterMarkAllts
export declare const NotificationCenterMarkAll: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterMessage

value
DeclarationView source
NotificationCenterMessagets
export declare const NotificationCenterMessage: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterOpen

value
DeclarationView source
NotificationCenterOpents
export declare const NotificationCenterOpen: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterRoot

value
DeclarationView source
NotificationCenterRootts
export declare const NotificationCenterRoot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  items: {
    type: PropType<NotificationHostItem[] | undefined>;
    default: undefined;
  };
  defaultItems: {
    type: PropType<NotificationHostItem[] | undefined>;
    default: undefined;
  };
  title: {
    type: PropType<string | undefined>;
    default: undefined;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
  itemsChange: (_detail: NotificationCenterItemsChangeDetail) => true;
  open: (_id: string) => true;
}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  items: {
    type: PropType<NotificationHostItem[] | undefined>;
    default: undefined;
  };
  defaultItems: {
    type: PropType<NotificationHostItem[] | undefined>;
    default: undefined;
  };
  title: {
    type: PropType<string | undefined>;
    default: undefined;
  };
}>> & Readonly<{
  onItemsChange?: ((_detail: NotificationCenterItemsChangeDetail<unknown>) => any) | undefined;
  onOpen?: ((_id: string) => any) | undefined;
}>, {
  asChild: boolean;
  items: NotificationHostItem<unknown>[] | undefined;
  defaultItems: NotificationHostItem<unknown>[] | undefined;
  title: string | undefined;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterRow

value
DeclarationView source
NotificationCenterRowts
export declare const NotificationCenterRow: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterTime

value
DeclarationView source
NotificationCenterTimets
export declare const NotificationCenterTime: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterTitle

value
DeclarationView source
NotificationCenterTitlets
export declare const NotificationCenterTitle: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationCenterUnreadDot

value
DeclarationView source
NotificationCenterUnreadDotts
export declare const NotificationCenterUnreadDot: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
  [key: string]: any;
}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
  asChild: {
    type: BooleanConstructor;
    default: boolean;
  };
  name: {
    type: StringConstructor;
    required: boolean;
  };
  id: {
    type: StringConstructor;
    required: boolean;
  };
}>> & Readonly<{}>, {
  asChild: boolean;
}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;

NotificationHostItem

interface
DeclarationView source
NotificationHostItemts
interface NotificationHostItem<TContent = unknown> {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly message: TContent;
  readonly time: string;
  readonly unread?: boolean;
}
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
message
property
TContent
required
time
property
string
required
unread
property
boolean
optional
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
message
Kind
property
Type
TContent
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
optional

useNotificationCenter

function
DeclarationView source
useNotificationCenterts
declare function useNotificationCenter<TContent = unknown>(input: NotificationCenterInput | (() => NotificationCenterInput), options?: UseNotificationCenterOptions<TContent>): UseNotificationCenterResult<TContent>;
Name
Kind
Type
Requirement
input
parameter
NotificationCenterInput | (() => NotificationCenterInput)
required
options
parameter
UseNotificationCenterOptions<TContent>
optional
return
return value
UseNotificationCenterResult<TContent>
n/a
Name
input
Kind
parameter
Type
NotificationCenterInput | (() => NotificationCenterInput)
Requirement
required
Name
options
Kind
parameter
Type
UseNotificationCenterOptions<TContent>
Requirement
optional
Name
return
Kind
return value
Type
UseNotificationCenterResult<TContent>
Requirement
n/a

useNotificationCenterContext

function
DeclarationView source
useNotificationCenterContextts
declare function useNotificationCenterContext(partName: string): NotificationCenterContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
NotificationCenterContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
NotificationCenterContextValue
Requirement
n/a

UseNotificationCenterOptions

interface
DeclarationView source
UseNotificationCenterOptionsts
interface UseNotificationCenterOptions<TContent = unknown> {
  readonly hostItems?: readonly NotificationHostItem<TContent>[];
  readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<TContent>) => void;
  readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
hostItems
property
readonly NotificationHostItem<TContent>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
optional
onOpen
property
(id: string) => void
optional
Name
hostItems
Kind
property
Type
readonly NotificationHostItem<TContent>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional

UseNotificationCenterResult

interface
DeclarationView source
UseNotificationCenterResultts
interface UseNotificationCenterResult<TContent = unknown> {
  readonly service: NotificationCenterService;
  readonly connector: NotificationCenterApi<TContent>;
  readonly scope: PartScope;
  readonly snapshot: ShallowRef<NotificationCenterSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi<TContent>
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
snapshot
property
ShallowRef<NotificationCenterSnapshot>
required
Name
connector
Kind
property
Type
NotificationCenterApi<TContent>
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
snapshot
Kind
property
Type
ShallowRef<NotificationCenterSnapshot>
Requirement
required

@grassroot/ui-headless-angular/notification-center

Angular adapter

27 exports
View source packages/ui-headless/angular/src/notification-center/index.ts

createNotificationCenterStore

function
DeclarationView source
createNotificationCenterStorets
export declare function createNotificationCenterStore(initialInput?: NotificationCenterInput, options?: CreateNotificationCenterStoreOptions): NotificationCenterStore;
Name
Kind
Type
Requirement
initialInput
parameter
NotificationCenterInput
optional
options
parameter
CreateNotificationCenterStoreOptions
optional
return
return value
NotificationCenterStore
n/a
Name
initialInput
Kind
parameter
Type
NotificationCenterInput
Requirement
optional
Name
options
Kind
parameter
Type
CreateNotificationCenterStoreOptions
Requirement
optional
Name
return
Kind
return value
Type
NotificationCenterStore
Requirement
n/a

CreateNotificationCenterStoreOptions

interface
DeclarationView source
CreateNotificationCenterStoreOptionsts
export interface CreateNotificationCenterStoreOptions {
    readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail) => void;
    readonly onOpen?: (id: string) => void;
    readonly onCommit?: () => void;
}
Name
Kind
Type
Requirement
onCommit
property
() => void
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail) => void
optional
onOpen
property
(id: string) => void
optional
Name
onCommit
Kind
property
Type
() => void
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional

GR_NOTIFICATION_CENTER_DECLARATIONS

value
DeclarationView source
GR_NOTIFICATION_CENTER_DECLARATIONSts
export declare const GR_NOTIFICATION_CENTER_DECLARATIONS: readonly [typeof GrNotificationCenterRoot, typeof GrNotificationCenterHeader, typeof GrNotificationCenterTitle, typeof GrNotificationCenterBadge, typeof GrNotificationCenterMarkAll, typeof GrNotificationCenterList, typeof GrNotificationCenterGroup, typeof GrNotificationCenterGroupName, typeof GrNotificationCenterGroupList, typeof GrNotificationCenterRow, typeof GrNotificationCenterUnreadDot, typeof GrNotificationCenterIcon, typeof GrNotificationCenterBody, typeof GrNotificationCenterMessage, typeof GrNotificationCenterTime, typeof GrNotificationCenterOpen, typeof GrNotificationCenterDismiss, typeof GrNotificationCenterEmpty];

GrNotificationCenterBadge

class
DeclarationView source
GrNotificationCenterBadgets
export declare class GrNotificationCenterBadge implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterBadge, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterBadge, "[grNotificationCenterBadge]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterBadge, "[grNotificationCenterBadge]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterBadge, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterBadge, "[grNotificationCenterBadge]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterBadge, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterBody

class
DeclarationView source
GrNotificationCenterBodyts
export declare class GrNotificationCenterBody implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterBody, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterBody, "[grNotificationCenterBody]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterBody, "[grNotificationCenterBody]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterBody, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterBody, "[grNotificationCenterBody]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterBody, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterDismiss

class
DeclarationView source
GrNotificationCenterDismissts
export declare class GrNotificationCenterDismiss implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterDismiss, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterDismiss, "[grNotificationCenterDismiss]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterDismiss, "[grNotificationCenterDismiss]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterDismiss, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterDismiss, "[grNotificationCenterDismiss]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterDismiss, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterEmpty

class
DeclarationView source
GrNotificationCenterEmptyts
export declare class GrNotificationCenterEmpty implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterEmpty, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterEmpty, "[grNotificationCenterEmpty]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterEmpty, "[grNotificationCenterEmpty]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterEmpty, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterEmpty, "[grNotificationCenterEmpty]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterEmpty, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterGroup

class
DeclarationView source
GrNotificationCenterGroupts
export declare class GrNotificationCenterGroup implements OnDestroy {
    readonly name: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterGroup, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroup, "[grNotificationCenterGroup]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
name
property
import("@angular/core").InputSignal<string>
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroup, "[grNotificationCenterGroup]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroup, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
name
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroup, "[grNotificationCenterGroup]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroup, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterGroupList

class
DeclarationView source
GrNotificationCenterGroupListts
export declare class GrNotificationCenterGroupList implements OnDestroy {
    readonly name: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupList, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupList, "[grNotificationCenterGroupList]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
name
property
import("@angular/core").InputSignal<string>
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupList, "[grNotificationCenterGroupList]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupList, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
name
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupList, "[grNotificationCenterGroupList]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupList, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterGroupName

class
DeclarationView source
GrNotificationCenterGroupNamets
export declare class GrNotificationCenterGroupName implements OnDestroy {
    readonly name: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupName, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupName, "[grNotificationCenterGroupName]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
name
property
import("@angular/core").InputSignal<string>
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupName, "[grNotificationCenterGroupName]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupName, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
name
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterGroupName, "[grNotificationCenterGroupName]", never, { "name": { "alias": "name"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterGroupName, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterHeader

class
DeclarationView source
GrNotificationCenterHeaderts
export declare class GrNotificationCenterHeader implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterHeader, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterHeader, "[grNotificationCenterHeader]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterHeader, "[grNotificationCenterHeader]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterHeader, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterHeader, "[grNotificationCenterHeader]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterHeader, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterIcon

class
DeclarationView source
GrNotificationCenterIconts
export declare class GrNotificationCenterIcon implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterIcon, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterIcon, "[grNotificationCenterIcon]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterIcon, "[grNotificationCenterIcon]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterIcon, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterIcon, "[grNotificationCenterIcon]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterIcon, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterList

class
DeclarationView source
GrNotificationCenterListts
export declare class GrNotificationCenterList implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterList, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterList, "[grNotificationCenterList]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterList, "[grNotificationCenterList]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterList, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterList, "[grNotificationCenterList]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterList, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterMarkAll

class
DeclarationView source
GrNotificationCenterMarkAllts
export declare class GrNotificationCenterMarkAll implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterMarkAll, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterMarkAll, "[grNotificationCenterMarkAll]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterMarkAll, "[grNotificationCenterMarkAll]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterMarkAll, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterMarkAll, "[grNotificationCenterMarkAll]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterMarkAll, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterMessage

class
DeclarationView source
GrNotificationCenterMessagets
export declare class GrNotificationCenterMessage implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterMessage, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterMessage, "[grNotificationCenterMessage]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterMessage, "[grNotificationCenterMessage]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterMessage, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterMessage, "[grNotificationCenterMessage]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterMessage, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterOpen

class
DeclarationView source
GrNotificationCenterOpents
export declare class GrNotificationCenterOpen implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterOpen, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterOpen, "[grNotificationCenterOpen]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterOpen, "[grNotificationCenterOpen]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterOpen, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterOpen, "[grNotificationCenterOpen]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterOpen, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterRoot

class
DeclarationView source
GrNotificationCenterRootts
export declare class GrNotificationCenterRoot implements OnDestroy {
    readonly items: import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>;
    readonly defaultItems: import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>;
    readonly title: import("@angular/core").InputSignal<string | undefined>;
    readonly itemsChange: import("@angular/core").OutputEmitterRef<NotificationCenterItemsChangeDetail<unknown>>;
    readonly open: import("@angular/core").OutputEmitterRef<string>;
    private readonly elementRef;
    private readonly injector;
    private readonly listeners;
    private lastSynced;
    readonly store: NotificationCenterStore;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterRoot, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<GrNotificationCenterRoot, "gr-notification-center-root", never, { "items": { "alias": "items"; "required": false; "isSignal": true; }; "defaultItems": { "alias": "defaultItems"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; }, { "itemsChange": "itemsChange"; "open": "open"; }, never, ["*"], true, never>;
}
Name
Kind
Type
Requirement
defaultItems
property
import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>
required
elementRef
property
any
required
injector
property
any
required
items
property
import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>
required
itemsChange
property
import("@angular/core").OutputEmitterRef<NotificationCenterItemsChangeDetail<unknown>>
required
lastSynced
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
open
property
import("@angular/core").OutputEmitterRef<string>
required
ɵcmp
property
i0.ɵɵComponentDeclaration<GrNotificationCenterRoot, "gr-notification-center-root", never, { "items": { "alias": "items"; "required": false; "isSignal": true; }; "defaultItems": { "alias": "defaultItems"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; }, { "itemsChange": "itemsChange"; "open": "open"; }, never, ["*"], true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterRoot, never>
required
store
property
NotificationCenterStore
required
title
property
import("@angular/core").InputSignal<string | undefined>
required
Name
defaultItems
Kind
property
Type
import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
injector
Kind
property
Type
any
Requirement
required
Name
items
Kind
property
Type
import("@angular/core").InputSignal<readonly NotificationHostItem<unknown>[] | undefined>
Requirement
required
Name
itemsChange
Kind
property
Type
import("@angular/core").OutputEmitterRef<NotificationCenterItemsChangeDetail<unknown>>
Requirement
required
Name
lastSynced
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
open
Kind
property
Type
import("@angular/core").OutputEmitterRef<string>
Requirement
required
Name
ɵcmp
Kind
property
Type
i0.ɵɵComponentDeclaration<GrNotificationCenterRoot, "gr-notification-center-root", never, { "items": { "alias": "items"; "required": false; "isSignal": true; }; "defaultItems": { "alias": "defaultItems"; "required": false; "isSignal": true; }; "title": { "alias": "title"; "required": false; "isSignal": true; }; }, { "itemsChange": "itemsChange"; "open": "open"; }, never, ["*"], true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterRoot, never>
Requirement
required
Name
store
Kind
property
Type
NotificationCenterStore
Requirement
required
Name
title
Kind
property
Type
import("@angular/core").InputSignal<string | undefined>
Requirement
required

GrNotificationCenterRow

class
DeclarationView source
GrNotificationCenterRowts
export declare class GrNotificationCenterRow implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterRow, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterRow, "[grNotificationCenterRow]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterRow, "[grNotificationCenterRow]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterRow, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterRow, "[grNotificationCenterRow]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterRow, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterTime

class
DeclarationView source
GrNotificationCenterTimets
export declare class GrNotificationCenterTime implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterTime, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterTime, "[grNotificationCenterTime]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterTime, "[grNotificationCenterTime]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterTime, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterTime, "[grNotificationCenterTime]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterTime, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterTitle

class
DeclarationView source
GrNotificationCenterTitlets
export declare class GrNotificationCenterTitle implements OnDestroy {
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterTitle, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterTitle, "[grNotificationCenterTitle]", never, {}, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterTitle, "[grNotificationCenterTitle]", never, {}, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterTitle, never>
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterTitle, "[grNotificationCenterTitle]", never, {}, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterTitle, never>
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

GrNotificationCenterUnreadDot

class
DeclarationView source
GrNotificationCenterUnreadDotts
export declare class GrNotificationCenterUnreadDot implements OnDestroy {
    readonly id: import("@angular/core").InputSignal<string>;
    private readonly store;
    private readonly elementRef;
    private readonly listeners;
    private readonly consumerProps;
    private registeredKey;
    constructor();
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<GrNotificationCenterUnreadDot, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<GrNotificationCenterUnreadDot, "[grNotificationCenterUnreadDot]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>;
}
Name
Kind
Type
Requirement
consumerProps
property
any
required
elementRef
property
any
required
id
property
import("@angular/core").InputSignal<string>
required
listeners
property
any
required
ngOnDestroy
method
() => void
required
ɵdir
property
i0.ɵɵDirectiveDeclaration<GrNotificationCenterUnreadDot, "[grNotificationCenterUnreadDot]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
required
ɵfac
property
i0.ɵɵFactoryDeclaration<GrNotificationCenterUnreadDot, never>
required
registeredKey
property
any
required
store
property
any
required
Name
consumerProps
Kind
property
Type
any
Requirement
required
Name
elementRef
Kind
property
Type
any
Requirement
required
Name
id
Kind
property
Type
import("@angular/core").InputSignal<string>
Requirement
required
Name
listeners
Kind
property
Type
any
Requirement
required
Name
ngOnDestroy
Kind
method
Type
() => void
Requirement
required
Name
ɵdir
Kind
property
Type
i0.ɵɵDirectiveDeclaration<GrNotificationCenterUnreadDot, "[grNotificationCenterUnreadDot]", never, { "id": { "alias": "id"; "required": true; "isSignal": true; }; }, {}, never, never, true, never>
Requirement
required
Name
ɵfac
Kind
property
Type
i0.ɵɵFactoryDeclaration<GrNotificationCenterUnreadDot, never>
Requirement
required
Name
registeredKey
Kind
property
Type
any
Requirement
required
Name
store
Kind
property
Type
any
Requirement
required

ingestNotificationMessages

function
DeclarationView source
ingestNotificationMessagests
declare function ingestNotificationMessages<TContent>(sidecar: NotificationMessageSidecar<TContent>, items: readonly NotificationHostItem<TContent>[]): void;
Name
Kind
Type
Requirement
sidecar
parameter
NotificationMessageSidecar<TContent>
required
items
parameter
readonly NotificationHostItem<TContent>[]
required
return
return value
void
n/a
Name
sidecar
Kind
parameter
Type
NotificationMessageSidecar<TContent>
Requirement
required
Name
items
Kind
parameter
Type
readonly NotificationHostItem<TContent>[]
Requirement
required
Name
return
Kind
return value
Type
void
Requirement
n/a

NOTIFICATION_CENTER_STORE

value
DeclarationView source
NOTIFICATION_CENTER_STOREts
export declare const NOTIFICATION_CENTER_STORE: InjectionToken<NotificationCenterStore>;

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

NotificationCenterStore

interface
DeclarationView source
NotificationCenterStorets
export interface NotificationCenterStore {
    readonly service: NotificationCenterService;
    readonly connector: NotificationCenterApi;
    readonly scope: PartScope;
    readonly version: WritableSignal<number>;
    readonly sidecar: NotificationMessageSidecar<unknown>;
    start(): void;
    stop(): void;
    sync(input: NotificationCenterInput): void;
    bindItemsChange(handler: (detail: NotificationCenterItemsChangeDetail) => void): void;
    bindOpen(handler: (id: string) => void): void;
}
Name
Kind
Type
Requirement
bindItemsChange
method
(handler: (detail: NotificationCenterItemsChangeDetail) => void) => void
required
bindOpen
method
(handler: (id: string) => void) => void
required
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
sidecar
property
NotificationMessageSidecar<unknown>
required
start
method
() => void
required
stop
method
() => void
required
sync
method
(input: NotificationCenterInput) => void
required
version
property
WritableSignal<number>
required
Name
bindItemsChange
Kind
method
Type
(handler: (detail: NotificationCenterItemsChangeDetail) => void) => void
Requirement
required
Name
bindOpen
Kind
method
Type
(handler: (id: string) => void) => void
Requirement
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
sidecar
Kind
property
Type
NotificationMessageSidecar<unknown>
Requirement
required
Name
start
Kind
method
Type
() => void
Requirement
required
Name
stop
Kind
method
Type
() => void
Requirement
required
Name
sync
Kind
method
Type
(input: NotificationCenterInput) => void
Requirement
required
Name
version
Kind
property
Type
WritableSignal<number>
Requirement
required

provideNotificationCenterStore

function
DeclarationView source
provideNotificationCenterStorets
export declare function provideNotificationCenterStore(): Provider;
Name
Kind
Type
Requirement
return
return value
Provider
n/a
Name
return
Kind
return value
Type
Provider
Requirement
n/a

toNotificationCenterInput

function
DeclarationView source
toNotificationCenterInputts
export declare function toNotificationCenterInput(items: readonly NotificationHostItem<unknown>[] | undefined, defaultItems: readonly NotificationHostItem<unknown>[] | undefined, title: string | undefined): NotificationCenterInput;
Name
Kind
Type
Requirement
items
parameter
readonly NotificationHostItem<unknown>[] | undefined
required
defaultItems
parameter
readonly NotificationHostItem<unknown>[] | undefined
required
title
parameter
string | undefined
required
return
return value
NotificationCenterInput
n/a
Name
items
Kind
parameter
Type
readonly NotificationHostItem<unknown>[] | undefined
Requirement
required
Name
defaultItems
Kind
parameter
Type
readonly NotificationHostItem<unknown>[] | undefined
Requirement
required
Name
title
Kind
parameter
Type
string | undefined
Requirement
required
Name
return
Kind
return value
Type
NotificationCenterInput
Requirement
n/a

@grassroot/ui-headless-svelte/notification-center

Svelte adapter

25 exports
View source packages/ui-headless/svelte/src/notification-center/index.ts

createNotificationCenter

function
DeclarationView source
createNotificationCenterts
export declare function createNotificationCenter(inputGetter: () => NotificationCenterInput, options?: UseNotificationCenterOptions): UseNotificationCenterResult;
Name
Kind
Type
Requirement
inputGetter
parameter
() => NotificationCenterInput
required
options
parameter
UseNotificationCenterOptions
optional
return
return value
UseNotificationCenterResult
n/a
Name
inputGetter
Kind
parameter
Type
() => NotificationCenterInput
Requirement
required
Name
options
Kind
parameter
Type
UseNotificationCenterOptions
Requirement
optional
Name
return
Kind
return value
Type
UseNotificationCenterResult
Requirement
n/a

NotificationCenterBadge

value
DeclarationView source
NotificationCenterBadgets
export declare const NotificationCenterBadge: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterBody

value
DeclarationView source
NotificationCenterBodyts
export declare const NotificationCenterBody: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterContextValue

interface
DeclarationView source
NotificationCenterContextValuets
export interface NotificationCenterContextValue {
    readonly service: NotificationCenterService;
    readonly connector: NotificationCenterApi;
    readonly scope: PartScope;
    readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
version
property
() => number
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

NotificationCenterDismiss

value
DeclarationView source
NotificationCenterDismissts
export declare const NotificationCenterDismiss: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterEmpty

value
DeclarationView source
NotificationCenterEmptyts
export declare const NotificationCenterEmpty: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterGroup

value
DeclarationView source
NotificationCenterGroupts
export declare const NotificationCenterGroup: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterGroupList

value
DeclarationView source
NotificationCenterGroupListts
export declare const NotificationCenterGroupList: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterGroupName

value
DeclarationView source
NotificationCenterGroupNamets
export declare const NotificationCenterGroupName: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterHeader

value
DeclarationView source
NotificationCenterHeaderts
export declare const NotificationCenterHeader: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterIcon

value
DeclarationView source
NotificationCenterIconts
export declare const NotificationCenterIcon: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

NotificationCenterList

value
DeclarationView source
NotificationCenterListts
export declare const NotificationCenterList: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterMarkAll

value
DeclarationView source
NotificationCenterMarkAllts
export declare const NotificationCenterMarkAll: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterMessage

value
DeclarationView source
NotificationCenterMessagets
export declare const NotificationCenterMessage: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterOpen

value
DeclarationView source
NotificationCenterOpents
export declare const NotificationCenterOpen: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterRoot

value
DeclarationView source
NotificationCenterRootts
export declare const NotificationCenterRoot: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterRow

value
DeclarationView source
NotificationCenterRowts
export declare const NotificationCenterRow: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterTime

value
DeclarationView source
NotificationCenterTimets
export declare const NotificationCenterTime: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterTitle

value
DeclarationView source
NotificationCenterTitlets
export declare const NotificationCenterTitle: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationCenterUnreadDot

value
DeclarationView source
NotificationCenterUnreadDotts
export declare const NotificationCenterUnreadDot: LegacyComponentType;
Name
Kind
Type
Requirement
args
parameter
Parameters<Component<Record<string, any>>>
optional
return
return value
ReturnType<Component<Record<string, any>, Record<string, any>>>
n/a
Name
args
Kind
parameter
Type
Parameters<Component<Record<string, any>>>
Requirement
optional
Name
return
Kind
return value
Type
ReturnType<Component<Record<string, any>, Record<string, any>>>
Requirement
n/a

NotificationHostItem

interface
DeclarationView source
NotificationHostItemts
interface NotificationHostItem<TContent = unknown> {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly message: TContent;
  readonly time: string;
  readonly unread?: boolean;
}
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
message
property
TContent
required
time
property
string
required
unread
property
boolean
optional
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
message
Kind
property
Type
TContent
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
optional

useNotificationCenterContext

function
DeclarationView source
useNotificationCenterContextts
export declare function useNotificationCenterContext(partName: string): NotificationCenterContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
NotificationCenterContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
NotificationCenterContextValue
Requirement
n/a

UseNotificationCenterOptions

interface
DeclarationView source
UseNotificationCenterOptionsts
export interface UseNotificationCenterOptions<TContent = unknown> {
    readonly hostItems?: readonly NotificationHostItem<TContent>[];
    readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<TContent>) => void;
    readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
hostItems
property
readonly NotificationHostItem<TContent>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
optional
onOpen
property
(id: string) => void
optional
Name
hostItems
Kind
property
Type
readonly NotificationHostItem<TContent>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional

UseNotificationCenterResult

interface
DeclarationView source
UseNotificationCenterResultts
export interface UseNotificationCenterResult {
    readonly service: NotificationCenterService;
    readonly connector: NotificationCenterApi;
    readonly scope: PartScope;
    readonly version: () => number;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
version
property
() => number
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
version
Kind
property
Type
() => number
Requirement
required

@grassroot/ui-headless-solid/notification-center

Solid adapter

27 exports
View source packages/ui-headless/solid/src/notification-center/index.ts

NotificationCenterBadge

value
DeclarationView source
NotificationCenterBadgets
export declare const NotificationCenterBadge: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterBody

value
DeclarationView source
NotificationCenterBodyts
export declare const NotificationCenterBody: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterContext

value
DeclarationView source
NotificationCenterContextts
export declare const NotificationCenterContext: import("solid-js").Context<NotificationCenterContextValue | undefined>;

NotificationCenterContextValue

interface
DeclarationView source
NotificationCenterContextValuets
export interface NotificationCenterContextValue {
    readonly service: NotificationCenterService;
    readonly connector: NotificationCenterApi;
    readonly scope: PartScope;
    readonly snapshot: Accessor<NotificationCenterSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
snapshot
property
Accessor<NotificationCenterSnapshot>
required
Name
connector
Kind
property
Type
NotificationCenterApi
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<NotificationCenterSnapshot>
Requirement
required

NotificationCenterDismiss

value
DeclarationView source
NotificationCenterDismissts
export declare const NotificationCenterDismiss: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterEmpty

value
DeclarationView source
NotificationCenterEmptyts
export declare const NotificationCenterEmpty: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterGroup

function
DeclarationView source
NotificationCenterGroupts
export declare function NotificationCenterGroup(props: JSX.HTMLAttributes<HTMLLIElement> & {
    readonly as?: AsProp;
    readonly name: string;
}): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLLIElement> & { readonly as?: AsProp; readonly name: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLLIElement> & { readonly as?: AsProp; readonly name: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterGroupList

function
DeclarationView source
NotificationCenterGroupListts
export declare function NotificationCenterGroupList(props: JSX.HTMLAttributes<HTMLUListElement> & {
    readonly as?: AsProp;
    readonly name: string;
}): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLUListElement> & { readonly as?: AsProp; readonly name: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLUListElement> & { readonly as?: AsProp; readonly name: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterGroupName

function
DeclarationView source
NotificationCenterGroupNamets
export declare function NotificationCenterGroupName(props: JSX.HTMLAttributes<HTMLDivElement> & {
    readonly as?: AsProp;
    readonly name: string;
}): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLDivElement> & { readonly as?: AsProp; readonly name: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLDivElement> & { readonly as?: AsProp; readonly name: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterHeader

value
DeclarationView source
NotificationCenterHeaderts
export declare const NotificationCenterHeader: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterIcon

value
DeclarationView source
NotificationCenterIconts
export declare const NotificationCenterIcon: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterItemsChangeDetail

interface
DeclarationView source
NotificationCenterItemsChangeDetailts
interface NotificationCenterItemsChangeDetail<TContent = unknown> {
  readonly items: NotificationHostItem<TContent>[];
  readonly action: NotificationAction;
  readonly reason: NotificationCenterCommand["reason"];
}
Name
Kind
Type
Requirement
action
property
NotificationAction
required
items
property
NotificationHostItem<TContent>[]
required
reason
property
NotificationCenterCommand["reason"]
required
Name
action
Kind
property
Type
NotificationAction
Requirement
required
Name
items
Kind
property
Type
NotificationHostItem<TContent>[]
Requirement
required
Name
reason
Kind
property
Type
NotificationCenterCommand["reason"]
Requirement
required

NotificationCenterList

value
DeclarationView source
NotificationCenterListts
export declare const NotificationCenterList: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterMarkAll

value
DeclarationView source
NotificationCenterMarkAllts
export declare const NotificationCenterMarkAll: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterMessage

value
DeclarationView source
NotificationCenterMessagets
export declare const NotificationCenterMessage: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterOpen

value
DeclarationView source
NotificationCenterOpents
export declare const NotificationCenterOpen: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterRoot

function
DeclarationView source
NotificationCenterRootts
export declare function NotificationCenterRoot(props: NotificationCenterRootProps): JSX.Element;
Name
Kind
Type
Requirement
props
parameter
NotificationCenterRootProps
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
NotificationCenterRootProps
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterRootProps

interface
DeclarationView source
NotificationCenterRootPropsts
export interface NotificationCenterRootProps extends Omit<JSX.HTMLAttributes<HTMLDivElement>, "onChange"> {
    readonly as?: AsProp;
    readonly items?: readonly NotificationHostItem<JSX.Element>[];
    readonly defaultItems?: readonly NotificationHostItem<JSX.Element>[];
    readonly title?: string;
    readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<JSX.Element>) => void;
    readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
as
property
AsProp
optional
defaultItems
property
readonly NotificationHostItem<JSX.Element>[]
optional
items
property
readonly NotificationHostItem<JSX.Element>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<JSX.Element>) => void
optional
onOpen
property
(id: string) => void
optional
title
property
string
optional
Name
as
Kind
property
Type
AsProp
Requirement
optional
Name
defaultItems
Kind
property
Type
readonly NotificationHostItem<JSX.Element>[]
Requirement
optional
Name
items
Kind
property
Type
readonly NotificationHostItem<JSX.Element>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<JSX.Element>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional
Name
title
Kind
property
Type
string
Requirement
optional

NotificationCenterRow

value
DeclarationView source
NotificationCenterRowts
export declare const NotificationCenterRow: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterTime

value
DeclarationView source
NotificationCenterTimets
export declare const NotificationCenterTime: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterTitle

value
DeclarationView source
NotificationCenterTitlets
export declare const NotificationCenterTitle: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationCenterUnreadDot

value
DeclarationView source
NotificationCenterUnreadDotts
export declare const NotificationCenterUnreadDot: (props: JSX.HTMLAttributes<HTMLElement> & {
    readonly as?: AsProp;
    readonly id: string;
}) => JSX.Element;
Name
Kind
Type
Requirement
props
parameter
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
required
return
return value
JSX.Element
n/a
Name
props
Kind
parameter
Type
JSX.HTMLAttributes<HTMLElement> & { readonly as?: AsProp; readonly id: string; }
Requirement
required
Name
return
Kind
return value
Type
JSX.Element
Requirement
n/a

NotificationHostItem

interface
DeclarationView source
NotificationHostItemts
interface NotificationHostItem<TContent = unknown> {
  readonly id: string;
  readonly group: string;
  readonly kind: NotificationKind;
  readonly message: TContent;
  readonly time: string;
  readonly unread?: boolean;
}
Name
Kind
Type
Requirement
group
property
string
required
id
property
string
required
kind
property
NotificationKind
required
message
property
TContent
required
time
property
string
required
unread
property
boolean
optional
Name
group
Kind
property
Type
string
Requirement
required
Name
id
Kind
property
Type
string
Requirement
required
Name
kind
Kind
property
Type
NotificationKind
Requirement
required
Name
message
Kind
property
Type
TContent
Requirement
required
Name
time
Kind
property
Type
string
Requirement
required
Name
unread
Kind
property
Type
boolean
Requirement
optional

useNotificationCenter

function
DeclarationView source
useNotificationCenterts
export declare function useNotificationCenter<TContent = unknown>(input: Accessor<NotificationCenterInput>, options?: Accessor<UseNotificationCenterOptions<TContent>> | UseNotificationCenterOptions<TContent>): UseNotificationCenterResult<TContent>;
Name
Kind
Type
Requirement
input
parameter
Accessor<NotificationCenterInput>
required
options
parameter
Accessor<UseNotificationCenterOptions<TContent>> | UseNotificationCenterOptions<TContent>
optional
return
return value
UseNotificationCenterResult<TContent>
n/a
Name
input
Kind
parameter
Type
Accessor<NotificationCenterInput>
Requirement
required
Name
options
Kind
parameter
Type
Accessor<UseNotificationCenterOptions<TContent>> | UseNotificationCenterOptions<TContent>
Requirement
optional
Name
return
Kind
return value
Type
UseNotificationCenterResult<TContent>
Requirement
n/a

useNotificationCenterContext

function
DeclarationView source
useNotificationCenterContextts
export declare function useNotificationCenterContext(partName: string): NotificationCenterContextValue;
Name
Kind
Type
Requirement
partName
parameter
string
required
return
return value
NotificationCenterContextValue
n/a
Name
partName
Kind
parameter
Type
string
Requirement
required
Name
return
Kind
return value
Type
NotificationCenterContextValue
Requirement
n/a

UseNotificationCenterOptions

interface
DeclarationView source
UseNotificationCenterOptionsts
export interface UseNotificationCenterOptions<TContent = unknown> {
    readonly hostItems?: readonly NotificationHostItem<TContent>[];
    readonly onItemsChange?: (detail: NotificationCenterItemsChangeDetail<TContent>) => void;
    readonly onOpen?: (id: string) => void;
}
Name
Kind
Type
Requirement
hostItems
property
readonly NotificationHostItem<TContent>[]
optional
onItemsChange
property
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
optional
onOpen
property
(id: string) => void
optional
Name
hostItems
Kind
property
Type
readonly NotificationHostItem<TContent>[]
Requirement
optional
Name
onItemsChange
Kind
property
Type
(detail: NotificationCenterItemsChangeDetail<TContent>) => void
Requirement
optional
Name
onOpen
Kind
property
Type
(id: string) => void
Requirement
optional

UseNotificationCenterResult

interface
DeclarationView source
UseNotificationCenterResultts
export interface UseNotificationCenterResult<TContent = unknown> {
    readonly service: NotificationCenterService;
    readonly connector: NotificationCenterApi<TContent>;
    readonly scope: PartScope;
    readonly snapshot: Accessor<NotificationCenterSnapshot>;
}
Name
Kind
Type
Requirement
connector
property
NotificationCenterApi<TContent>
required
scope
property
PartScope
required
service
property
NotificationCenterService
required
snapshot
property
Accessor<NotificationCenterSnapshot>
required
Name
connector
Kind
property
Type
NotificationCenterApi<TContent>
Requirement
required
Name
scope
Kind
property
Type
PartScope
Requirement
required
Name
service
Kind
property
Type
NotificationCenterService
Requirement
required
Name
snapshot
Kind
property
Type
Accessor<NotificationCenterSnapshot>
Requirement
required