Getting Started
UI
Components
- Accordion
- Alert
- Alert Dialog
- Aspect Ratio
- Autocomplete
- Avatar
- Badge
- Breadcrumb
- Button
- Button Group
- Calendar
- Card
- Carousel
- Checkbox
- Collapsible
- Combobox
- Command
- Context Menu
- Data Table
- Date Picker
- Dialog
- Dropdown Menu
- Empty
- Field
- Form Field
- Hover Card
- Icon
- Input Group
- Input OTP
- Input
- Item
- Kbd
- Label
- Menubar
- Native Select
- Navigation Menu
- Pagination
- Popover
- Progress
- Radio Group
- Resizable
- Scroll Area
- Select
- Separator
- Sheet
- Sidebar
- Skeleton
- Slider
- Sonner (Toast)
- Spinner
- Switch
- Table
- Tabs
- Textarea
- Toggle
- Toggle Group
- Tooltip
Forms
Stack
Sonner
An opinionated toast component for Angular.
import { Component } from '@angular/core';
import { toast } from '@spartan-ng/brain/sonner';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmToasterImports } from '@spartan-ng/helm/sonner';
@Component({
selector: 'spartan-sonner-preview',
imports: [HlmToasterImports, HlmButtonImports],
template: `
<hlm-toaster />
<button hlmBtn variant="outline" (click)="showToast()">Show Toast</button>
`,
})
export class SonnerPreview {
showToast() {
toast('Event has been created', {
description: 'Sunday, December 03, 2023 at 9:00 AM',
action: {
label: 'Undo',
onClick: () => console.log('Undo'),
},
});
}
}Installation
ng g @spartan-ng/cli:ui sonnernx g @spartan-ng/cli:ui sonnerimport { DestroyRef, ElementRef, HostAttributeToken, Injector, PLATFORM_ID, effect, inject, runInInjectionContext } from '@angular/core';
import { clsx, type ClassValue } from 'clsx';
import { isPlatformBrowser } from '@angular/common';
import { twMerge } from 'tailwind-merge';
export function hlm(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
// Global map to track class managers per element
const elementClassManagers = new WeakMap<HTMLElement, ElementClassManager>();
// Global mutation observer for all elements
let globalObserver: MutationObserver | null = null;
const observedElements = new Set<HTMLElement>();
interface ElementClassManager {
element: HTMLElement;
sources: Map<number, { classes: Set<string>; order: number }>;
baseClasses: Set<string>;
isUpdating: boolean;
nextOrder: number;
hasInitialized: boolean;
restoreRafId: number | null;
/** Transitions are suppressed until the first effect writes correct classes */
transitionsSuppressed: boolean;
/** Original inline transition value to restore after suppression (empty string = none was set) */
previousTransition: string;
/** Original inline transition priority to preserve !important when restoring */
previousTransitionPriority: string;
}
let sourceCounter = 0;
/**
* This function dynamically adds and removes classes for a given element without requiring
* the a class binding (e.g. `[class]="..."`) which may interfere with other class bindings.
*
* 1. This will merge the existing classes on the element with the new classes.
* 2. It will also remove any classes that were previously added by this function but are no longer present in the new classes.
* 3. Multiple calls to this function on the same element will be merged efficiently.
*/
export function classes(computed: () => ClassValue[] | string, options: ClassesOptions = {}) {
runInInjectionContext(options.injector ?? inject(Injector), () => {
const elementRef = options.elementRef ?? inject(ElementRef);
const platformId = inject(PLATFORM_ID);
const destroyRef = inject(DestroyRef);
const baseClasses = inject(new HostAttributeToken('class'), { optional: true });
const element = elementRef.nativeElement;
// Create unique identifier for this source
const sourceId = sourceCounter++;
// Get or create the class manager for this element
let manager = elementClassManagers.get(element);
if (!manager) {
// Initialize base classes from variation (host attribute 'class')
const initialBaseClasses = new Set<string>();
if (baseClasses) {
toClassList(baseClasses).forEach((cls) => initialBaseClasses.add(cls));
}
manager = {
element,
sources: new Map(),
baseClasses: initialBaseClasses,
isUpdating: false,
nextOrder: 0,
hasInitialized: false,
restoreRafId: null,
transitionsSuppressed: false,
previousTransition: '',
previousTransitionPriority: '',
};
elementClassManagers.set(element, manager);
// Setup global observer if needed and register this element
setupGlobalObserver(platformId);
observedElements.add(element);
// Suppress transitions until the first effect writes correct classes and
// the browser has painted them. This prevents CSS transition animations
// during hydration when classes change from SSR state to client state.
if (isPlatformBrowser(platformId)) {
manager.previousTransition = element.style.getPropertyValue('transition');
manager.previousTransitionPriority = element.style.getPropertyPriority('transition');
element.style.setProperty('transition', 'none', 'important');
manager.transitionsSuppressed = true;
}
}
// Assign order once at registration time
const sourceOrder = manager.nextOrder++;
function updateClasses(): void {
// Get the new classes from the computed function
const newClasses = toClassList(computed());
// Update this source's classes, keeping the original order
manager!.sources.set(sourceId, {
classes: new Set(newClasses),
order: sourceOrder,
});
// Update the element
updateElement(manager!);
// Re-enable transitions after the first effect writes correct classes.
// Deferred to next animation frame so the browser paints the class change
// with transitions disabled first, then re-enables them.
if (manager!.transitionsSuppressed) {
manager!.transitionsSuppressed = false;
manager!.restoreRafId = requestAnimationFrame(() => {
manager!.restoreRafId = null;
restoreTransitionSuppression(manager!);
});
}
}
// Register cleanup with DestroyRef
destroyRef.onDestroy(() => {
if (manager!.restoreRafId !== null) {
cancelAnimationFrame(manager!.restoreRafId);
manager!.restoreRafId = null;
}
if (manager!.transitionsSuppressed) {
manager!.transitionsSuppressed = false;
restoreTransitionSuppression(manager!);
}
// Remove this source from the manager
manager!.sources.delete(sourceId);
// If no more sources, clean up the manager
if (manager!.sources.size === 0) {
cleanupManager(element);
} else {
// Update element without this source's classes
updateElement(manager!);
}
});
/**
* We need this effect to track changes to the computed classes. Ideally, we would use
* afterRenderEffect here, but that doesn't run in SSR contexts, so we use a standard
* effect which works in both browser and SSR.
*/
effect(updateClasses);
});
}
function restoreTransitionSuppression(manager: ElementClassManager): void {
const prev = manager.previousTransition;
if (prev) {
manager.element.style.setProperty('transition', prev, manager.previousTransitionPriority || undefined);
} else {
manager.element.style.removeProperty('transition');
}
}
// eslint-disable-next-line @typescript-eslint/no-wrapper-object-types
function setupGlobalObserver(platformId: Object): void {
if (isPlatformBrowser(platformId) && !globalObserver) {
// Create single global observer that watches the entire document
globalObserver = new MutationObserver((mutations) => {
for (const mutation of mutations) {
if (mutation.type === 'attributes' && mutation.attributeName === 'class') {
const element = mutation.target as HTMLElement;
const manager = elementClassManagers.get(element);
// Only process elements we're managing
if (manager && observedElements.has(element)) {
if (manager.isUpdating) continue; // Ignore changes we're making
// Update base classes to include any externally added classes
const currentClasses = toClassList(element.className);
const allSourceClasses = new Set<string>();
// Collect all classes from all sources
for (const source of manager.sources.values()) {
for (const className of source.classes) {
allSourceClasses.add(className);
}
}
// Any classes not from sources become new base classes
manager.baseClasses.clear();
for (const className of currentClasses) {
if (!allSourceClasses.has(className)) {
manager.baseClasses.add(className);
}
}
updateElement(manager);
}
}
}
});
// Start observing the entire document for class attribute changes
globalObserver.observe(document, {
attributes: true,
attributeFilter: ['class'],
subtree: true, // Watch all descendants
});
}
}
function updateElement(manager: ElementClassManager): void {
if (manager.isUpdating) return; // Prevent recursive updates
manager.isUpdating = true;
// Handle initialization: capture base classes after first source registration
if (!manager.hasInitialized && manager.sources.size > 0) {
// Get current classes on element (may include SSR classes)
const currentClasses = toClassList(manager.element.className);
// Get all classes that will be applied by sources
const allSourceClasses = new Set<string>();
for (const source of manager.sources.values()) {
source.classes.forEach((className) => allSourceClasses.add(className));
}
// Only consider classes as "base" if they're not produced by any source
// This prevents SSR-rendered classes from being preserved as base classes
currentClasses.forEach((className) => {
if (!allSourceClasses.has(className)) {
manager.baseClasses.add(className);
}
});
manager.hasInitialized = true;
}
// Get classes from all sources, sorted by registration order (later takes precedence)
const sortedSources = Array.from(manager.sources.entries()).sort(([, a], [, b]) => a.order - b.order);
const allSourceClasses: string[] = [];
for (const [, source] of sortedSources) {
allSourceClasses.push(...source.classes);
}
// Combine base classes with all source classes, ensuring base classes take precedence
const classesToApply =
allSourceClasses.length > 0 || manager.baseClasses.size > 0
? hlm([...allSourceClasses, ...manager.baseClasses])
: '';
// Apply the classes to the element
if (manager.element.className !== classesToApply) {
manager.element.className = classesToApply;
}
manager.isUpdating = false;
}
function cleanupManager(element: HTMLElement): void {
// Remove from global tracking
observedElements.delete(element);
elementClassManagers.delete(element);
// If no more elements being tracked, cleanup global observer
if (observedElements.size === 0 && globalObserver) {
globalObserver.disconnect();
globalObserver = null;
}
}
interface ClassesOptions {
elementRef?: ElementRef<HTMLElement>;
injector?: Injector;
}
// Cache for parsed class lists to avoid repeated string operations
const classListCache = new Map<string, string[]>();
function toClassList(className: string | ClassValue[]): string[] {
// For simple string inputs, use cache to avoid repeated parsing
if (typeof className === 'string' && classListCache.has(className)) {
return classListCache.get(className)!;
}
const result = clsx(className)
.split(' ')
.filter((c) => c.length > 0);
// Cache string results, but limit cache size to prevent memory growth
if (typeof className === 'string' && classListCache.size < 1000) {
classListCache.set(className, result);
}
return result;
}import type, { BooleanInput, NumberInput } from '@angular/cdk/coercion';
import type, { ClassValue } from 'clsx';
import { BrnSonnerImports, type ToasterProps } from '@spartan-ng/brain/sonner';
import { ChangeDetectionStrategy, Component, booleanAttribute, computed, input, numberAttribute } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { hlm } from '@spartan-ng/helm/utils';
import { lucideCircleCheck, lucideInfo, lucideLoader2, lucideOctagonX, lucideTriangleAlert } from '@ng-icons/lucide';
@Component({
selector: 'hlm-toaster',
imports: [BrnSonnerImports, NgIcon],
providers: [provideIcons({ lucideCircleCheck, lucideInfo, lucideTriangleAlert, lucideOctagonX, lucideLoader2 })],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
<brn-sonner-toaster
[class]="_computedClass()"
[invert]="invert()"
[theme]="theme()"
[position]="position()"
[hotKey]="hotKey()"
[richColors]="richColors()"
[expand]="expand()"
[duration]="duration()"
[visibleToasts]="visibleToasts()"
[closeButton]="closeButton()"
[toastOptions]="toastOptions()"
[offset]="offset()"
[style]="userStyle()"
>
<ng-template #loadingIcon>
<ng-icon name="lucideLoader2" class="overflow-visible! text-base [&>svg]:motion-safe:animate-spin" />
</ng-template>
<ng-template #successIcon>
<ng-icon name="lucideCircleCheck" class="overflow-visible! text-base" />
</ng-template>
<ng-template #errorIcon>
<ng-icon name="lucideOctagonX" class="overflow-visible! text-base" />
</ng-template>
<ng-template #infoIcon>
<ng-icon name="lucideInfo" class="overflow-visible! text-base" />
</ng-template>
<ng-template #warningIcon>
<ng-icon name="lucideTriangleAlert" class="overflow-visible! text-base" />
</ng-template>
</brn-sonner-toaster>
`,
})
export class HlmToaster {
public readonly invert = input<ToasterProps['invert'], BooleanInput>(false, {
transform: booleanAttribute,
});
public readonly theme = input<ToasterProps['theme']>('light');
public readonly position = input<ToasterProps['position']>('bottom-right');
public readonly hotKey = input<ToasterProps['hotkey']>(['altKey', 'KeyT']);
public readonly richColors = input<ToasterProps['richColors'], BooleanInput>(false, {
transform: booleanAttribute,
});
public readonly expand = input<ToasterProps['expand'], BooleanInput>(false, {
transform: booleanAttribute,
});
public readonly duration = input<ToasterProps['duration'], NumberInput>(4000, {
transform: numberAttribute,
});
public readonly visibleToasts = input<ToasterProps['visibleToasts'], NumberInput>(3, {
transform: numberAttribute,
});
public readonly closeButton = input<ToasterProps['closeButton'], BooleanInput>(false, {
transform: booleanAttribute,
});
public readonly toastOptions = input<ToasterProps['toastOptions']>({});
public readonly offset = input<ToasterProps['offset']>(null);
public readonly userClass = input<ClassValue>('', { alias: 'class' });
public readonly userStyle = input<Record<string, string>>(
{
'--normal-bg': 'var(--popover)',
'--normal-text': 'var(--popover-foreground)',
'--normal-border': 'var(--border)',
'--border-radius': 'var(--radius)',
},
{ alias: 'style' },
);
protected readonly _computedClass = computed(() => hlm('toaster group', this.userClass()));
}
export const HlmToasterImports = [HlmToaster] as const; Add the HlmToaster component to your root component.
src/app/app.ts
import { Component } from '@angular/core';
import { RouterOutlet } from '@angular/router';
import { HlmToasterImports } from '@spartan-ng/helm/sonner';
@Component({
selector: 'app-root',
imports: [RouterOutlet, HlmToasterImports],
template: `
<router-outlet />
<hlm-toaster />
`,
})
export class App {}Usage
import { toast } from '@spartan-ng/brain/sonner';toast('Event has been created.');Examples
Types
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { toast } from '@spartan-ng/brain/sonner';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-sonner-types-example',
imports: [HlmButtonImports],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
<div class="flex flex-wrap justify-center gap-2">
<button hlmBtn variant="outline" (click)="showToast()">Default</button>
<button hlmBtn variant="outline" (click)="showSuccess()">Success</button>
<button hlmBtn variant="outline" (click)="showInfo()">Info</button>
<button hlmBtn variant="outline" (click)="showError()">Error</button>
<button hlmBtn variant="outline" (click)="showWarning()">Warning</button>
<button hlmBtn variant="outline" (click)="showPromise()">Promise</button>
</div>
`,
})
export class SonnerTypesExample {
showToast() {
toast('Event has been created');
}
showSuccess() {
toast.success('Event has been created');
}
showError() {
toast.error('Failed to create event');
}
showWarning() {
toast.warning('Event is missing a name');
}
showInfo() {
toast.info('Event will start in 10 minutes');
}
showPromise() {
toast.promise<{ name: string }>(
() => new Promise((resolve) => setTimeout(() => resolve({ name: 'Angular Connect' }), 2000)),
{
loading: 'Loading...',
success: (data) => `${data.name} has been created`,
error: 'Error',
},
);
}
}Description
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { toast } from '@spartan-ng/brain/sonner';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-sonner-description-example',
imports: [HlmButtonImports],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
<button hlmBtn variant="outline" (click)="showToast()">Show Toast</button>
`,
})
export class SonnerDescriptionExample {
showToast() {
toast('Event has been created', {
description: 'Monday, January 3rd at 6:00pm',
});
}
}Position
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { toast } from '@spartan-ng/brain/sonner';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-sonner-position-example',
imports: [HlmButtonImports],
changeDetection: ChangeDetectionStrategy.OnPush,
template: `
<div class="flex flex-wrap justify-center gap-2">
<button hlmBtn variant="outline" (click)="showTopLeft()">Top Left</button>
<button hlmBtn variant="outline" (click)="showTopCenter()">Top Center</button>
<button hlmBtn variant="outline" (click)="showTopRight()">Top Right</button>
<button hlmBtn variant="outline" (click)="showBottomLeft()">Bottom Left</button>
<button hlmBtn variant="outline" (click)="showBottomCenter()">Bottom Center</button>
<button hlmBtn variant="outline" (click)="showBottomRight()">Bottom Right</button>
</div>
`,
})
export class SonnerPositionExample {
showTopLeft() {
toast('Event has been created', {
position: 'top-left',
});
}
showTopCenter() {
toast('Event has been created', {
position: 'top-center',
});
}
showTopRight() {
toast('Event has been created', {
position: 'top-right',
});
}
showBottomLeft() {
toast('Event has been created', {
position: 'bottom-left',
});
}
showBottomCenter() {
toast('Event has been created', {
position: 'bottom-center',
});
}
showBottomRight() {
toast('Event has been created', {
position: 'bottom-right',
});
}
}Brain API
BrnSonnerIcon
Selector: brn-sonner-icon
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| type | ToastTypes | default | - |
BrnSonnerLoader
Selector: brn-sonner-loader
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| isVisible* (required) | boolean | - | - |
BrnSonnerToast
Selector: brn-sonner-toast
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| toast* (required) | ToastProps['toast'] | - | - |
| index* (required) | ToastProps['index'] | - | - |
| expanded* (required) | ToastProps['expanded'] | - | - |
| invert* (required) | ToastProps['invert'] | - | - |
| position* (required) | ToastProps['position'] | - | - |
| visibleToasts* (required) | ToastProps['visibleToasts'] | - | - |
| expandByDefault* (required) | ToastProps['expandByDefault'] | - | - |
| closeButton* (required) | ToastProps['closeButton'] | - | - |
| interacting* (required) | ToastProps['interacting'] | - | - |
| cancelButtonStyle | ToastProps['cancelButtonStyle'] | - | - |
| actionButtonStyle | ToastProps['actionButtonStyle'] | - | - |
| duration | ToastProps['duration'] | this._config.toastLifetime | - |
| descriptionClass | ToastProps['descriptionClass'] | - | - |
| classes | ToastProps['classes'] | {} | - |
| unstyled | ToastProps['unstyled'] | false | - |
| class | unknown | - | - |
| style | Record<string, string> | {} | - |
BrnSonnerToaster
Selector: brn-sonner-toaster
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| invert | ToasterProps['invert'] | false | - |
| theme | ToasterProps['theme'] | light | - |
| position | ToasterProps['position'] | bottom-right | - |
| hotKey | ToasterProps['hotkey'] | [altKey, KeyT] | - |
| richColors | ToasterProps['richColors'] | false | - |
| expand | ToasterProps['expand'] | false | - |
| duration | ToasterProps['duration'] | this._config.toastLifetime | - |
| visibleToasts | ToasterProps['visibleToasts'] | this._config.visibleToastsAmount | - |
| closeButton | ToasterProps['closeButton'] | false | - |
| toastOptions | ToasterProps['toastOptions'] | {} | - |
| offset | ToasterProps['offset'] | null | - |
| class | unknown | - | - |
| style | Record<string, string> | {} | - |
Helm API
HlmToaster
Selector: hlm-toaster
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| invert | ToasterProps['invert'] | false | - |
| theme | ToasterProps['theme'] | light | - |
| position | ToasterProps['position'] | bottom-right | - |
| hotKey | ToasterProps['hotkey'] | [altKey, KeyT] | - |
| richColors | ToasterProps['richColors'] | false | - |
| expand | ToasterProps['expand'] | false | - |
| duration | ToasterProps['duration'] | 4000 | - |
| visibleToasts | ToasterProps['visibleToasts'] | 3 | - |
| closeButton | ToasterProps['closeButton'] | false | - |
| toastOptions | ToasterProps['toastOptions'] | {} | - |
| offset | ToasterProps['offset'] | null | - |
| class | ClassValue | - | - |
| style | Record<string, string> | { --normal-bg: var(--popover), --normal-text: var(--popover-foreground), --normal-border: var(--border), --border-radius: var(--radius), } | - |
On This Page
Stop configuring. Start shipping.
Zerops powers spartan.ng and Angular teams worldwide.
One-command deployment. Zero infrastructure headaches.
Deploy with Zerops