props

Documentation

Overview

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Package props provides helper types and functions to manage HTML attributes in templ. It includes the Attrs type, which wraps templ.Attributes and provides convenient methods for chaining, merging, and manipulating attributes.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Copyright 2025 Deirror. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Index

• func FirstOrDefault[T any](def T, props ...T) T
• type Attrs
  • func (a Attrs) AsTemplAttrs() templ.Attributes
  • func (a Attrs) Merge(other Attrs) Attrs
  • func (a Attrs) With(key, val string) Attrs
  • func (a Attrs) WithClass(class string) Attrs
  • func (a Attrs) WithID(id string) Attrs
  • func (a Attrs) WithStyle(style string) Attrs
• type AttrsProvider
• type EmptyAttrsProvider
  • func (e EmptyAttrsProvider) AsTemplAttrs() templ.Attributes
• type Key

Functions

func FirstOrDefault

func FirstOrDefault[T any](def T, props ...T) T

FirstOrDefault returns the first value from props if any are provided. Otherwise, it returns the default value def.

Types

type Attrs

type Attrs struct {
	templ.Attributes
}

Attrs wraps templ.Attributes and adds helper functions.

func (Attrs) AsTemplAttrs

func (a Attrs) AsTemplAttrs() templ.Attributes

AsTemplAttrs flattens all nested Props (Aria, Hx, Data, Attrs) into a single set of templ.Attributes.

func (Attrs) Merge

func (a Attrs) Merge(other Attrs) Attrs

Merge merges another Attrs into this one.

func (Attrs) With

func (a Attrs) With(key, val string) Attrs

With sets given key attribute with string val.

func (Attrs) WithClass

func (a Attrs) WithClass(class string) Attrs

WithClass sets or appends a class.

func (Attrs) WithID

func (a Attrs) WithID(id string) Attrs

WithID sets the id attribute.

func (Attrs) WithStyle

func (a Attrs) WithStyle(style string) Attrs

WithStyle sets or appends a style attribute.

type AttrsProvider

type AttrsProvider interface {
	AsTemplAttrs() templ.Attributes
}

AttrsProvider prepares all attributes into one merged templ.Attributes which is used in the html tags.

type EmptyAttrsProvider

type EmptyAttrsProvider struct{}

EmptyAttrsProvider is a no-op AttrsProvider. It can be used when you want to render an element without any attributes.

func (EmptyAttrsProvider) AsTemplAttrs

func (e EmptyAttrsProvider) AsTemplAttrs() templ.Attributes

AsTemplAttrs returns an empty templ.Attributes map.

type Key

type Key = string

const (
	ID    Key = "id"
	Class Key = "class"
	Style Key = "style"

	Disabled    Key = "disabled"
	Type        Key = "type"
	Href        Key = "href"
	Name        Key = "name"
	Multiple    Key = "multiple"
	Required    Key = "required"
	Value       Key = "value"
	Selected    Key = "selected"
	Method      Key = "method"
	EncType     Key = "enctype"
	Target      Key = "target"
	NoValidate  Key = "novalidate"
	Placeholder Key = "placeholder"
	ReadOnly    Key = "readonly"
	Checked     Key = "checked"
	For         Key = "for"
	Min         Key = "min"
	Max         Key = "max"
	Low         Key = "low"
	High        Key = "high"
	Optimum     Key = "optimum"
	AriaLabel   Key = "aria-label"
	Src         Key = "src"
	Alt         Key = "alt"
	Controls    Key = "controls"
	Autoplay    Key = "autoplay"
	Loop        Key = "loop"
	Muted       Key = "muted"
	Width       Key = "width"
	Height      Key = "height"
	PlaysInline Key = "playsinline"
	Cols        Key = "cols"
	Rows        Key = "rows"
	Role        Key = "role"
)