component

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 6, 2025 License: AGPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SizeSm = size{"sm"}
	SizeMd = size{"md"}
	SizeLg = size{"lg"}

	ColorPrimary   = color{"primary"}
	ColorSecondary = color{"secondary"}
	ColorAccent    = color{"accent"}
	ColorNeutral   = color{"neutral"}
	ColorInfo      = color{"info"}
	ColorSuccess   = color{"success"}
	ColorWarning   = color{"warning"}
	ColorError     = color{"error"}

	DropdownPositionTop    = dropdownPosition{"top"}
	DropdownPositionBottom = dropdownPosition{"bottom"}
	DropdownPositionLeft   = dropdownPosition{"left"}
	DropdownPositionRight  = dropdownPosition{"right"}

	InputTypeText     = inputType{"text"}
	InputTypePassword = inputType{"password"}
	InputTypeEmail    = inputType{"email"}
	InputTypeNumber   = inputType{"number"}
	InputTypeTel      = inputType{"tel"}
	InputTypeUrl      = inputType{"url"}
)

Functions

func BText 

func BText(text string) nodx.Node

BText is a convenience function to create a B element with a simple text node as its child.

func CardBox 

func CardBox(params CardBoxParams) nodx.Node

CardBox renders a card box with the given children.

func CardBoxSimple 

func CardBoxSimple(children ...nodx.Node) nodx.Node

CardBoxSimple is the same as CardBox, but with a less verbose api and default props. It renders a card box with the given children.

func CardBoxSimpleBgBase200 

func CardBoxSimpleBgBase200(children ...nodx.Node) nodx.Node

CardBoxSimpleBgBase200 is the same as CardBox, but with a less verbose api and default props. It renders a card box with the given children.

func CardBoxSimpleBgBase300 

func CardBoxSimpleBgBase300(children ...nodx.Node) nodx.Node

CardBoxSimpleBgBase300 is the same as CardBox, but with a less verbose api and default props. It renders a card box with the given children.

func ChangeThemeButton 

func ChangeThemeButton(params ChangeThemeButtonParams) nodx.Node

func CopyButtonLg 

func CopyButtonLg(textToCopy string) nodx.Node

CopyButtonLg is a large copy button.

func CopyButtonMd 

func CopyButtonMd(textToCopy string) nodx.Node

CopyButtonMd is a medium copy button.

func CopyButtonSm 

func CopyButtonSm(textToCopy string) nodx.Node

CopyButtonSm is a small copy button.

func EmptyResults 

func EmptyResults(params EmptyResultsParams) nodx.Node

func EmptyResultsTr 

func EmptyResultsTr(params EmptyResultsParams) nodx.Node

func H1 

func H1(children ...nodx.Node) nodx.Node

func H1Text 

func H1Text(text string) nodx.Node

H1Text is a convenience function to create an H1 element with a simple text node as its child.

func H2 

func H2(children ...nodx.Node) nodx.Node

func H2Text 

func H2Text(text string) nodx.Node

H2Text is a convenience function to create an H2 element with a simple text node as its child.

func H3 

func H3(children ...nodx.Node) nodx.Node

func H3Text 

func H3Text(text string) nodx.Node

H3Text is a convenience function to create an H3 element with a simple text node as its child.

func H4 

func H4(children ...nodx.Node) nodx.Node

func H4Text 

func H4Text(text string) nodx.Node

H4Text is a convenience function to create an H4 element with a simple text node as its child.

func H5 

func H5(children ...nodx.Node) nodx.Node

func H5Text 

func H5Text(text string) nodx.Node

H5Text is a convenience function to create an H5 element with a simple text node as its child.

func H6 

func H6(children ...nodx.Node) nodx.Node

func H6Text 

func H6Text(text string) nodx.Node

H6Text is a convenience function to create an H6 element with a simple text node as its child.

func HealthStatusPing 

func HealthStatusPing(
	testOk sql.NullBool, testError sql.NullString, lastTestAt sql.NullTime,
) nodx.Node

func HelpButtonModal 

func HelpButtonModal(params HelpButtonModalParams) nodx.Node

func HxLoadingLg 

func HxLoadingLg(id ...string) nodx.Node

HxLoadingLg returns a large loading indicator.

func HxLoadingMd 

func HxLoadingMd(id ...string) nodx.Node

HxLoadingMd returns a loading indicator.

func HxLoadingSm 

func HxLoadingSm(id ...string) nodx.Node

HxLoadingSm returns a small loading indicator.

func InputControl 

func InputControl(params InputControlParams) nodx.Node

func IsActivePing 

func IsActivePing(isActive bool) nodx.Node

func Logotype 

func Logotype() nodx.Node

func OptionsDropdown 

func OptionsDropdown(children ...nodx.Node) nodx.Node

func OptionsDropdownA 

func OptionsDropdownA(children ...nodx.Node) nodx.Node

func OptionsDropdownButton 

func OptionsDropdownButton(children ...nodx.Node) nodx.Node

func PGVersionSelectOptions 

func PGVersionSelectOptions(selectedVersion sql.NullString) nodx.Node

func PText 

func PText(text string) nodx.Node

PText is a convenience function to create a P element with a simple text node as its child.

func Ping 

func Ping(color color) nodx.Node

func PrettyDestinationName 

func PrettyDestinationName(
	isLocal bool, destinationName sql.NullString,
) nodx.Node

func PrettyFileSize 

func PrettyFileSize(
	size sql.NullInt64,
) nodx.Node

PrettyFileSize pretty prints a file size (in bytes) to a human-readable format. If the size is not valid, it returns an empty string.

e.g. 1024 -> 1 KB

func RenderableGroup 

func RenderableGroup(children []nodx.Node) nodx.Node

RenderableGroup renders a group of nodes without a parent element.

This is because nodx.Group() cannot be directly rendered and needs to be wrapped in a parent element.

func SelectControl 

func SelectControl(params SelectControlParams) nodx.Node

func SkeletonTr 

func SkeletonTr(rows int) nodx.Node

func SpanText 

func SpanText(text string) nodx.Node

SpanText is a convenience function to create a Span element with a simple text node as its child.

func SpinnerContainerLg 

func SpinnerContainerLg(height ...string) nodx.Node

func SpinnerContainerMd 

func SpinnerContainerMd(height ...string) nodx.Node

func SpinnerContainerSm 

func SpinnerContainerSm(height ...string) nodx.Node

func SpinnerLg 

func SpinnerLg() nodx.Node

func SpinnerMd 

func SpinnerMd() nodx.Node

func SpinnerSm 

func SpinnerSm() nodx.Node

func StarOnGithub 

func StarOnGithub(size size) nodx.Node

func StatusBadge 

func StatusBadge(status string) nodx.Node

func SupportProjectAnchor 

func SupportProjectAnchor(text string) nodx.Node

func SupportProjectButton 

func SupportProjectButton(size size) nodx.Node

func SupportProjectSponsors 

func SupportProjectSponsors() nodx.Node

func TextareaControl 

func TextareaControl(params TextareaControlParams) nodx.Node

Types

type CardBoxParams 

type CardBoxParams struct {
	Class    string
	BgBase   bgBase
	Children []nodx.Node
}

type ChangeThemeButtonParams 

type ChangeThemeButtonParams struct {
	Position    dropdownPosition
	AlignsToEnd bool
	Size        size
}

type EmptyResultsParams 

type EmptyResultsParams struct {
	Title    string
	Subtitle string
}

type HelpButtonModalParams 

type HelpButtonModalParams struct {
	ModalTitle string
	ModalSize  size
	Children   []nodx.Node
}

type InputControlParams 

type InputControlParams struct {
	ID                 string
	Name               string
	Label              string
	Placeholder        string
	Required           bool
	Type               inputType
	HelpText           string
	Color              color
	AutoComplete       string
	Pattern            string
	Children           []nodx.Node
	HelpButtonChildren []nodx.Node
}

type ModalParams 

type ModalParams struct {
	// ID is the ID of the modal dialog. If empty, a random ID will be generated.
	ID string
	// Content is the content of the modal dialog.
	Content []nodx.Node
	// Size is the size of the modal dialog.
	// Can be "sm", "md", and "lg".
	// The default is "md".
	Size size
	// Title is the title of the modal dialog.
	// If you need more than a string, use TitleNode instead.
	Title string
	// TitleNode is the title of the modal dialog.
	// If you need only a string, use Title instead.
	TitleNode nodx.Node
	// HTMXIndicator is an optional ID of an HTMX indicator that
	// should be inserted in the modal header.
	HTMXIndicator string
}

ModalParams are the props for the Modal component.

type ModalResult 

type ModalResult struct {
	// HTML is the modal dialog nodx.
	HTML nodx.Node
	// OpenerAttr is the attribute to add to the element that opens the modal dialog.
	OpenerAttr nodx.Node
}

ModalResult is the result of creating a modal dialog. 

func Modal(params ModalParams) ModalResult

Modal renders a modal dialog.

func SupportProjectModal 

func SupportProjectModal() ModalResult

type SelectControlParams 

type SelectControlParams struct {
	ID                 string
	Name               string
	Label              string
	Placeholder        string
	Required           bool
	HelpText           string
	Color              color
	AutoComplete       string
	Children           []nodx.Node
	HelpButtonChildren []nodx.Node
}

type TextareaControlParams 

type TextareaControlParams struct {
	ID                 string
	Name               string
	Label              string
	Placeholder        string
	Required           bool
	HelpText           string
	Color              color
	AutoComplete       string
	Pattern            string
	Children           []nodx.Node
	HelpButtonChildren []nodx.Node
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.