Documentation
¶
Index ¶
- func Checkbox(p CheckboxProps, children ...htmx.Node) htmx.Node
- func CheckboxError(p CheckboxProps, children ...htmx.Node) htmx.Node
- func CheckboxInfo(p CheckboxProps, children ...htmx.Node) htmx.Node
- func CheckboxPrimary(p CheckboxProps, children ...htmx.Node) htmx.Node
- func CheckboxSuccess(p CheckboxProps, children ...htmx.Node) htmx.Node
- func CheckboxWarning(p CheckboxProps, children ...htmx.Node) htmx.Node
- func Datalist(props DatalistProps, children ...htmx.Node) htmx.Node
- func DateInput(p DateInputProps, children ...htmx.Node) htmx.Node
- func Fieldset(p FieldsetProps, children ...htmx.Node) htmx.Node
- func FileInput(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputAccent(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputBordered(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputError(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputGhost(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputInfo(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputPrimary(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputSecondary(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputSuccess(p FileInputProps, children ...htmx.Node) htmx.Node
- func FileInputWarning(p FileInputProps, children ...htmx.Node) htmx.Node
- func Filter(props FilterFormProps, children ...htmx.Node) htmx.Node
- func FilterButton(props FilterButtonProps, _ ...htmx.Node) htmx.Node
- func FilterForm(props FilterFormProps, children ...htmx.Node) htmx.Node
- func FilterResetButton(props FilterResetButtonProps, _ ...htmx.Node) htmx.Node
- func FloatingLabel(props LabelProps, children ...htmx.Node) htmx.Node
- func Form(p FormProps, children ...htmx.Node) htmx.Node
- func FormControl(p FormControlProps, children ...htmx.Node) htmx.Node
- func FormControlLabel(props FormControlLabelProps, children ...htmx.Node) htmx.Node
- func FormControlLabelAltText(props FormControlLabelAltTextProps, children ...htmx.Node) htmx.Node
- func FormControlLabelText(props FormControlLabelTextProps, children ...htmx.Node) htmx.Node
- func Label(props LabelProps, children ...htmx.Node) htmx.Node
- func LabelInput(props LabelProps, children ...htmx.Node) htmx.Node
- func LabelSelect(props LabelProps, children ...htmx.Node) htmx.Node
- func LabelText(props LabelProps, children ...htmx.Node) htmx.Node
- func Legend(p LegendProps, children ...htmx.Node) htmx.Node
- func Option(p OptionProps, children ...htmx.Node) htmx.Node
- func Radio(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioAccent(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioError(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioInfo(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioPrimary(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioSecondary(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioSuccess(p RadioProps, children ...htmx.Node) htmx.Node
- func RadioWarning(p RadioProps, children ...htmx.Node) htmx.Node
- func Select(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectAccent(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectBordered(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectDanger(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectError(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectGhost(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectInfo(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectPrimary(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectSecondary(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectSuccess(p SelectProps, children ...htmx.Node) htmx.Node
- func SelectWarning(p SelectProps, children ...htmx.Node) htmx.Node
- func TextInput(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputAccent(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputBordered(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputError(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputGhost(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputPrimary(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputSecondary(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputSuccess(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputWarning(p TextInputProps, children ...htmx.Node) htmx.Node
- func TextInputWithIcon(p TextInputProps, children ...htmx.Node) htmx.Node
- func Textarea(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaBordered(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaError(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaGhost(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaPrimary(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaSecondary(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaSuccess(p TextareaProps, children ...htmx.Node) htmx.Node
- func TextareaWarning(p TextareaProps, children ...htmx.Node) htmx.Node
- func Toggle(p ToggleProps, children ...htmx.Node) htmx.Node
- func ToggleError(p ToggleProps, children ...htmx.Node) htmx.Node
- func ToggleInfo(p ToggleProps, children ...htmx.Node) htmx.Node
- func ToggleLabel(p ToggleProps, children ...htmx.Node) htmx.Node
- func ToggleSuccess(p ToggleProps, children ...htmx.Node) htmx.Node
- func ToggleWarning(p ToggleProps, children ...htmx.Node) htmx.Node
- func ValidatorHint(props ValidatorHintProps, children ...htmx.Node) htmx.Node
- type CheckboxProps
- type DatalistProps
- type DateInputProps
- type FieldsetProps
- type FileInputProps
- type FilterButtonProps
- type FilterFormProps
- type FilterProps
- type FilterResetButtonProps
- type FormControlLabelAltTextProps
- type FormControlLabelProps
- type FormControlLabelTextProps
- type FormControlProps
- type FormProps
- type LabelProps
- type LegendProps
- type OptionProps
- type RadioProps
- type SelectProps
- type TextInputProps
- type TextareaProps
- type ToggleProps
- type ValidatorHintProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Checkbox ¶
func Checkbox(p CheckboxProps, children ...htmx.Node) htmx.Node
Checkbox generates a checkbox element based on the provided properties.
func CheckboxError ¶
func CheckboxError(p CheckboxProps, children ...htmx.Node) htmx.Node
CheckboxError is a component that displays an error checkbox.
func CheckboxInfo ¶
func CheckboxInfo(p CheckboxProps, children ...htmx.Node) htmx.Node
CheckboxInfo is a component that displays an info checkbox.
func CheckboxPrimary ¶
func CheckboxPrimary(p CheckboxProps, children ...htmx.Node) htmx.Node
CheckboxPrimary is a component that displays a primary checkbox.
func CheckboxSuccess ¶
func CheckboxSuccess(p CheckboxProps, children ...htmx.Node) htmx.Node
CheckboxSuccess is a component that displays a success checkbox.
func CheckboxWarning ¶
func CheckboxWarning(p CheckboxProps, children ...htmx.Node) htmx.Node
CheckboxWarning is a component that displays a warning checkbox.
func Datalist ¶
func Datalist(props DatalistProps, children ...htmx.Node) htmx.Node
Datalist is a component that displays a datalist.
func DateInput ¶ added in v0.5.4
func DateInput(p DateInputProps, children ...htmx.Node) htmx.Node
DateInput returns a date input element based on the provided properties.
func Fieldset ¶ added in v0.5.3
func Fieldset(p FieldsetProps, children ...htmx.Node) htmx.Node
Fieldset is a component for the htmx fieldset extension.
func FileInput ¶
func FileInput(p FileInputProps, children ...htmx.Node) htmx.Node
File generates a file input element based on the provided properties.
func FileInputAccent ¶
func FileInputAccent(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputAccent is a component that displays an accent file input.
func FileInputBordered ¶
func FileInputBordered(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputBordered is a component that displays a bordered file input.
func FileInputError ¶
func FileInputError(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputError is a component that displays an error file input.
func FileInputGhost ¶
func FileInputGhost(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputGhost is a component that displays a ghost file input.
func FileInputInfo ¶
func FileInputInfo(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputInfo is a component that displays an info file input.
func FileInputPrimary ¶
func FileInputPrimary(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputPrimary is a component that displays a primary file input.
func FileInputSecondary ¶
func FileInputSecondary(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputSecondary is a component that displays a secondary file input.
func FileInputSuccess ¶
func FileInputSuccess(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputSuccess is a component that displays a success file input.
func FileInputWarning ¶
func FileInputWarning(p FileInputProps, children ...htmx.Node) htmx.Node
FileInputWarning is a component that displays a warning file input.
func Filter ¶
func Filter(props FilterFormProps, children ...htmx.Node) htmx.Node
Filter is a component that renders a filter element.
func FilterButton ¶
func FilterButton(props FilterButtonProps, _ ...htmx.Node) htmx.Node
FilterButton is a component that renders a filter button.
func FilterForm ¶
func FilterForm(props FilterFormProps, children ...htmx.Node) htmx.Node
FilterForm is a component that renders a filter element.
func FilterResetButton ¶
func FilterResetButton(props FilterResetButtonProps, _ ...htmx.Node) htmx.Node
FilterResetButton is a component that renders a filter reset button.
func FloatingLabel ¶
func FloatingLabel(props LabelProps, children ...htmx.Node) htmx.Node
FloatingLabel is a component that renders a label element with a floating effect.
func Form ¶
Form returns a form element based on the provided properties. <form class="peer h-5 w-8"></form>.
func FormControl ¶
func FormControl(p FormControlProps, children ...htmx.Node) htmx.Node
FormControl generates a form control element based on the provided properties.
func FormControlLabel ¶
func FormControlLabel(props FormControlLabelProps, children ...htmx.Node) htmx.Node
FormControlLabel generates a form control label element based on the provided properties.
func FormControlLabelAltText ¶
func FormControlLabelAltText(props FormControlLabelAltTextProps, children ...htmx.Node) htmx.Node
FormControlLabelAltText generates a form control label alt text element based on the provided properties.
func FormControlLabelText ¶
func FormControlLabelText(props FormControlLabelTextProps, children ...htmx.Node) htmx.Node
FormControlLabelText generates a form control label text element based on the provided properties.
func Label ¶
func Label(props LabelProps, children ...htmx.Node) htmx.Node
Label is a component that renders a label element.
func LabelInput ¶
func LabelInput(props LabelProps, children ...htmx.Node) htmx.Node
LabelInput is a component that renders a label element with an input.
func LabelSelect ¶
func LabelSelect(props LabelProps, children ...htmx.Node) htmx.Node
LabelSelect is a component that renders a label element for a select input.
func LabelText ¶
func LabelText(props LabelProps, children ...htmx.Node) htmx.Node
LabelText is a component that renders a label element with text styling.
func Legend ¶ added in v0.5.3
func Legend(p LegendProps, children ...htmx.Node) htmx.Node
Legend is a component for the htmx legend extension.
func Radio ¶
func Radio(p RadioProps, children ...htmx.Node) htmx.Node
Radio generates a radio element based on the provided properties.
func RadioAccent ¶
func RadioAccent(p RadioProps, children ...htmx.Node) htmx.Node
RadioAccent component represents an accent radio element.
func RadioError ¶
func RadioError(p RadioProps, children ...htmx.Node) htmx.Node
RadioError component represents an error radio element.
func RadioInfo ¶
func RadioInfo(p RadioProps, children ...htmx.Node) htmx.Node
RadioInfo component represents a info radio element.
func RadioPrimary ¶
func RadioPrimary(p RadioProps, children ...htmx.Node) htmx.Node
RadioPrimary component represents a primary radio element.
func RadioSecondary ¶
func RadioSecondary(p RadioProps, children ...htmx.Node) htmx.Node
RadioSecondary component represents a secondary radio element.
func RadioSuccess ¶
func RadioSuccess(p RadioProps, children ...htmx.Node) htmx.Node
RadioSuccess component represents a successful radio element.
func RadioWarning ¶
func RadioWarning(p RadioProps, children ...htmx.Node) htmx.Node
RadioWarning component represents a warning radio element.
func SelectAccent ¶
func SelectAccent(p SelectProps, children ...htmx.Node) htmx.Node
SelectAccent ...
func SelectBordered ¶
func SelectBordered(p SelectProps, children ...htmx.Node) htmx.Node
SelectBordered ...
func SelectDanger ¶
func SelectDanger(p SelectProps, children ...htmx.Node) htmx.Node
SelectWarning ...
func SelectPrimary ¶
func SelectPrimary(p SelectProps, children ...htmx.Node) htmx.Node
SelectPrimary ...
func SelectSecondary ¶
func SelectSecondary(p SelectProps, children ...htmx.Node) htmx.Node
SelectSecondary ...
func SelectSuccess ¶
func SelectSuccess(p SelectProps, children ...htmx.Node) htmx.Node
SelectSuccess ...
func SelectWarning ¶
func SelectWarning(p SelectProps, children ...htmx.Node) htmx.Node
SelectWarning ...
func TextInput ¶
func TextInput(p TextInputProps, children ...htmx.Node) htmx.Node
TextInput returns a text input element based on the provided properties.
func TextInputAccent ¶
func TextInputAccent(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputAccent is a component that displays an accent text input.
func TextInputBordered ¶
func TextInputBordered(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputBordered is a component that displays a bordered text input.
func TextInputError ¶
func TextInputError(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputError is a component that displays an error text input.
func TextInputGhost ¶
func TextInputGhost(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputGhost is a component that displays a ghost text input.
func TextInputPrimary ¶
func TextInputPrimary(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputPrimary is a component that displays a primary text input.
func TextInputSecondary ¶
func TextInputSecondary(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputSecondary is a component that displays a secondary text input.
func TextInputSuccess ¶
func TextInputSuccess(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputSuccess is a component that displays a success text input.
func TextInputWarning ¶
func TextInputWarning(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputWarning is a component that displays a warning text input.
func TextInputWithIcon ¶
func TextInputWithIcon(p TextInputProps, children ...htmx.Node) htmx.Node
TextInputWithIcon is a component that displays a text input with an icon.
func Textarea ¶
func Textarea(p TextareaProps, children ...htmx.Node) htmx.Node
Textarea is a textarea component.
func TextareaBordered ¶
func TextareaBordered(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaBordered is a textarea component with a border.
func TextareaError ¶
func TextareaError(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaError is a textarea component with an error border.
func TextareaGhost ¶
func TextareaGhost(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaGhost is a textarea component with a ghost border.
func TextareaPrimary ¶
func TextareaPrimary(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaPrimary is a textarea component with a primary border.
func TextareaSecondary ¶
func TextareaSecondary(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaSecondary is a textarea component with a secondary border.
func TextareaSuccess ¶
func TextareaSuccess(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaSuccess is a textarea component with a success border.
func TextareaWarning ¶
func TextareaWarning(p TextareaProps, children ...htmx.Node) htmx.Node
TextareaWarning is a textarea component with a warning border.
func Toggle ¶
func Toggle(p ToggleProps, children ...htmx.Node) htmx.Node
Toggle returns a toggle element based on the provided properties.
func ToggleError ¶
func ToggleError(p ToggleProps, children ...htmx.Node) htmx.Node
ToggleError is a component that displays an error toggle.
func ToggleInfo ¶
func ToggleInfo(p ToggleProps, children ...htmx.Node) htmx.Node
ToggleInfo is a component that displays an info toggle.
func ToggleLabel ¶
func ToggleLabel(p ToggleProps, children ...htmx.Node) htmx.Node
ToggleLabel is a component that displays a label for a toggle.
func ToggleSuccess ¶
func ToggleSuccess(p ToggleProps, children ...htmx.Node) htmx.Node
ToggleSuccess is a component that displays a success toggle.
func ToggleWarning ¶
func ToggleWarning(p ToggleProps, children ...htmx.Node) htmx.Node
ToggleWarning is a component that displays a warning toggle.
func ValidatorHint ¶
func ValidatorHint(props ValidatorHintProps, children ...htmx.Node) htmx.Node
ValidatorHint is a component that renders a hint for a validator.
Types ¶
type CheckboxProps ¶
type CheckboxProps struct {
// Name is the name of the checkbox element.
Name string
// Value is the value of the checkbox element.
Value string
// Checked indicates whether the checkbox is checked.
Checked bool
// Disabled indicates whether the checkbox is disabled.
Disabled bool
// ClassNames allows for additional CSS classes to be applied to the checkbox.
htmx.ClassNames
}
CheckboxProps represents the properties for a checkbox element.
type DatalistProps ¶
type DatalistProps struct {
// ID is the id of the datalist
ID string
// Target is the target of the datalist
Target string
// URL is the url of the datalist
URL string
// ClassNames is a map of class names to conditionally add to the component
ClassNames htmx.ClassNames
// Name is the name of the datalist
Name string
// Placeholder is the placeholder of the datalist
Placeholder string
// Disabled is whether the datalist is disabled
Disabled bool
// Indicator is the indicator of the datalist
Indicator string
// Error is the error of the datalist
Error error
}
DatalistProps is the type of the props for the Datalist component.
type DateInputProps ¶ added in v0.5.4
type DateInputProps struct {
// Validator indicates whether the input should have validation.
Validator bool
htmx.ClassNames
}
DateInputProps represents the properties for a date input element.
type FieldsetProps ¶ added in v0.5.3
type FieldsetProps struct {
ClassNames htmx.ClassNames // The class names for the fieldset element.
}
FieldsetProps contains the properties for the fieldset component.
type FileInputProps ¶
type FileInputProps struct {
ClassNames htmx.ClassNames
Disabled bool
}
FileInputProps represents the properties for a file input element.
type FilterButtonProps ¶
type FilterButtonProps struct {
Name string
Label string
htmx.ClassNames
}
FilterButton is a component that renders a filter button.
type FilterFormProps ¶
type FilterFormProps struct {
htmx.ClassNames
}
FilterFormProps is a struct that contains the properties of the Filter component.
type FilterProps ¶
type FilterProps struct {
htmx.ClassNames
}
FilterProps is a struct that contains the properties of the Filter component.
type FilterResetButtonProps ¶
type FilterResetButtonProps struct {
Value string
htmx.ClassNames
}
FilterResetButtonProps is a struct that contains the properties of the FilterReset component.
type FormControlLabelAltTextProps ¶
type FormControlLabelAltTextProps struct {
ClassNames htmx.ClassNames // The class names for the form control label alt text element.
}
FormControlLabelAltTextProps represents the properties for a form control label alt text element.
type FormControlLabelProps ¶
type FormControlLabelProps struct {
ClassNames htmx.ClassNames // The class names for the form control label element.
}
FormControlLabelProps represents the properties for a form control label element.
type FormControlLabelTextProps ¶
type FormControlLabelTextProps struct {
ClassNames htmx.ClassNames // The class names for the form control label text element.
}
FormControlLabelTextProps represents the properties for a form control label text element.
type FormControlProps ¶
type FormControlProps struct {
ClassNames htmx.ClassNames // The class names for the form control element.
}
FormControlProps represents the properties for a form control element.
type FormProps ¶
type FormProps struct {
ClassNames htmx.ClassNames // The class names for the form element.
}
FormProps represents the properties for a form element.
type LabelProps ¶
type LabelProps struct {
htmx.ClassNames
}
LabelProps is a struct that contains the properties of the Label component.
type LegendProps ¶ added in v0.5.3
type LegendProps struct {
ClassNames htmx.ClassNames // The class names for the legend element.
}
LegendProps contains the properties for the legend component.
type OptionProps ¶
type OptionProps struct {
ClassNames htmx.ClassNames
Value string
Selected bool
Disabled bool
}
OptionProps ...
type RadioProps ¶
type RadioProps struct {
Name string // The name of the radio element.
Value string // The value of the radio element.
Checked bool // Whether the radio element is checked.
Disabled bool
Error error
htmx.ClassNames // The class names for the radio element.
}
RadioProps represents the properties for a radio element.
type SelectProps ¶
type SelectProps struct {
// ClassNames is a map of class names.
ClassNames htmx.ClassNames
// Validator indicates whether the input should have validation.
Validator bool
// Disabled is disabling the select.
Disabled bool
}
SelectProps ...
type TextInputProps ¶
type TextInputProps struct {
Disabled bool // Whether the text input element is disabled.
Error error // The error message of the text input element.
Icon htmx.Node // The icon of the text input element.
Name string // The name of the text input element.
Placeholder string // The placeholder of the text input element.
Required bool // Whether the text input element is required.
Type string // The type of the text input element.
Validator bool // Indicates whether the input should have validation.
Value string // The value of the text input element.
htmx.ClassNames
}
TextInputProps represents the properties for a text input element.
type TextareaProps ¶
type TextareaProps struct {
Placeholder string
Disabled bool
Name string
Value string
// Validator indicates whether the input should have validation.
Validator bool
htmx.ClassNames
}
TextareaProps are the properties for the textarea component.
type ToggleProps ¶
type ToggleProps struct {
ClassNames htmx.ClassNames // The class names for the toggle element.
Name string // The name of the toggle element.
Value string // The value of the toggle element.
Disabled bool // Whether the toggle element is disabled.
Checked bool // Whether the toggle element is checked.
Validator bool // Whether the toggle element is a validator.
}
ToggleProps represents the properties for a toggle element.
type ValidatorHintProps ¶
type ValidatorHintProps struct {
htmx.ClassNames
}
ValidatorHintProps is a struct that contains the properties of the ValidatorHint component.