Popover

Displays rich content in a portal, triggered by a button.

import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmInputImports } from '@spartan-ng/helm/input';
import { HlmLabelImports } from '@spartan-ng/helm/label';
import { HlmPopoverImports } from '@spartan-ng/helm/popover';

@Component({
	selector: 'spartan-popover-preview',
	imports: [HlmPopoverImports, HlmButtonImports, HlmLabelImports, HlmInputImports],
	template: `
		<hlm-popover sideOffset="5">
			<button hlmPopoverTrigger hlmBtn variant="outline">Open Popover</button>
			<hlm-popover-content class="grid w-80 gap-4" *hlmPopoverPortal="let ctx">
				<div class="space-y-2">
					<h4 class="leading-none font-medium">Dimensions</h4>
					<p class="text-muted-foreground text-sm">Set the dimensions for the layer.</p>
				</div>
				<div class="grid gap-2">
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="width">Width</label>
						<input hlmInput id="width" [defaultValue]="'100%'" class="col-span-2 h-8" />
					</div>
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="maxWidth">Max. width</label>
						<input hlmInput id="maxWidth" [defaultValue]="'300px'" class="col-span-2 h-8" />
					</div>
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="height">Height</label>
						<input hlmInput id="height" [defaultValue]="'25px'" class="col-span-2 h-8" />
					</div>
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="maxHeight">Max. height</label>
						<input hlmInput id="maxHeight" [defaultValue]="'none'" class="col-span-2 h-8" />
					</div>
				</div>
			</hlm-popover-content>
		</hlm-popover>
	`,
})
export class PopoverPreview {}

Installation

ng g @spartan-ng/cli:ui popover

nx g @spartan-ng/cli:ui popover

import { DestroyRef, ElementRef, HostAttributeToken, Injector, PLATFORM_ID, effect, inject, makeEnvironmentProviders, runInInjectionContext, type EnvironmentProviders } from '@angular/core';
import { OVERLAY_DEFAULT_CONFIG } from '@angular/cdk/overlay';
import { clsx, type ClassValue } from 'clsx';
import { isPlatformBrowser } from '@angular/common';
import { provideSpartanHlm } from '@spartan-ng/helm/utils';
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;
}

/**
 * Provides default configuration for Spartan Helm components.
 *
 * This utility configures the Angular CDK overlay to disable the `usePopover`
 * behavior introduced in Angular 21, which causes CDK overlay-based components
 * (sheets, dialogs, tooltips, etc.) to render above `position: fixed` elements
 * like `<hlm-toaster>`.
 *
 * @returns {EnvironmentProviders} Environment providers to be added to the application config.
 *
 * @example
 * ```ts
 * // app.config.ts
 * 
 *
 * export const appConfig: ApplicationConfig = {
 *   providers: [
 *     provideSpartanHlm(),
 *     // ... other providers
 *   ],
 * };
 * ```
 */
export function provideSpartanHlm(): EnvironmentProviders {
	return makeEnvironmentProviders([
		{
			provide: OVERLAY_DEFAULT_CONFIG,
			useValue: { usePopover: false },
		},
	]);
}

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/10 gap-2.5 rounded-lg p-2.5 text-sm shadow-md ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-0.5 text-sm');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/10 gap-4 rounded-md p-4 text-sm shadow-md ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-1 text-sm');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/10 gap-2.5 rounded-none p-2.5 text-xs shadow-md ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground text-xs/relaxed');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-1 text-xs');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'text-sm font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/5 gap-4 rounded-2xl p-4 text-sm shadow-2xl ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-1 text-sm');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'text-base font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/10 gap-4 rounded-lg p-2.5 text-xs shadow-md ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-1 text-xs');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'text-sm font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

import { BrnPopover, BrnPopoverContent, BrnPopoverTrigger } from '@spartan-ng/brain/popover';
import { Directive, ElementRef, Renderer2, effect, inject, signal } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { injectExposesStateProvider } from '@spartan-ng/brain/core';

@Directive({
	selector: '[hlmPopoverContent],hlm-popover-content',
	host: { 'data-slot': 'popover-content' },
})
export class HlmPopoverContent {
	private readonly _stateProvider = injectExposesStateProvider({ host: true });
	public state = this._stateProvider.state ?? signal('closed');
	private readonly _renderer = inject(Renderer2);
	private readonly _element = inject(ElementRef);

	constructor() {
		effect(() => {
			this._renderer.setAttribute(this._element.nativeElement, 'data-state', this.state());
		});

		classes(() => 'bg-popover text-popover-foreground data-open:animate-in data-closed:animate-out data-closed:fade-out-0 data-open:fade-in-0 data-closed:zoom-out-95 data-open:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-end-2 data-[side=right]:slide-in-from-start-2 data-[side=top]:slide-in-from-bottom-2 ring-foreground/5 dark:ring-foreground/10 gap-4 rounded-3xl p-4 text-sm shadow-lg ring-1 duration-100 relative flex w-72 flex-col outline-none');
	}
}

@Directive({
	selector: '[hlmPopoverDescription]',
	host: { 'data-slot': 'popover-description' },
})
export class HlmPopoverDescription {
	constructor() {
		classes(() => 'text-muted-foreground');
	}
}

@Directive({
	selector: '[hlmPopoverHeader],hlm-popover-header',
	host: { 'data-slot': 'popover-header' },
})
export class HlmPopoverHeader {
	constructor() {
		classes(() => 'flex flex-col gap-1 text-sm');
	}
}

@Directive({
	selector: '[hlmPopoverPortal]',
	hostDirectives: [{ directive: BrnPopoverContent, inputs: ['context', 'class'] }],
})
export class HlmPopoverPortal {}

@Directive({
	selector: '[hlmPopoverTitle]',
	host: { 'data-slot': 'popover-title' },
})
export class HlmPopoverTitle {
	constructor() {
		classes(() => 'text-base font-medium');
	}
}

@Directive({
	selector: 'button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]',
	hostDirectives: [
		{ directive: BrnPopoverTrigger, inputs: ['id', 'brnPopoverTriggerFor: hlmPopoverTriggerFor', 'type'] },
	],
	host: { 'data-slot': 'popover-trigger' },
})
export class HlmPopoverTrigger {}

@Directive({
	selector: '[hlmPopover],hlm-popover',
	hostDirectives: [
		{
			directive: BrnPopover,
			inputs: ['align', 'attachTo', 'autoFocus', 'closeOnOutsidePointerEvents', 'offsetX', 'sideOffset', 'state'],
			outputs: ['stateChanged', 'closed'],
		},
	],
	host: { 'data-slot': 'popover' },
})
export class HlmPopover {}

export const HlmPopoverImports = [
	HlmPopover,
	HlmPopoverContent,
	HlmPopoverDescription,
	HlmPopoverHeader,
	HlmPopoverPortal,
	HlmPopoverTitle,
	HlmPopoverTrigger,
] as const;

Usage

import { HlmPopoverImports } from '@spartan-ng/helm/popover';

<hlm-popover>
  <button hlmPopoverTrigger>Open Popover</button>
  <hlm-popover-content *hlmPopoverPortal="let ctx"></hlm-popover-content>
</hlm-popover>

Examples

Basic

import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmPopoverImports } from '@spartan-ng/helm/popover';

@Component({
	selector: 'spartan-popover-basic',
	imports: [HlmPopoverImports, HlmButtonImports],
	template: `
		<hlm-popover sideOffset="5" align="start">
			<button hlmPopoverTrigger hlmBtn variant="outline">Open Popover</button>
			<hlm-popover-content *hlmPopoverPortal="let ctx">
				<hlm-popover-header>
					<div hlmPopoverTitle>Dimensions</div>
					<p hlmPopoverDescription>Set the dimensions for the layer.</p>
				</hlm-popover-header>
			</hlm-popover-content>
		</hlm-popover>
	`,
})
export class PopoverBasic {}

Align

import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmPopoverImports } from '@spartan-ng/helm/popover';

@Component({
	selector: 'spartan-popover-align',
	imports: [HlmPopoverImports, HlmButtonImports],
	template: `
		<div class="flex gap-6">
			<hlm-popover sideOffset="5" align="start">
				<button hlmPopoverTrigger hlmBtn variant="outline">Start</button>
				<hlm-popover-content class="w-40" *hlmPopoverPortal="let ctx">Aligned to start</hlm-popover-content>
			</hlm-popover>
			<hlm-popover sideOffset="5" align="center">
				<button hlmPopoverTrigger hlmBtn variant="outline">Center</button>
				<hlm-popover-content class="w-40" *hlmPopoverPortal="let ctx">Aligned to center</hlm-popover-content>
			</hlm-popover>
			<hlm-popover sideOffset="5" align="end">
				<button hlmPopoverTrigger hlmBtn variant="outline">End</button>
				<hlm-popover-content class="w-40" *hlmPopoverPortal="let ctx">Aligned to end</hlm-popover-content>
			</hlm-popover>
		</div>
	`,
})
export class PopoverAlign {}

RTL

To enable RTL support in spartan-ng, see the RTL configuration guide.

import { Directionality } from '@angular/cdk/bidi';
import { Component, computed, effect, inject, untracked } from '@angular/core';
import { TranslateService, Translations } from '@spartan-ng/app/app/shared/translate.service';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmInputImports } from '@spartan-ng/helm/input';
import { HlmLabelImports } from '@spartan-ng/helm/label';
import { HlmPopoverImports } from '@spartan-ng/helm/popover';

@Component({
	selector: 'spartan-popover-rtl-preview',
	imports: [HlmPopoverImports, HlmButtonImports, HlmLabelImports, HlmInputImports],
	providers: [Directionality],
	host: {
		class: 'flex w-full justify-center',
		'[dir]': '_dir()',
	},
	template: `
		<hlm-popover sideOffset="5">
			<button hlmPopoverTrigger hlmBtn variant="outline">{{ _t()['open'] }}</button>
			<hlm-popover-content class="grid w-80 gap-4" *hlmPopoverPortal="let ctx">
				<div class="space-y-2">
					<h4 class="leading-none font-medium">{{ _t()['title'] }}</h4>
					<p class="text-muted-foreground text-sm">{{ _t()['description'] }}</p>
				</div>
				<div class="grid gap-2">
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="width">{{ _t()['width'] }}</label>
						<input hlmInput id="width" [defaultValue]="'100%'" class="col-span-2 h-8" />
					</div>
					<div class="grid grid-cols-3 items-center gap-4">
						<label hlmLabel for="height">{{ _t()['height'] }}</label>
						<input hlmInput id="height" [defaultValue]="'25px'" class="col-span-2 h-8" />
					</div>
				</div>
			</hlm-popover-content>
		</hlm-popover>
	`,
})
export class PopoverRtlPreview {
	private readonly _directionality = inject(Directionality);
	private readonly _language = inject(TranslateService).language;

	private readonly _translations: Translations = {
		en: {
			dir: 'ltr',
			values: {
				open: 'Open popover',
				title: 'Dimensions',
				description: 'Set the dimensions for the layer.',
				width: 'Width',
				height: 'Height',
			},
		},
		ar: {
			dir: 'rtl',
			values: {
				open: 'افتح النافذة',
				title: 'الأبعاد',
				description: 'اضبط أبعاد الطبقة.',
				width: 'العرض',
				height: 'الارتفاع',
			},
		},
		he: {
			dir: 'rtl',
			values: {
				open: 'פתח חלון',
				title: 'מידות',
				description: 'הגדר את המידות עבור השכבה.',
				width: 'רוחב',
				height: 'גובה',
			},
		},
	};

	private readonly _translation = computed(() => this._translations[this._language()]);
	protected readonly _t = computed(() => this._translation().values);
	protected readonly _dir = computed(() => this._translation().dir);

	constructor() {
		effect(() => {
			const dir = this._dir();
			untracked(() => this._directionality.valueSignal.set(dir));
		});
	}
}

Brain API

BrnPopoverContent

Selector: [brnPopoverContent]

Inputs

Prop	Type	Default	Description
class	string \| null \| undefined	undefined	-
context	T \| undefined	undefined	-

BrnPopoverTrigger

Selector: button[brnPopoverTrigger],button[brnPopoverTriggerFor]

Inputs

Prop	Type	Default	Description
brnPopoverTriggerFor	BrnPopover \| undefined	undefined	-
id	string	`brn-overlay-trigger-${++triggerIdSequence}`	-
type	'button' \| 'submit' \| 'reset'	'button'	-
brnOverlayTriggerFor	BrnOverlay \| undefined	undefined	-

BrnPopover

Selector: [brnPopover],brn-popover

ExportAs: brnPopover

Inputs

Prop	Type	Default	Description
align	BrnPopoverAlign	this._config.align	-
sideOffset	number	this._config.sideOffset	-
offsetX	number	this._config.offsetX	-
id	string	`brn-overlay-${++overlayIdSequence}`	-
state	BrnOverlayState \| null	null	-
role	BrnOverlayOptions['role']	this._defaultOptions.role	-
hasBackdrop	boolean	this._defaultOptions.hasBackdrop	-
positionStrategy	BrnOverlayOptions['positionStrategy']	this._defaultOptions.positionStrategy	-
scrollStrategy	BrnOverlayOptions['scrollStrategy'] \| 'close' \| 'reposition' \| null	this._defaultOptions.scrollStrategy	-
closeOnOutsidePointerEvents	boolean	this._defaultOptions.closeOnOutsidePointerEvents	-
attachTo	BrnOverlayOptions['attachTo']	this._defaultOptions.attachTo	-
attachPositions	BrnOverlayOptions['attachPositions']	this._defaultOptions.attachPositions	-
disableClose	boolean	this._defaultOptions.disableClose	-
autoFocus	boolean	this._defaultOptions.autoFocus	-

Outputs

Prop	Type	Default	Description
closed	TResult	-	-
stateChanged	BrnOverlayState	-	-

Helm API

HlmPopoverContent

Selector: [hlmPopoverContent],hlm-popover-content

HlmPopoverDescription

Selector: [hlmPopoverDescription]

HlmPopoverHeader

Selector: [hlmPopoverHeader],hlm-popover-header

HlmPopoverPortal

Selector: [hlmPopoverPortal]

Inputs

Prop	Type	Default	Description
context	T \| undefined	undefined	-
class	string \| null \| undefined	undefined	-

HlmPopoverTitle

Selector: [hlmPopoverTitle]

HlmPopoverTrigger

Selector: button[hlmPopoverTrigger],button[hlmPopoverTriggerFor]

Inputs

Prop	Type	Default	Description
id	string	`brn-overlay-trigger-${++triggerIdSequence}`	-
hlmPopoverTriggerFor	BrnPopover \| undefined	undefined	-
type	'button' \| 'submit' \| 'reset'	'button'	-

HlmPopover

Selector: [hlmPopover],hlm-popover

Inputs

Prop	Type	Default	Description
align	BrnPopoverAlign	this._config.align	-
attachTo	BrnOverlayOptions['attachTo']	this._defaultOptions.attachTo	-
autoFocus	boolean	this._defaultOptions.autoFocus	-
closeOnOutsidePointerEvents	boolean	this._defaultOptions.closeOnOutsidePointerEvents	-
offsetX	number	this._config.offsetX	-
sideOffset	number	this._config.sideOffset	-
state	BrnOverlayState \| null	null	-

Outputs

Prop	Type	Default	Description
stateChanged	BrnOverlayState	-	-
closed	TResult	-	-

Progress

Pagination

On This Page

Stop configuring. Start shipping.

Zerops powers spartan.ng and Angular teams worldwide.

One-command deployment. Zero infrastructure headaches.

Popover

Installation

1 Copy utils if needed

2 Copy and paste the following code into your project.

Usage

Examples

Basic

Align

RTL

Brain API

BrnPopoverContent

Inputs

BrnPopoverTrigger

Inputs

BrnPopover

Inputs

Outputs

Helm API

HlmPopoverContent

HlmPopoverDescription

HlmPopoverHeader

HlmPopoverPortal

Inputs

HlmPopoverTitle

HlmPopoverTrigger

Inputs

HlmPopover

Inputs

Outputs