Skip to content

Latest commit

 

History

History
102 lines (66 loc) · 3.75 KB

README.md

File metadata and controls

102 lines (66 loc) · 3.75 KB
Raw

attrs Subpackage in elem-go

The attrs subpackage within elem-go offers a comprehensive set of constants representing HTML attributes, enhancing the process of setting attributes for HTML elements in a type-safe manner. This document outlines the usage and features of the attrs subpackage.

Table of Contents

Introduction

The attrs subpackage is designed to simplify the process of defining HTML attributes in Go. By providing constants for common attributes, it helps avoid errors due to typos and enhances code readability.

Usage

To use the attrs subpackage, import it alongside the main elem package:

import (
    "github.com/chasefleming/elem-go/attrs"
)

Available HTML Attributes

The subpackage includes a wide range of constants representing universal attributes, link/script attributes, meta attributes, image/embed attributes, semantic text attributes, form/input attributes, interactive attributes, miscellaneous attributes, table attributes, iframe attributes, audio/video attributes, and video-specific attributes.

For instance, some of the constants are:

  • Universal Attributes like Class, ID, Style
  • Link/Script Attributes such as Href, Src
  • Form/Input Attributes including Type, Value, Placeholder

For a full list of available constants, see the attrs.go file.

Using Props Type

The Props type is a map of strings that can be used to pass attribute values to HTML elements in a structured way. This type-safe approach ensures the correct assignment of attributes to elements.

Examples

Here's an example of using attrs constants to set attributes for a button:

buttonAttrs := attrs.Props{
    attrs.Type:  "button",
    attrs.Class: "btn btn-primary",
    attrs.ID:    "submitBtn",
}

button := elem.Button(buttonAttrs, elem.Text("Submit"))

In this example, attributes for the button element are defined using the attrs.Props map with attrs constants.

Utilities

The attrs subpackage also includes utility functions to enhance the attribute manipulation process.

Merge

The Merge function allows you to merge multiple attrs.Props maps into a single map. This is useful when you want to combine attribute maps for an element. Note that if there are conflicting keys, the last map's value will override the previous ones.

Usage

defaultButtonAttrs := attrs.Props{
    attrs.Class: "btn",
    attrs.Type:  "button",
}

primaryButtonAttrs := attrs.Props{
    attrs.Class: "btn btn-primary", // Overrides the Class attribute from defaultButtonAttrs
    attrs.ID:    "submitBtn",
}

mergedButtonAttrs := attrs.Merge(defaultButtonAttrs, primaryButtonAttrs)

button := elem.Button(mergedButtonAttrs, elem.Text("Submit"))

In this example, the Merge function is used to combine the default button attributes with the primary button attributes. The Class attribute from the primaryButtonAttrs map overrides the Class attribute from the defaultButtonAttrs map.

DataAttr

The DataAttr function is a convenient way to define data-* attributes for HTML elements. It takes the attribute name and value as arguments and returns a map of data-* attributes.

Usage

dataAttrs := attrs.DataAttr("foobar") // Outputs "data-foobar"

In this example, the DataAttr function is used to define a data-foobar attribute key for an HTML element.

By using the attrs subpackage, you can ensure type safety and correctness when working with HTML attributes in Go, making your development process smoother and more efficient.