- 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
- 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
Button
Displays a callout for user attention.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowUp } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-preview',
imports: [HlmButtonImports, NgIcon],
providers: [provideIcons({ lucideArrowUp })],
host: { class: 'flex flex-wrap items-center gap-2 md:flex-row' },
template: `
<button hlmBtn variant="outline">Button</button>
<button hlmBtn size="icon" variant="outline">
<ng-icon name="lucideArrowUp" />
</button>
`,
})
export class ButtonPreview {}Installation
ng g @spartan-ng/cli:ui buttonnx g @spartan-ng/cli:ui buttonimport { 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, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/50 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-md border border-transparent bg-clip-padding text-sm font-medium focus-visible:ring-3 data-[matches-spartan-invalid=true]:ring-3 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground hover:bg-primary/80',
outline: 'border-border bg-background hover:bg-muted hover:text-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 aria-expanded:bg-muted aria-expanded:text-foreground shadow-xs',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-9 gap-1.5 px-2.5 in-data-[slot=button-group]:rounded-md has-data-[icon=inline-end]:pr-2 has-data-[icon=inline-start]:pl-2',
xs: 'h-6 gap-1 rounded-[min(var(--radius-md),8px)] px-2 text-xs in-data-[slot=button-group]:rounded-md has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
sm: 'h-8 gap-1 rounded-[min(var(--radius-md),10px)] px-2.5 in-data-[slot=button-group]:rounded-md has-data-[icon=inline-end]:pr-1.5 has-data-[icon=inline-start]:pl-1.5',
lg: 'h-10 gap-1.5 px-2.5 has-data-[icon=inline-end]:pr-3 has-data-[icon=inline-start]:pl-3',
icon: 'size-9',
'icon-xs': 'size-6 rounded-[min(var(--radius-md),8px)] in-data-[slot=button-group]:rounded-md [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-sm': 'size-8 rounded-[min(var(--radius-md),10px)] in-data-[slot=button-group]:rounded-md',
'icon-lg': 'size-10',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;import type, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/50 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-none border border-transparent bg-clip-padding text-xs font-medium focus-visible:ring-1 data-[matches-spartan-invalid=true]:ring-1 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground [a]:hover:bg-primary/80',
outline: 'border-border bg-background hover:bg-muted hover:text-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 aria-expanded:bg-muted aria-expanded:text-foreground',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-8 gap-1.5 px-2.5 has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2',
xs: 'h-6 gap-1 rounded-none px-2 text-xs has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
sm: 'h-7 gap-1 rounded-none px-2.5 has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3.5)]',
lg: 'h-9 gap-1.5 px-2.5 has-data-[icon=inline-end]:pe-3 has-data-[icon=inline-start]:ps-3',
icon: 'size-8',
'icon-xs': 'size-6 rounded-none [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-sm': 'size-7 rounded-none',
'icon-lg': 'size-9',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;import type, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/50 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-4xl border border-transparent bg-clip-padding text-sm font-medium focus-visible:ring-[3px] data-[matches-spartan-invalid=true]:ring-[3px] [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground hover:bg-primary/80',
outline: 'border-border bg-input/30 hover:bg-input/50 hover:text-foreground aria-expanded:bg-muted aria-expanded:text-foreground',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-9 gap-1.5 px-3 has-data-[icon=inline-end]:pe-2.5 has-data-[icon=inline-start]:ps-2.5',
xs: 'h-6 gap-1 px-2.5 text-xs has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
sm: 'h-8 gap-1 px-3 has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2',
lg: 'h-10 gap-1.5 px-4 has-data-[icon=inline-end]:pe-3 has-data-[icon=inline-start]:ps-3',
icon: 'size-9',
'icon-xs': 'size-6 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-sm': 'size-8',
'icon-lg': 'size-10',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;import type, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/30 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-md border border-transparent bg-clip-padding text-xs/relaxed font-medium focus-visible:ring-2 data-[matches-spartan-invalid=true]:ring-2 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground hover:bg-primary/80',
outline: 'border-border dark:bg-input/30 hover:bg-input/50 hover:text-foreground aria-expanded:bg-muted aria-expanded:text-foreground',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-7 gap-1 px-2 text-xs/relaxed has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3.5)]',
xs: 'h-5 gap-1 rounded-sm px-2 text-[0.625rem] has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[10px]',
sm: 'h-6 gap-1 px-2 text-xs/relaxed has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
lg: 'h-8 gap-1 px-2.5 text-xs/relaxed has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)]',
icon: 'size-7 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3.5)]',
'icon-xs': 'size-5 rounded-sm [&_ng-icon:not([class*=\'text-\'])]:text-[10px]',
'icon-sm': 'size-6 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-lg': 'size-8 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)]',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;import type, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/50 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-lg border border-transparent bg-clip-padding text-sm font-medium focus-visible:ring-3 data-[matches-spartan-invalid=true]:ring-3 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground [a]:hover:bg-primary/80',
outline: 'border-border bg-background hover:bg-muted hover:text-foreground dark:bg-input/30 dark:border-input dark:hover:bg-input/50 aria-expanded:bg-muted aria-expanded:text-foreground',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-8 gap-1.5 px-2.5 has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2',
xs: 'h-6 gap-1 rounded-[min(var(--radius-md),10px)] px-2 text-xs in-data-[slot=button-group]:rounded-lg has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
sm: 'h-7 gap-1 rounded-[min(var(--radius-md),12px)] px-2.5 text-[0.8rem] in-data-[slot=button-group]:rounded-lg has-data-[icon=inline-end]:pe-1.5 has-data-[icon=inline-start]:ps-1.5 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3.5)]',
lg: 'h-9 gap-1.5 px-2.5 has-data-[icon=inline-end]:pe-3 has-data-[icon=inline-start]:ps-3',
icon: 'size-8',
'icon-xs': 'size-6 rounded-[min(var(--radius-md),10px)] in-data-[slot=button-group]:rounded-lg [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-sm': 'size-7 rounded-[min(var(--radius-md),12px)] in-data-[slot=button-group]:rounded-lg',
'icon-lg': 'size-9',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;import type, { ClassValue } from 'clsx';
import { BrnButton } from '@spartan-ng/brain/button';
import { Directive, InjectionToken, inject, input, signal, type ValueProvider } from '@angular/core';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
export interface BrnButtonConfig {
variant: ButtonVariants['variant'];
size: ButtonVariants['size'];
}
const defaultConfig: BrnButtonConfig = {
variant: 'default',
size: 'default',
};
const BrnButtonConfigToken = new InjectionToken<BrnButtonConfig>('BrnButtonConfig');
export function provideBrnButtonConfig(config: Partial<BrnButtonConfig>): ValueProvider {
return { provide: BrnButtonConfigToken, useValue: { ...defaultConfig, ...config } };
}
export function injectBrnButtonConfig(): BrnButtonConfig {
return inject(BrnButtonConfigToken, { optional: true }) ?? defaultConfig;
}
export const buttonVariants = cva(
'focus-visible:border-ring focus-visible:ring-ring/30 data-[matches-spartan-invalid=true]:ring-destructive/20 dark:data-[matches-spartan-invalid=true]:ring-destructive/40 data-[matches-spartan-invalid=true]:border-destructive dark:data-[matches-spartan-invalid=true]:border-destructive/50 rounded-4xl border border-transparent bg-clip-padding text-sm font-medium focus-visible:ring-3 active:not-aria-[haspopup]:translate-y-px data-[matches-spartan-invalid=true]:ring-3 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*4)] group/button inline-flex shrink-0 items-center justify-center whitespace-nowrap transition-all outline-none select-none data-disabled:pointer-events-none data-disabled:opacity-50 [&_ng-icon]:pointer-events-none [&_ng-icon]:shrink-0',
{
variants: {
variant: {
default: 'bg-primary text-primary-foreground hover:bg-primary/80',
outline: 'border-border bg-background hover:bg-muted hover:text-foreground dark:hover:bg-input/30 aria-expanded:bg-muted aria-expanded:text-foreground dark:bg-transparent',
secondary: 'bg-secondary text-secondary-foreground hover:bg-secondary/80 aria-expanded:bg-secondary aria-expanded:text-secondary-foreground',
ghost: 'hover:bg-muted hover:text-foreground dark:hover:bg-muted/50 aria-expanded:bg-muted aria-expanded:text-foreground',
destructive: 'bg-destructive/10 hover:bg-destructive/20 focus-visible:ring-destructive/20 dark:focus-visible:ring-destructive/40 dark:bg-destructive/20 text-destructive focus-visible:border-destructive/40 dark:hover:bg-destructive/30',
link: 'text-primary underline-offset-4 hover:underline',
},
size: {
default: 'h-9 gap-1.5 px-3 has-data-[icon=inline-end]:pe-2.5 has-data-[icon=inline-start]:ps-2.5',
xs: 'h-6 gap-1 px-2.5 text-xs has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
sm: 'h-8 gap-1 px-3 has-data-[icon=inline-end]:pe-2 has-data-[icon=inline-start]:ps-2',
lg: 'h-10 gap-1.5 px-4 has-data-[icon=inline-end]:pe-3 has-data-[icon=inline-start]:ps-3',
icon: 'size-9',
'icon-xs': 'size-6 [&_ng-icon:not([class*=\'text-\'])]:text-[calc(var(--spacing)*3)]',
'icon-sm': 'size-8',
'icon-lg': 'size-10',
},
},
defaultVariants: {
variant: 'default',
size: 'default',
},
},
);
export type ButtonVariants = VariantProps<typeof buttonVariants>;
@Directive({
selector: 'button[hlmBtn], a[hlmBtn]',
exportAs: 'hlmBtn',
hostDirectives: [{ directive: BrnButton, inputs: ['disabled'] }],
host: {
'data-slot': 'button',
},
})
export class HlmButton {
private readonly _config = injectBrnButtonConfig();
private readonly _additionalClasses = signal<ClassValue>('');
public readonly variant = input<ButtonVariants['variant']>(this._config.variant);
public readonly size = input<ButtonVariants['size']>(this._config.size);
constructor() {
classes(() => [buttonVariants({ variant: this.variant(), size: this.size() }), this._additionalClasses()]);
}
setClass(classes: string): void {
this._additionalClasses.set(classes);
}
}
export const HlmButtonImports = [HlmButton] as const;Usage
import { HlmButtonImports } from '@spartan-ng/helm/button';<button hlmBtn>Button</button>Cursor
Tailwind v4 switched from cursor: pointer to cursor: default for the button component.
If you want to keep the cursor: pointer behavior, add the following code to your CSS file:
@layer base {
button:not(:disabled),
[role="button"]:not(:disabled) {
cursor: pointer;
}
}Examples
Size
import { ChangeDetectionStrategy, Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowUpRight } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-size-preview',
imports: [HlmButtonImports, NgIcon],
providers: [
provideIcons({
lucideArrowUpRight,
}),
],
changeDetection: ChangeDetectionStrategy.OnPush,
host: {
class: 'flex flex-col items-start gap-8 sm:flex-row',
},
template: `
<div class="flex items-start gap-2">
<button hlmBtn size="xs" variant="outline">Extra Small</button>
<button hlmBtn size="icon-xs" aria-label="Submit" variant="outline">
<ng-icon name="lucideArrowUpRight" />
</button>
</div>
<div class="flex items-start gap-2">
<button hlmBtn size="sm" variant="outline">Small</button>
<button hlmBtn size="icon-sm" aria-label="Submit" variant="outline">
<ng-icon name="lucideArrowUpRight" />
</button>
</div>
<div class="flex items-start gap-2">
<button hlmBtn variant="outline">Default</button>
<button hlmBtn size="icon" aria-label="Submit" variant="outline">
<ng-icon name="lucideArrowUpRight" />
</button>
</div>
<div class="flex items-start gap-2">
<button hlmBtn variant="outline" size="lg">Large</button>
<button hlmBtn size="icon-lg" aria-label="Submit" variant="outline">
<ng-icon name="lucideArrowUpRight" />
</button>
</div>
`,
})
export class ButtonSizePreview {}Default
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowUp } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-preview',
imports: [HlmButtonImports, NgIcon],
providers: [provideIcons({ lucideArrowUp })],
host: { class: 'flex flex-wrap items-center gap-2 md:flex-row' },
template: `
<button hlmBtn variant="outline">Button</button>
<button hlmBtn size="icon" variant="outline">
<ng-icon name="lucideArrowUp" />
</button>
`,
})
export class ButtonPreview {}Outline
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-outline',
imports: [HlmButtonImports],
template: `
<button hlmBtn variant="outline">Outline</button>
`,
})
export class ButtonOutline {}Secondary
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-secondary',
imports: [HlmButtonImports],
template: `
<button hlmBtn variant="secondary">Secondary</button>
`,
})
export class ButtonSecondary {}Ghost
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-ghost',
imports: [HlmButtonImports],
template: `
<button hlmBtn variant="ghost">Ghost</button>
`,
})
export class ButtonGhost {}Destructive
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-destructive',
imports: [HlmButtonImports],
template: `
<button hlmBtn variant="destructive">Destructive</button>
`,
})
export class ButtonDestructive {}Link
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-link',
imports: [HlmButtonImports],
template: `
<button hlmBtn variant="link">Link</button>
`,
})
export class ButtonLink {}Icon
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideCircleFadingArrowUp } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmIconImports } from '@spartan-ng/helm/icon';
@Component({
selector: 'spartan-button-icon',
imports: [HlmButtonImports, NgIcon, HlmIconImports],
providers: [provideIcons({ lucideCircleFadingArrowUp })],
template: `
<button hlmBtn size="icon" variant="outline">
<ng-icon name="lucideCircleFadingArrowUp" />
</button>
`,
})
export class ButtonIcon {}With Icon
Remember to add the data-icon="inline-start" or data-icon="inline-end" attribute to the icon for the correct spacing.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideGitBranch } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmIconImports } from '@spartan-ng/helm/icon';
@Component({
selector: 'spartan-button-with-icon',
imports: [HlmButtonImports, NgIcon, HlmIconImports],
providers: [provideIcons({ lucideGitBranch })],
template: `
<div class="flex flex-wrap items-center gap-2 md:flex-row">
<button hlmBtn variant="outline" size="sm">
<ng-icon name="lucideGitBranch" />
New Branch
</button>
</div>
`,
})
export class ButtonWithIcon {}Rounded
Use the rounded-full class to make the button rounded.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowUp } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-rounded-preview',
imports: [HlmButtonImports, NgIcon],
providers: [
provideIcons({
lucideArrowUp,
}),
],
template: `
<button hlmBtn variant="outline" size="icon" class="rounded-full"><ng-icon name="lucideArrowUp" /></button>
`,
})
export class ButtonRoundedPreview {}Spinner
Render a hlm-spinner component inside the button to show a loading state. Remember to add the data-icon="inline-start" or data-icon="inline-end" attribute to the spinner for the correct spacing.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideLoaderCircle } from '@ng-icons/lucide';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmSpinnerImports } from '@spartan-ng/helm/spinner';
@Component({
selector: 'spartan-button-spinner',
imports: [HlmButtonImports, HlmSpinnerImports],
providers: [provideIcons({ lucideLoaderCircle })],
host: {
class: 'flex gap-2',
},
template: `
<button hlmBtn variant="outline" disabled>
<hlm-spinner data-icon="inline-start" />
Generating
</button>
<button hlmBtn variant="secondary" disabled>
Downloading
<hlm-spinner data-icon="inline-start" />
</button>
`,
})
export class ButtonSpinner {}As Anchor
import { Component } from '@angular/core';
import { HlmButtonImports } from '@spartan-ng/helm/button';
@Component({
selector: 'spartan-button-anchor',
imports: [HlmButtonImports],
template: `
<a hlmBtn target="_blank" variant="link" href="https://github.com/spartan-ng/spartan">Star on GitHub</a>
`,
})
export class ButtonAnchor {}RTL
To enable RTL support in spartan-ng, see the RTL configuration guide.
import { Component, computed, inject } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowRight, lucidePlus } from '@ng-icons/lucide';
import { TranslateService, Translations } from '@spartan-ng/app/app/shared/translate.service';
import { HlmButtonImports } from '@spartan-ng/helm/button';
import { HlmSpinnerImports } from '@spartan-ng/helm/spinner';
@Component({
selector: 'spartan-button-rtl-preview',
imports: [HlmButtonImports, NgIcon, HlmSpinnerImports],
providers: [
provideIcons({
lucideArrowRight,
lucidePlus,
}),
],
host: {
class: 'flex flex-wrap items-center gap-2 md:flex-row',
'[dir]': '_dir()',
},
template: `
<button hlmBtn variant="outline">{{ _t()['button'] }}</button>
<button hlmBtn variant="destructive">{{ _t()['delete'] }}</button>
<button hlmBtn variant="outline">
{{ _t()['submit'] }}
<ng-icon class="rtl:rotate-180" data-icon="inline-end" name="lucideArrowRight" />
</button>
<button hlmBtn variant="outline" size="icon" aria-label="Add">
<ng-icon name="lucidePlus" />
</button>
<button hlmBtn variant="secondary" disabled>
<hlm-spinner data-icon="inline-start" />
{{ _t()['loading'] }}
</button>
`,
})
export class ButtonRtlPreview {
private readonly _language = inject(TranslateService).language;
private readonly _translations: Translations = {
en: {
dir: 'ltr',
values: {
button: 'Button',
submit: 'Submit',
delete: 'Delete',
loading: 'Loading',
},
},
ar: {
dir: 'rtl',
values: {
button: 'زر',
submit: 'إرسال',
delete: 'حذف',
loading: 'جاري التحميل',
},
},
he: {
dir: 'rtl',
values: {
button: 'כפתור',
submit: 'שלח',
delete: 'מחק',
loading: 'טוען',
},
},
};
private readonly _translation = computed(() => this._translations[this._language()]);
protected readonly _t = computed(() => this._translation().values);
protected readonly _dir = computed(() => this._translation().dir);
}Brain API
BrnButton
Selector: a[brnButton], button[brnButton]
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| disabled | boolean | false | - |
Helm API
HlmButton
Selector: button[hlmBtn], a[hlmBtn]
ExportAs: hlmBtn
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| variant | ButtonVariants['variant'] | this._config.variant | - |
| size | ButtonVariants['size'] | this._config.size | - |
On This Page