Documentation
¶
Overview ¶
Package utils provides shared types, Tailwind class merging, and generic helpers used across all templ-components packages.
BaseProps is embedded by every component props struct for consistent ID, Class, Attrs, AriaLabel, and Nonce propagation. Class() merges Tailwind classes with conflict resolution via tailwind-merge-go.
Package utils provides shared utilities for templ components including Tailwind class merging, attribute helpers, and test rendering utilities.
Index ¶
- func AssertContains(t *testing.T, output, want string)
- func AssertContainsAll(t *testing.T, output string, wants ...string)
- func AssertEqual[T comparable](t *testing.T, context string, got, want T)
- func AssertNotContains(t *testing.T, output, notWant string)
- func Class(classes ...string) string
- func CurrentYear() string
- func DismissScript() string
- func EnsureID(prefix, id string) string
- func Lookup[K comparable, V any](m map[K]V, key K, fallback V) V
- func Render(t *testing.T, c templ.Component) string
- func RenderAll(t *testing.T, components ...templ.Component) string
- func Ternary[T any](condition bool, a, b T) T
- func ValidateID(componentName, id string) error
- type BaseProps
- type ComponentProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AssertContains ¶
AssertContains checks that the rendered output contains a substring
func AssertContainsAll ¶ added in v0.3.0
AssertContainsAll checks that the rendered output contains every substring in wants. Reports a single test error per missing substring.
func AssertEqual ¶
func AssertEqual[T comparable](t *testing.T, context string, got, want T)
AssertEqual checks that got equals want, reporting a test error with context if not
func AssertNotContains ¶
AssertNotContains checks that the rendered output does not contain a substring
func Class ¶
Class merges Tailwind classes intelligently using tailwind-merge-go. Conflicting classes are resolved with later arguments overriding earlier ones. Thread-safe via sync.Mutex to protect the shared LRU cache.
func DismissScript ¶
func DismissScript() string
DismissScript returns shared JavaScript for dismissing elements via [data-dismiss] click delegation. Used by Alert, Toast, and ErrorAlert components.
func EnsureID ¶ added in v0.3.0
EnsureID returns id if non-empty, otherwise generates a unique ID with the given prefix using crypto/rand for collision safety across HTMX page loads. Format: tc-<prefix>-<16 hex chars> (e.g. tc-modal-a1b2c3d4e5f6a7b8).
func Lookup ¶ added in v0.3.0
func Lookup[K comparable, V any](m map[K]V, key K, fallback V) V
Lookup returns the map value for key, or fallback if not found. Replaces the repetitive if-ok-return pattern used across all enum lookups.
func RenderAll ¶ added in v0.3.0
RenderAll renders multiple templ components into a single concatenated string. Useful for integration tests that verify component composition.
func ValidateID ¶ added in v0.3.0
ValidateID returns an error if id is empty, using componentName in the message.
Types ¶
type BaseProps ¶
type BaseProps struct {
ID string
Class string
Attrs templ.Attributes
AriaLabel string
Nonce string
}
BaseProps provides common configurable attributes for all components
func (*BaseProps) GetBaseProps ¶
GetBaseProps returns the embedded BaseProps. This method is promoted to all structs that embed BaseProps, satisfying the ComponentProps interface.
func (*BaseProps) SetBaseProps ¶
SetBaseProps updates the embedded BaseProps. This method is promoted to all structs that embed BaseProps, satisfying the ComponentProps interface.
type ComponentProps ¶
ComponentProps is the interface implemented by all component props structs that embed BaseProps. It enables generic component composition, validation, and wrapper functions across the entire component library.
Source Files