- 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
Input Group
A flexible input group that combines inputs with addons, prefixes, and suffixes to improve usability.
import { Component } from '@angular/core';
import { ReactiveFormsModule } from '@angular/forms';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideArrowUp, lucideCheck, lucideInfo, lucidePlus, lucideSearch, lucideSend } from '@ng-icons/lucide';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmSeparatorImports } from '@spartan-ng/helm/separator';
import { HlmTooltipImports } from '@spartan-ng/helm/tooltip';
@Component({
selector: 'spartan-input-group-preview',
imports: [HlmInputGroupImports, NgIcon, HlmSeparatorImports, HlmTooltipImports, ReactiveFormsModule],
providers: [provideIcons({ lucideSend, lucideSearch, lucideInfo, lucidePlus, lucideArrowUp, lucideCheck })],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Search..." />
<div hlmInputGroupAddon>
<ng-icon name="lucideSearch" />
</div>
<div hlmInputGroupAddon align="inline-end">12 results</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="example.com" class="!pl-1" />
<div hlmInputGroupAddon>
<span hlmInputGroupText>https://</span>
</div>
<div hlmInputGroupAddon align="inline-end">
<button hlmInputGroupButton class="rounded-full" size="icon-xs" [hlmTooltip]="'This is content in a tooltip.'">
<ng-icon name="lucideInfo" />
</button>
</div>
</div>
<div hlmInputGroup>
<textarea hlmInputGroupTextarea placeholder="Ask, Search or Chat..."></textarea>
<div hlmInputGroupAddon align="block-end">
<button hlmInputGroupButton variant="outline" class="rounded-full" size="icon-xs">
<ng-icon name="lucidePlus" />
</button>
<span hlmInputGroupText class="ml-auto">52% used</span>
<hlm-separator orientation="vertical" class="!h-4" />
<button hlmInputGroupButton variant="default" class="rounded-full" size="icon-xs" disabled>
<ng-icon name="lucideArrowUp" />
<span class="sr-only">Send</span>
</button>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="@spartan" />
<div hlmInputGroupAddon align="inline-end">
<div class="bg-primary text-primary-foreground flex size-4 items-center justify-center rounded-full">
<ng-icon name="lucideCheck" class="text-xs" />
</div>
</div>
</div>
`,
})
export class InputGroupPreview {}Installation
ng g @spartan-ng/cli:ui input-groupnx g @spartan-ng/cli:ui input-groupimport { 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 { BrnFieldControl } from '@spartan-ng/brain/field';
import { Directive, computed, contentChild, inject, input } from '@angular/core';
import { HlmButton, provideBrnButtonConfig } from '@spartan-ng/helm/button';
import { HlmInput } from '@spartan-ng/helm/input';
import { HlmTextarea } from '@spartan-ng/helm/textarea';
import { classes } from '@spartan-ng/helm/utils';
import { cva, type VariantProps } from 'class-variance-authority';
const inputGroupAddonVariants = cva(
"text-muted-foreground flex h-auto cursor-text items-center justify-center gap-2 py-1.5 text-sm font-medium select-none group-data-[disabled=true]/input-group:opacity-50 [&>kbd]:rounded-[calc(var(--radius)-5px)] [&>ng-icon:not([class*='text-'])]:text-base",
{
variants: {
align: {
'inline-start': 'order-first ps-3 has-[>button]:ml-[-0.45rem] has-[>kbd]:ml-[-0.35rem]',
'inline-end': 'order-last pe-3 has-[>button]:mr-[-0.45rem] has-[>kbd]:mr-[-0.35rem]',
'block-start':
'order-first w-full justify-start px-3 pt-3 group-has-[>input]/input-group:pt-2.5 [.border-b]:pb-3',
'block-end': 'order-last w-full justify-start px-3 pb-3 group-has-[>input]/input-group:pb-2.5 [.border-t]:pt-3',
},
},
defaultVariants: {
align: 'inline-start',
},
},
);
type InputGroupAddonVariants = VariantProps<typeof inputGroupAddonVariants>;
@Directive({
selector: 'hlm-input-group-addon,[hlmInputGroupAddon]',
host: {
role: 'group',
'data-slot': 'input-group-addon',
'[attr.data-align]': 'align()',
},
})
export class HlmInputGroupAddon {
public readonly align = input<InputGroupAddonVariants['align']>('inline-start');
constructor() {
classes(() => inputGroupAddonVariants({ align: this.align() }));
}
}
const inputGroupAddonVariants = cva('flex items-center gap-2 text-sm shadow-none', {
variants: {
size: {
xs: "h-6 gap-1 rounded-[calc(var(--radius)-5px)] px-2 has-[>ng-icon]:px-2 [&>ng-icon:not([class*='text-'])]:text-sm",
sm: 'h-8 gap-1.5 rounded-md px-2.5 has-[>ng-icon]:px-2.5',
'icon-xs': 'size-6 rounded-[calc(var(--radius)-5px)] p-0 has-[>ng-icon]:p-0',
'icon-sm': 'size-8 p-0 has-[>ng-icon]:p-0',
},
},
defaultVariants: {
size: 'xs',
},
});
type InputGroupAddonVariants = VariantProps<typeof inputGroupAddonVariants>;
@Directive({
selector: 'button[hlmInputGroupButton]',
providers: [
provideBrnButtonConfig({
variant: 'ghost',
}),
],
hostDirectives: [
{
directive: HlmButton,
inputs: ['variant'],
},
],
host: {
'[attr.data-size]': 'size()',
'[type]': 'type()',
},
})
export class HlmInputGroupButton {
public readonly size = input<InputGroupAddonVariants['size']>('xs');
public readonly type = input<'button' | 'submit' | 'reset'>('button');
constructor() {
classes(() => inputGroupAddonVariants({ size: this.size() }));
}
}
@Directive({
selector: 'input[hlmInputGroupInput]',
hostDirectives: [HlmInput],
host: {
'data-slot': 'input-group-control',
},
})
export class HlmInputGroupInput {
constructor() {
classes(() => `flex-1 rounded-none border-0 bg-transparent shadow-none focus-visible:ring-0 dark:bg-transparent`);
}
}
@Directive({
selector: 'span[hlmInputGroupText]',
})
export class HlmInputGroupText {
constructor() {
classes(
() =>
`text-muted-foreground flex items-center gap-2 text-sm [&_ng-icon]:pointer-events-none [&_ng-icon:not([class*='text-'])]:text-base`,
);
}
}
@Directive({
selector: 'textarea[hlmInputGroupTextarea]',
hostDirectives: [HlmTextarea],
host: {
'data-slot': 'input-group-control',
},
})
export class HlmInputGroupTextarea {
constructor() {
classes(
() =>
'flex-1 resize-none rounded-none border-0 bg-transparent py-3 shadow-none focus-visible:ring-0 dark:bg-transparent',
);
}
}
@Directive({
selector: '[hlmInputGroup],hlm-input-group',
host: {
'data-slot': 'input-group',
role: 'group',
},
})
export class HlmInputGroup {
private readonly _fieldControl = inject(BrnFieldControl, { optional: true });
private readonly _fieldControlChild = contentChild(BrnFieldControl);
private readonly _spartanInvalid = computed(() => {
if (this._fieldControl) return this._fieldControl.spartanInvalid();
return this._fieldControlChild()?.spartanInvalid();
});
constructor() {
classes(() => [
'group/input-group border-input dark:bg-input/30 relative flex w-full items-center rounded-md border shadow-xs transition-[color,box-shadow] outline-none',
'h-9 min-w-0 has-[>textarea]:h-auto',
// Variants based on alignment.
'has-[>[data-align=inline-start]]:[&>input]:ps-2',
'has-[>[data-align=inline-end]]:[&>input]:pe-2',
'has-[>[data-align=block-start]]:h-auto has-[>[data-align=block-start]]:flex-col has-[>[data-align=block-start]]:[&>input]:pb-3',
'has-[>[data-align=block-end]]:h-auto has-[>[data-align=block-end]]:flex-col has-[>[data-align=block-end]]:[&>input]:pt-3',
'has-[[data-slot=input-group-control]:focus-visible]:ring-[3px]',
this._spartanInvalid?.()
? 'has-[>[data-matches-spartan-invalid=true]]:ring-destructive/20 has-[>[data-matches-spartan-invalid=true]]:border-destructive dark:has-[>[data-matches-spartan-invalid=true]]:ring-destructive/40'
: 'has-[[data-slot=input-group-control]:focus-visible]:border-ring has-[[data-slot=input-group-control]:focus-visible]:ring-ring/50',
]);
}
}
export const HlmInputGroupImports = [
HlmInputGroup,
HlmInputGroupAddon,
HlmInputGroupButton,
HlmInputGroupInput,
HlmInputGroupText,
HlmInputGroupTextarea,
] as const;Usage
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Search..." />
<div hlmInputGroupAddon>
<ng-icon name="lucideSearch" />
</div>
<div hlmInputGroupAddon align="inline-end">12 results</div>
</div>Examples
Icons
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideCheck, lucideCreditCard, lucideInfo, lucideMail, lucideSearch, lucideStar } from '@ng-icons/lucide';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
@Component({
selector: 'spartan-input-group-icon-preview',
imports: [HlmInputGroupImports, NgIcon, HlmIconImports],
providers: [provideIcons({ lucideSearch, lucideMail, lucideCheck, lucideCreditCard, lucideStar, lucideInfo })],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Search..." />
<div hlmInputGroupAddon>
<ng-icon name="lucideSearch" />
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput type="email" placeholder="Enter your email" />
<div hlmInputGroupAddon>
<ng-icon name="lucideMail" />
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Card number" />
<div hlmInputGroupAddon>
<ng-icon name="lucideCreditCard" />
</div>
<div hlmInputGroupAddon align="inline-end">
<ng-icon name="lucideCheck" />
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Card number" />
<div hlmInputGroupAddon align="inline-end">
<ng-icon name="lucideStar" />
<ng-icon name="lucideInfo" />
</div>
</div>
`,
})
export class InputGroupIconPreview {}Text
Display additional text information alongside inputs.
import { Component } from '@angular/core';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
@Component({
selector: 'spartan-input-group-text-preview',
imports: [HlmInputGroupImports],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<div hlmInputGroupAddon>
<span hlmInputGroupText>$</span>
</div>
<input hlmInputGroupInput placeholder="0.00" />
<div hlmInputGroupAddon align="inline-end">
<span hlmInputGroupText>USD</span>
</div>
</div>
<div hlmInputGroup>
<div hlmInputGroupAddon>
<span hlmInputGroupText>https://</span>
</div>
<input hlmInputGroupInput placeholder="example.com" class="!pl-0.5" />
<div hlmInputGroupAddon align="inline-end">
<span hlmInputGroupText>.com</span>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Enter your username" />
<div hlmInputGroupAddon align="inline-end">
<span hlmInputGroupText>@company.com</span>
</div>
</div>
<div hlmInputGroup>
<textarea hlmInputGroupTextarea placeholder="Enter your message"></textarea>
<div hlmInputGroupAddon align="block-end">
<span hlmInputGroupText class="text-muted-foreground text-xs">120 characters left</span>
</div>
</div>
`,
})
export class InputGroupTextPreview {}Buttons
Add buttons to perform actions within the input group.
import { Component, computed, signal } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { tablerCheck, tablerCopy, tablerInfoCircle, tablerStar } from '@ng-icons/tabler-icons';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmPopoverImports } from '@spartan-ng/helm/popover';
@Component({
selector: 'spartan-input-group-button-preview',
imports: [HlmInputGroupImports, HlmIconImports, HlmPopoverImports],
providers: [provideIcons({ tablerCheck, tablerCopy, tablerInfoCircle, tablerStar })],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="https://github.com/spartan-ng/spartan" readOnly />
<div hlmInputGroupAddon align="inline-end">
<button
hlmInputGroupButton
aria-label="Copy"
title="Copy"
size="icon-xs"
(click)="_copy('https://github.com/spartan-ng/spartan')"
>
<ng-icon [name]="_isCopied() ? 'tablerCheck' : 'tablerCopy'" />
</button>
</div>
</div>
<div hlmInputGroup class="[--radius:9999px]">
<div hlmInputGroupAddon>
<button
hlmInputGroupButton
variant="secondary"
size="icon-xs"
hlmPopoverTrigger
[hlmPopoverTriggerFor]="brnPopover"
>
<ng-icon name="tablerInfoCircle" />
</button>
</div>
<div hlmInputGroupAddon class="text-muted-foreground pl-1.5">https://</div>
<input hlmInputGroupInput id="input-secure-19" />
<div hlmInputGroupAddon align="inline-end">
<button hlmInputGroupButton size="icon-xs" (click)="_toggleFavorite()">
<ng-icon name="tablerStar" [class]="_favoriteClass()" />
</button>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Type to search..." />
<div hlmInputGroupAddon align="inline-end">
<button hlmInputGroupButton variant="secondary">Search</button>
</div>
</div>
<hlm-popover sideOffset="10" align="start" #brnPopover="brnPopover">
<hlm-popover-content class="flex flex-col gap-1 rounded-xl text-sm" *hlmPopoverPortal="let ctx">
<p class="font-medium">Your connection is not secure.</p>
<p>You should not enter any sensitive information on this site.</p>
</hlm-popover-content>
</hlm-popover>
`,
})
export class InputGroupButtonPreview {
protected readonly _isCopied = signal(false);
protected readonly _isFavorite = signal(false);
protected readonly _favoriteClass = computed(() =>
this._isFavorite() ? '[&>svg]:fill-blue-600 [&>svg]:stroke-blue-600' : '',
);
protected _copy(text: string) {
void navigator.clipboard.writeText(text);
this._isCopied.set(true);
setTimeout(() => {
this._isCopied.set(false);
}, 3000);
}
protected _toggleFavorite(): void {
this._isFavorite.update((f) => !f);
}
}Tooltip
Add tooltips to provide additional context or help.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideInfo } from '@ng-icons/lucide';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmTooltipImports } from '@spartan-ng/helm/tooltip';
@Component({
selector: 'spartan-input-group-tooltip-preview',
imports: [HlmInputGroupImports, HlmTooltipImports, HlmIconImports],
providers: [
provideIcons({
lucideInfo,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Enter password" type="password" />
<div hlmInputGroupAddon align="inline-end">
<button
hlmInputGroupButton
[hlmTooltip]="'Password must be at least 8 characters'"
variant="ghost"
aria-label="Info"
size="icon-xs"
>
<ng-icon name="lucideInfo" />
</button>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Your email address" />
<div hlmInputGroupAddon align="inline-end">
<button hlmInputGroupButton [hlmTooltip]="tooltip" variant="ghost" aria-label="Info" size="icon-xs">
<ng-icon name="lucideInfo" />
</button>
<ng-template #tooltip>We'll use this to send you notifications</ng-template>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Enter API key" />
<div hlmInputGroupAddon>
<button
hlmInputGroupButton
[hlmTooltip]="'Click for help with API keys'"
position="left"
variant="ghost"
aria-label="Info"
size="icon-xs"
>
<ng-icon name="lucideInfo" />
</button>
</div>
</div>
`,
})
export class InputGroupTooltipPreview {}Textarea
Input groups also work with textarea components. Use block-start or block-end for alignment.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { tablerBrandJavascript, tablerCopy, tablerCornerDownLeft, tablerRefresh } from '@ng-icons/tabler-icons';
import { HlmIconImports } from '@spartan-ng/helm/icon';
@Component({
selector: 'spartan-input-group-textarea-preview',
imports: [HlmInputGroupImports, HlmIconImports],
providers: [
provideIcons({
tablerBrandJavascript,
tablerCopy,
tablerCornerDownLeft,
tablerRefresh,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<textarea
hlmInputGroupTextarea
id="textarea-code-32"
placeholder="console.log('Hello, world!');"
class="min-h-[200px]"
></textarea>
<div hlmInputGroupAddon align="block-end" class="border-t">
<span hlmInputGroupText>Line 1, Column 1</span>
<button hlmInputGroupButton size="sm" class="ml-auto" variant="default">
Run
<ng-icon name="tablerCornerDownLeft" />
</button>
</div>
<div hlmInputGroupAddon align="block-start" class="border-b">
<span hlmInputGroupText class="font-mono font-medium">
<ng-icon name="tablerBrandJavascript" />
script.js
</span>
<button hlmInputGroupButton class="ml-auto" size="icon-xs">
<ng-icon name="tablerRefresh" />
</button>
<button hlmInputGroupButton variant="ghost" size="icon-xs">
<ng-icon name="tablerCopy" />
</button>
</div>
</div>
`,
})
export class InputGroupTextareaPreview {}Spinner
Show loading indicators while processing input.
import { Component } from '@angular/core';
import { NgIcon, provideIcons } from '@ng-icons/core';
import { lucideLoader } from '@ng-icons/lucide';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmSpinnerImports } from '@spartan-ng/helm/spinner';
@Component({
selector: 'spartan-input-group-spinner-preview',
imports: [HlmInputGroupImports, NgIcon, HlmIconImports, HlmSpinnerImports],
providers: [provideIcons({ lucideLoader })],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup data-disabled="true">
<input hlmInputGroupInput placeholder="Searching..." disabled />
<div hlmInputGroupAddon align="inline-end">
<hlm-spinner />
</div>
</div>
<div hlmInputGroup data-disabled="true">
<input hlmInputGroupInput placeholder="Processing..." disabled />
<div hlmInputGroupAddon>
<hlm-spinner />
</div>
</div>
<div hlmInputGroup data-disabled="true">
<input hlmInputGroupInput placeholder="Saving changes..." disabled />
<div hlmInputGroupAddon align="inline-end">
<span hlmInputGroupText>Saving...</span>
<hlm-spinner />
</div>
</div>
<div hlmInputGroup data-disabled="true">
<input hlmInputGroupInput placeholder="Refreshing data..." disabled />
<div hlmInputGroupAddon>
<ng-icon name="lucideLoader" class="motion-safe:animate-spin" />
</div>
<div hlmInputGroupAddon align="inline-end">
<span hlmInputGroupText class="text-muted-foreground">Please wait...</span>
</div>
</div>
`,
})
export class InputGroupSpinnerPreview {}Label
Add labels within input groups to improve accessibility.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideInfo } from '@ng-icons/lucide';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmLabelImports } from '@spartan-ng/helm/label';
import { HlmTooltipImports } from '@spartan-ng/helm/tooltip';
@Component({
selector: 'spartan-input-group-label-preview',
imports: [HlmInputGroupImports, HlmIconImports, HlmTooltipImports, HlmLabelImports],
providers: [
provideIcons({
lucideInfo,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput id="email" placeholder="spartan" />
<div hlmInputGroupAddon>
<label for="email" hlmLabel>@</label>
</div>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput id="email-2" placeholder="spartan-ng@github.com" />
<div hlmInputGroupAddon align="block-start">
<label for="email-2" class="text-foreground" hlmLabel>Email</label>
<button
hlmInputGroupButton
[hlmTooltip]="tooltip"
variant="ghost"
aria-label="Help"
class="ml-auto rounded-full"
size="icon-xs"
>
<ng-icon name="lucideInfo" />
</button>
<ng-template #tooltip>We'll use this to send you notifications</ng-template>
</div>
</div>
`,
})
export class InputGroupLabelPreview {}Dropdown
Pair input groups with dropdown menus for complex interactions.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideChevronDown, lucideEllipsis } from '@ng-icons/lucide';
import { HlmDropdownMenuImports } from '@spartan-ng/helm/dropdown-menu';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
@Component({
selector: 'spartan-input-group-dropdown-preview',
imports: [HlmInputGroupImports, HlmIconImports, HlmDropdownMenuImports],
providers: [
provideIcons({
lucideEllipsis,
lucideChevronDown,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<input hlmInputGroupInput placeholder="Enter file name" />
<div hlmInputGroupAddon align="inline-end">
<button
hlmInputGroupButton
variant="ghost"
aria-label="More"
size="icon-xs"
[hlmDropdownMenuTrigger]="fileMenu"
align="end"
>
<ng-icon name="lucideEllipsis" />
</button>
</div>
</div>
<div hlmInputGroup class="[--radius:1rem]">
<input hlmInputGroupInput placeholder="Enter search query" />
<div hlmInputGroupAddon align="inline-end">
<button
hlmInputGroupButton
variant="ghost"
class="!pr-1.5 text-xs"
[hlmDropdownMenuTrigger]="searchMenu"
align="end"
>
Search In...
<ng-icon name="lucideChevronDown" />
</button>
</div>
</div>
<ng-template #fileMenu>
<hlm-dropdown-menu class="w-48">
<button hlmDropdownMenuItem>Settings</button>
<button hlmDropdownMenuItem>Copy path</button>
<button hlmDropdownMenuItem>Open location</button>
</hlm-dropdown-menu>
</ng-template>
<ng-template #searchMenu>
<hlm-dropdown-menu class="w-56 [--radius:0.95rem]">
<button hlmDropdownMenuItem>Documentation</button>
<button hlmDropdownMenuItem>Blog Posts</button>
<button hlmDropdownMenuItem>Changelog</button>
</hlm-dropdown-menu>
</ng-template>
`,
})
export class InputGroupDropdownPreview {}Button Group
Wrap input groups with button groups to create prefixes and suffixes.
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideLink2 } from '@ng-icons/lucide';
import { HlmButtonGroupImports } from '@spartan-ng/helm/button-group';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmLabelImports } from '@spartan-ng/helm/label';
@Component({
selector: 'spartan-input-group-button-group-preview',
imports: [HlmInputGroupImports, HlmButtonGroupImports, HlmLabelImports, HlmIconImports],
providers: [
provideIcons({
lucideLink2,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmButtonGroup>
<div hlmButtonGroupText>
<label hlmLabel for="url">https://</label>
</div>
<div hlmInputGroup>
<input hlmInputGroupInput id="url" />
<div hlmInputGroupAddon align="inline-end">
<ng-icon name="lucideLink2" />
</div>
</div>
<div hlmButtonGroupText>.com</div>
</div>
`,
})
export class InputGroupButtonGroupPreview {}Custom Input
Add the data-slot="input-group-control" attribute to your custom input for automatic behavior and focus state handling.
No style is applied to the custom input. Apply your own styles using the class prop.
import { CdkTextareaAutosize } from '@angular/cdk/text-field';
import { Component } from '@angular/core';
import { provideIcons } from '@ng-icons/core';
import { lucideLink2 } from '@ng-icons/lucide';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
@Component({
selector: 'spartan-input-group-custom-input-preview',
imports: [HlmInputGroupImports, CdkTextareaAutosize],
providers: [
provideIcons({
lucideLink2,
}),
],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<div hlmInputGroup>
<textarea
data-slot="input-group-control"
placeholder="Autoresize textarea..."
cdkTextareaAutosize
class="flex min-h-16 w-full resize-none rounded-md bg-transparent px-3 py-2.5 text-base transition-[color,box-shadow] outline-none md:text-sm"
></textarea>
<div hlmInputGroupAddon align="block-end">
<button hlmInputGroupButton class="ml-auto" size="sm" variant="default">Submit</button>
</div>
</div>
`,
})
export class InputGroupCustomInputPreview {}Form
import { Component, inject } from '@angular/core';
import { FormBuilder, ReactiveFormsModule, Validators } from '@angular/forms';
import { provideIcons } from '@ng-icons/core';
import { lucideInfo } from '@ng-icons/lucide';
import { HlmIconImports } from '@spartan-ng/helm/icon';
import { HlmInputGroupImports } from '@spartan-ng/helm/input-group';
import { HlmLabelImports } from '@spartan-ng/helm/label';
import { HlmTooltipImports } from '@spartan-ng/helm/tooltip';
@Component({
selector: 'spartan-input-group-form-preview',
imports: [ReactiveFormsModule, HlmInputGroupImports, HlmLabelImports, HlmIconImports, HlmTooltipImports],
providers: [provideIcons({ lucideInfo })],
host: {
class: 'grid w-full max-w-sm gap-6',
},
template: `
<form [formGroup]="form" (ngSubmit)="submit()" class="space-y-8">
<div hlmInputGroup>
<input hlmInputGroupInput id="email-form" placeholder="spartan-ng@github.com" formControlName="email" />
<div hlmInputGroupAddon align="block-start">
<label for="email-form" class="text-foreground" hlmLabel>Email</label>
<button
hlmInputGroupButton
[hlmTooltip]="tooltip"
variant="ghost"
aria-label="Help"
class="ml-auto rounded-full"
size="icon-xs"
>
<ng-icon name="lucideInfo" />
</button>
<ng-template #tooltip>We'll use this to send you notifications</ng-template>
</div>
<div hlmInputGroupAddon align="block-end">
<button
hlmInputGroupButton
class="ml-auto"
size="sm"
variant="default"
type="submit"
[disabled]="form.invalid"
>
Submit
</button>
</div>
</div>
</form>
`,
})
export class InputGroupFormPreview {
private readonly _formBuilder = inject(FormBuilder);
public form = this._formBuilder.group({
email: [null, [Validators.required, Validators.email]],
});
submit() {
console.log(this.form.value);
}
}Helm API
HlmInputGroupAddon
Selector: hlm-input-group-addon,[hlmInputGroupAddon]
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| align | InputGroupAddonVariants['align'] | inline-start | - |
HlmInputGroupButton
Selector: button[hlmInputGroupButton]
Inputs
| Prop | Type | Default | Description |
|---|---|---|---|
| size | InputGroupAddonVariants['size'] | xs | - |
| type | 'button' | 'submit' | 'reset' | button | - |
HlmInputGroupInput
Selector: input[hlmInputGroupInput]
HlmInputGroupText
Selector: span[hlmInputGroupText]
HlmInputGroupTextarea
Selector: textarea[hlmInputGroupTextarea]
HlmInputGroup
Selector: [hlmInputGroup],hlm-input-group
On This Page