element

Documentation

Index

• type HXOption
  • func WithHXMethod(method, value string) HXOption
  • func WithHXParams(params string) HXOption
  • func WithHXPushURL(value bool) HXOption
  • func WithHXSwap(swap string) HXOption
  • func WithHXTarget(target string) HXOption
  • func WithHXValues(values map[string]any) HXOption
• type Properties
  • func NewProperties(options ...PropertiesOption) *Properties
  • func (p *Properties) Attributes() templ.Attributes
  • func (p *Properties) Classes() []string
  • func (p *Properties) HasAttribute(key string) bool
  • func (p *Properties) ID() string
  • func (p *Properties) SetAttribute(key string, value any)
• type PropertiesOption
  • func MergeAttributes(attributes templ.Attributes) PropertiesOption
  • func WithAttribute(key string, value any) PropertiesOption
  • func WithClasses(classes ...string) PropertiesOption
  • func WithHXOptions(options ...HXOption) PropertiesOption

Types

type HXOption

type HXOption func(*Properties)

HXOption is a functional option to set a HTMX attribute.

func WithHXMethod

func WithHXMethod(method, value string) HXOption

WithHXMethod sets a "hx-{get,post,put,delete}" attribute.

func WithHXParams

func WithHXParams(params string) HXOption

WithHXParams sets a "hx-params" attribute.

func WithHXPushURL

func WithHXPushURL(value bool) HXOption

WithHXPushURL sets a "hx-push-url" attribute.

func WithHXSwap

func WithHXSwap(swap string) HXOption

WithHXSwap sets a "hx-swap" attribute.

func WithHXTarget

func WithHXTarget(target string) HXOption

WithHXTarget sets a "hx-target" attribute.

func WithHXValues

func WithHXValues(values map[string]any) HXOption

WithHXValues sets a "hx-vals" attribute. Note that the given map is marshaled to JSON and any marshaling error will silently result in no attribute being set.

type Properties

type Properties struct {
	// contains filtered or unexported fields
}

Properties represents properties of an element, including its attributes and classes.

func NewProperties

func NewProperties(options ...PropertiesOption) *Properties

NewProperties creates a Properties object for an element with the given options.

func (*Properties) Attributes

func (p *Properties) Attributes() templ.Attributes

Attributes returns the attributes as a templ.Attributes.

func (*Properties) Classes

func (p *Properties) Classes() []string

Classes returns the classes as a []string.

func (*Properties) HasAttribute

func (p *Properties) HasAttribute(key string) bool

HasAttribute returns a boolean indicating whether there is an attribute with the given key.

func (*Properties) ID

func (p *Properties) ID() string

ID returns the value of the "id" attribute. If there is no id attribute, an empty string is returned.

func (*Properties) SetAttribute

func (p *Properties) SetAttribute(key string, value any)

SetAttribute sets an attribute with the given key to the given value. Any existing value is overridden.

type PropertiesOption

type PropertiesOption func(*Properties)

PropertiesOption is a functional option to set Properties.

func MergeAttributes

func MergeAttributes(attributes templ.Attributes) PropertiesOption

MergeAttributes option merges the given attributes with any existing attributes.

func WithAttribute

func WithAttribute(key string, value any) PropertiesOption

WithAttribute option sets a key-value attribute on the properties. Any existing value is overridden.

func WithClasses

func WithClasses(classes ...string) PropertiesOption

WithClasses option sets the classes on the properties. New values are merged with existing values and any duplicates removed.

func WithHXOptions

func WithHXOptions(options ...HXOption) PropertiesOption

WithHXOptions option is a way to set all HX options at once.