Documentation
¶
Overview ¶
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
templ: version: v0.3.1070
Index ¶
- Constants
- func Accordion(componentSettings AccordionSettings) templ.Component
- func Alert(componentSettings AlertSettings) templ.Component
- func Chart(componentSettings ChartSettings) templ.Component
- func CloakLoading(componentSettings CloakLoadingSettings) templ.Component
- func CollapsibleText(componentSettings CollapsibleTextSettings) templ.Component
- func ConfirmDialog(componentSettings ConfirmationDialogSettings) templ.Component
- func CriticalDialog(componentSettings ConfirmationDialogSettings) templ.Component
- func DeleteDialog(componentSettings ConfirmationDialogSettings) templ.Component
- func HeaderBlock(componentSettings HeaderBlockSettings) templ.Component
- func HeaderIcon(componentSettings HeaderIconSettings) templ.Component
- func LoadingOverlay(componentSettings LoadingOverlaySettings) templ.Component
- func Modal(componentSettings ModalSettings) templ.Component
- func Tag(componentSettings TagSettings) templ.Component
- func Toast(componentSettings ToastSettings) templ.Component
- func WarningDialog(componentSettings ConfirmationDialogSettings) templ.Component
- type AccordionItemSettings
- type AccordionSettings
- type AlertSettings
- type ChartAreaFillStyle
- type ChartCartesianSettings
- type ChartCenterLabelDisplayMode
- type ChartCenterLabelSize
- type ChartDotShape
- type ChartGaugeBandSettings
- type ChartGaugeSettings
- type ChartGaugeTickPosition
- type ChartLegendAlignment
- type ChartLegendDisplayMode
- type ChartLegendPosition
- type ChartLegendSettings
- type ChartLineDashStyle
- type ChartMarkerDisplayMode
- type ChartParliamentSettings
- type ChartProgressSettings
- type ChartProgressThresholdSettings
- type ChartScaleType
- type ChartSeriesSettings
- type ChartSettings
- type ChartSliceSettings
- type ChartStackMode
- type ChartSunburstSettings
- type ChartTooltipSettings
- type ChartType
- type ChartWaffleCellShape
- type ChartWaffleSettings
- type ChartXAxisSettings
- type ChartYAxisPosition
- type ChartYAxisSettings
- type CloakLoadingSettings
- type CollapsibleTextSettings
- type ConfirmationDialogSettings
- type HeaderBlockSettings
- type HeaderIconSettings
- type LoadingOverlaySettings
- type ModalSettings
- type TagSettings
- type ToastSettings
Constants ¶
View Source
const ( AlertVariationSuccess string = "success" AlertVariationWarning string = "warning" AlertVariationError string = "error" AlertVariationInfo string = "info" AlertSizeXs string = "xs" AlertSizeSm string = "sm" AlertSizeMd string = "md" AlertSizeLg string = "lg" AlertSizeXl string = "xl" )
View Source
const ( ChartProgressSizeXs string = "xs" ChartProgressSizeSm string = "sm" ChartProgressSizeMd string = "md" )
View Source
const ( CloakLoadingIconSizeXs string = "2rem" CloakLoadingIconSizeSm string = "3rem" CloakLoadingIconSizeMd string = "5rem" CloakLoadingIconSizeLg string = "7rem" CloakLoadingTextSizeXs string = "0.75rem" CloakLoadingTextSizeSm string = "1rem" CloakLoadingTextSizeMd string = "1.25rem" CloakLoadingTextSizeLg string = "1.5rem" CloakLoadingAnimationNameBounce string = "bounce" CloakLoadingAnimationNamePing string = "ping" CloakLoadingAnimationNamePulse string = "pulse" CloakLoadingAnimationNameSpin string = "spin" )
View Source
const ( CollapsibleTextSizeXs string = "xs" CollapsibleTextSizeSm string = "sm" CollapsibleTextSizeMd string = "md" CollapsibleTextSizeLg string = "lg" )
View Source
const ( ConfirmationDialogSizeXs string = "xs" ConfirmationDialogSizeSm string = "sm" ConfirmationDialogSizeMd string = "md" ConfirmationDialogSizeLg string = "lg" ConfirmationDialogSizeXl string = "xl" ConfirmationDialogSizeXxl string = "xxl" )
View Source
const ( HeaderBlockHeadingLevelOne string = "1" HeaderBlockHeadingLevelTwo string = "2" HeaderSizeXs string = "xs" HeaderSizeSm string = "sm" HeaderSizeMd string = "md" HeaderSizeLg string = "lg" HeaderSizeXl string = "xl" )
View Source
const ( HeaderIconPositionLeft string = "left" HeaderIconPositionTop string = "top" )
View Source
const ( LoadingOverlayIconSizeXs string = "text-2xl" LoadingOverlayIconSizeSm string = "text-3xl" LoadingOverlayIconSizeMd string = "text-5xl" LoadingOverlayIconSizeLg string = "text-7xl" LoadingOverlayAnimationNameBounce string = "bounce" LoadingOverlayAnimationNamePing string = "ping" LoadingOverlayAnimationNamePulse string = "pulse" LoadingOverlayAnimationNameSpin string = "spin" )
View Source
const ( ModalSizeXs string = "xs" ModalSizeSm string = "sm" ModalSizeMd string = "md" ModalSizeLg string = "lg" ModalSizeXl string = "xl" ModalSizeXxl string = "xxl" ModalSizeFull string = "full" )
Variables ¶
This section is empty.
Functions ¶
func Accordion ¶
func Accordion(componentSettings AccordionSettings) templ.Component
func Alert ¶ added in v0.1.4
func Alert(componentSettings AlertSettings) templ.Component
func Chart ¶ added in v0.2.9
func Chart(componentSettings ChartSettings) templ.Component
func CloakLoading ¶ added in v0.0.8
func CloakLoading(componentSettings CloakLoadingSettings) templ.Component
func CollapsibleText ¶ added in v0.3.2
func CollapsibleText(componentSettings CollapsibleTextSettings) templ.Component
func ConfirmDialog ¶ added in v0.2.2
func ConfirmDialog(componentSettings ConfirmationDialogSettings) templ.Component
func CriticalDialog ¶ added in v0.2.2
func CriticalDialog(componentSettings ConfirmationDialogSettings) templ.Component
func DeleteDialog ¶ added in v0.2.2
func DeleteDialog(componentSettings ConfirmationDialogSettings) templ.Component
func HeaderBlock ¶ added in v0.2.2
func HeaderBlock(componentSettings HeaderBlockSettings) templ.Component
func HeaderIcon ¶ added in v0.2.2
func HeaderIcon(componentSettings HeaderIconSettings) templ.Component
func LoadingOverlay ¶ added in v0.0.6
func LoadingOverlay(componentSettings LoadingOverlaySettings) templ.Component
func Modal ¶ added in v0.0.9
func Modal(componentSettings ModalSettings) templ.Component
func Tag ¶
func Tag(componentSettings TagSettings) templ.Component
func Toast ¶ added in v0.0.5
func Toast(componentSettings ToastSettings) templ.Component
func WarningDialog ¶ added in v0.2.2
func WarningDialog(componentSettings ConfirmationDialogSettings) templ.Component
Types ¶
type AccordionItemSettings ¶
type AccordionSettings ¶
type AccordionSettings struct {
Items []AccordionItemSettings
// OptionalFields
BackgroundColor string
BorderColor string
BorderRadius string
ContentBackgroundColor string
ContentPaddingSize string
IsFirstItemOpen bool
IsSingleOpen bool
OpenBackgroundColor string
PaddingSize string
TextCase string
TitleColor string
}
type AlertSettings ¶ added in v0.1.4
type AlertSettings struct {
// OptionalFields
ContentHtml templ.Component
Title string
TitleOneWayStatePath string
TitleLeftIcon string
TitleLeftIconTwoWayStatePath string
TitleRightIcon string
TitleRightIconTwoWayStatePath string
Description string
DescriptionOneWayStatePath string
DescriptionLeftIcon string
DescriptionLeftIconTwoWayStatePath string
DescriptionRightIcon string
DescriptionRightIconTwoWayStatePath string
Variation string
Size string
MaxWidth string
BackgroundColor string
TextColor string
TextTitleColor string
TextDescriptionColor string
RingColor string
RingThickness string
BorderRadius string
ShadowSize string
IsCloseable bool
IsCloseableOneWayStatePath string
CloseIconBackgroundColor string
CloseIconTextColor string
OnCloseFunc string
DisplayTimeoutSeconds int
OnTimeoutFunc string
}
type ChartAreaFillStyle ¶ added in v0.2.9
type ChartAreaFillStyle string
const ( ChartAreaFillStyleGradient ChartAreaFillStyle = "gradient" ChartAreaFillStyleNone ChartAreaFillStyle = "none" ChartAreaFillStyleSolid ChartAreaFillStyle = "solid" )
type ChartCartesianSettings ¶ added in v0.2.9
type ChartCartesianSettings struct {
// OptionalFields
AreaFillStyle ChartAreaFillStyle
MarkerDisplayMode ChartMarkerDisplayMode
StackMode ChartStackMode
YAxis ChartYAxisSettings
}
type ChartCenterLabelDisplayMode ¶ added in v0.3.2
type ChartCenterLabelDisplayMode string
const ( ChartCenterLabelDisplayModeAlways ChartCenterLabelDisplayMode = "always" ChartCenterLabelDisplayModeHidden ChartCenterLabelDisplayMode = "hidden" ChartCenterLabelDisplayModeHover ChartCenterLabelDisplayMode = "hover" )
type ChartCenterLabelSize ¶ added in v0.3.2
type ChartCenterLabelSize string
const ( ChartCenterLabelSizeXs ChartCenterLabelSize = "xs" ChartCenterLabelSizeSm ChartCenterLabelSize = "sm" ChartCenterLabelSizeMd ChartCenterLabelSize = "md" ChartCenterLabelSizeLg ChartCenterLabelSize = "lg" ChartCenterLabelSizeXl ChartCenterLabelSize = "xl" )
type ChartDotShape ¶ added in v0.3.2
type ChartDotShape string
const ( ChartDotShapeCircle ChartDotShape = "circle" ChartDotShapeCross ChartDotShape = "cross" ChartDotShapeDiamond ChartDotShape = "diamond" ChartDotShapeSquare ChartDotShape = "square" ChartDotShapeTriangleDown ChartDotShape = "triangleDown" ChartDotShapeTriangleUp ChartDotShape = "triangleUp" )
type ChartGaugeBandSettings ¶ added in v0.3.2
type ChartGaugeSettings ¶ added in v0.3.2
type ChartGaugeSettings struct {
// OptionalFields
ArcThickness float64
Bands []ChartGaugeBandSettings
IsSemicircle bool
Label string
LabelColor string
LabelTextSize float64
MaxValue float64
MinValue float64
NeedleColor string
NeedleLength float64
NeedleThickness float64
PivotRadius float64
TextOffset float64
TickColor string
TickCount uint
TickLabelColor string
TickPosition ChartGaugeTickPosition
TrackColor string
Value float64
ValueColor string
ValueTextSize float64
}
type ChartGaugeTickPosition ¶ added in v0.3.2
type ChartGaugeTickPosition string
const ( ChartGaugeTickPositionInside ChartGaugeTickPosition = "inside" ChartGaugeTickPositionOutside ChartGaugeTickPosition = "outside" )
type ChartLegendAlignment ¶ added in v0.2.9
type ChartLegendAlignment string
const ( ChartLegendAlignmentCenter ChartLegendAlignment = "center" ChartLegendAlignmentEnd ChartLegendAlignment = "end" ChartLegendAlignmentStart ChartLegendAlignment = "start" )
type ChartLegendDisplayMode ¶ added in v0.2.9
type ChartLegendDisplayMode string
const ( ChartLegendDisplayModeAlways ChartLegendDisplayMode = "always" ChartLegendDisplayModeAuto ChartLegendDisplayMode = "auto" ChartLegendDisplayModeHidden ChartLegendDisplayMode = "hidden" )
type ChartLegendPosition ¶ added in v0.2.9
type ChartLegendPosition string
const ( ChartLegendPositionBottom ChartLegendPosition = "bottom" ChartLegendPositionTop ChartLegendPosition = "top" )
type ChartLegendSettings ¶ added in v0.2.9
type ChartLegendSettings struct {
// OptionalFields
Alignment ChartLegendAlignment
DisplayMode ChartLegendDisplayMode
GapSize string
Position ChartLegendPosition
SwatchShape string
TextColor string
}
type ChartLineDashStyle ¶ added in v0.2.9
type ChartLineDashStyle string
const ( ChartLineDashStyleDashed ChartLineDashStyle = "dashed" ChartLineDashStyleDotted ChartLineDashStyle = "dotted" ChartLineDashStyleSolid ChartLineDashStyle = "solid" )
type ChartMarkerDisplayMode ¶ added in v0.2.9
type ChartMarkerDisplayMode string
const ( ChartMarkerDisplayModeAlways ChartMarkerDisplayMode = "always" ChartMarkerDisplayModeHidden ChartMarkerDisplayMode = "hidden" ChartMarkerDisplayModeHover ChartMarkerDisplayMode = "hover" )
type ChartParliamentSettings ¶ added in v0.3.2
type ChartParliamentSettings struct {
// OptionalFields
DotGapPercent float64
DotShape ChartDotShape
DotSizePercent float64
RowCount uint
}
type ChartProgressSettings ¶ added in v0.3.2
type ChartProgressSettings struct {
// OptionalFields
DefaultColor string
IsIndeterminate bool
IsStriped bool
Label string
LabelBackgroundColor string
LabelOneWayStatePath string
LabelPrefix string
LabelSuffix string
LabelTextColor string
LabelTextSizeClass string
MaxHeightClass string
MaxValue float64
MaxWidthClass string
MinHeightClass string
MinValue float64
MinWidthClass string
ShouldShowPercentLabel bool
Size string
StripeColor string
Thresholds []ChartProgressThresholdSettings
TrackBackgroundColor string
Value float64
ValueOneWayStatePath string
}
type ChartProgressThresholdSettings ¶ added in v0.3.2
type ChartScaleType ¶ added in v0.2.9
type ChartScaleType string
const ( ChartScaleTypeCategory ChartScaleType = "category" ChartScaleTypeNumber ChartScaleType = "number" ChartScaleTypeTime ChartScaleType = "time" )
type ChartSeriesSettings ¶ added in v0.2.9
type ChartSeriesSettings struct {
RowKey string
Label string
// OptionalFields
IdentityColor string
LineDashStyle ChartLineDashStyle
}
type ChartSettings ¶ added in v0.2.9
type ChartSettings struct {
Type ChartType
XAxis ChartXAxisSettings
Series []ChartSeriesSettings
// OptionalFields
AriaLabel string
Cartesian ChartCartesianSettings
EmptyState templ.Component
GapColor string
Gauge ChartGaugeSettings
HeightClass string
Legend ChartLegendSettings
MaxRows uint
Parliament ChartParliamentSettings
Progress ChartProgressSettings
Rows any
RowsOneWayStatePath string
Slices ChartSliceSettings
Sunburst ChartSunburstSettings
Tooltip ChartTooltipSettings
Waffle ChartWaffleSettings
}
type ChartSliceSettings ¶ added in v0.3.2
type ChartSliceSettings struct {
// OptionalFields
CenterLabelAlwaysSlice string
CenterLabelDisplayMode ChartCenterLabelDisplayMode
CenterLabelSize ChartCenterLabelSize
CenterLabelSliceColor string
CenterLabelValueColor string
CenterLabelValueSuffix string
HolePercent uint8
IsSliceLabelHidden bool
SliceIdentityColors map[string]string
SliceLabelColor string
SliceLabelPillBackgroundColor string
}
type ChartStackMode ¶ added in v0.2.9
type ChartStackMode string
const ( ChartStackModeNone ChartStackMode = "none" ChartStackModePercent ChartStackMode = "percent" ChartStackModeStacked ChartStackMode = "stacked" )
type ChartSunburstSettings ¶ added in v0.3.2
type ChartSunburstSettings struct {
ChildRowKey string
}
type ChartTooltipSettings ¶ added in v0.2.9
type ChartTooltipSettings struct {
// OptionalFields
BackgroundColor string
BorderRadius string
ContentFunc string
CrosshairColor string
IsCrosshairHidden bool
IsHidden bool
MaxWidthClass string
MinWidthClass string
PaddingSize string
RingColor string
RingThickness string
SeriesLabelColor string
ShadowSize string
TitleColor string
TitleFormat string
ValueColor string
ValueFormat string
}
type ChartType ¶ added in v0.2.9
type ChartType string
const ( ChartTypeArea ChartType = "area" ChartTypeBar ChartType = "bar" ChartTypeDonut ChartType = "donut" ChartTypeGauge ChartType = "gauge" ChartTypeHorizontalBar ChartType = "horizontalBar" ChartTypeLine ChartType = "line" ChartTypeParliament ChartType = "parliament" ChartTypePie ChartType = "pie" ChartTypeProgress ChartType = "progress" ChartTypeRadialBar ChartType = "radialBar" ChartTypeSunburst ChartType = "sunburst" ChartTypeWaffle ChartType = "waffle" )
type ChartWaffleCellShape ¶ added in v0.3.2
type ChartWaffleCellShape string
const ( ChartWaffleCellShapeCircle ChartWaffleCellShape = "circle" ChartWaffleCellShapeSquare ChartWaffleCellShape = "square" )
type ChartWaffleSettings ¶ added in v0.3.2
type ChartWaffleSettings struct {
// OptionalFields
CellCount uint
CellGapPercent float64
CellShape ChartWaffleCellShape
ColumnCount uint
}
type ChartXAxisSettings ¶ added in v0.2.9
type ChartYAxisPosition ¶ added in v0.2.9
type ChartYAxisPosition string
const ( ChartYAxisPositionLeft ChartYAxisPosition = "left" ChartYAxisPositionRight ChartYAxisPosition = "right" )
type ChartYAxisSettings ¶ added in v0.2.9
type CloakLoadingSettings ¶ added in v0.0.8
type CollapsibleTextSettings ¶ added in v0.3.2
type ConfirmationDialogSettings ¶ added in v0.2.2
type ConfirmationDialogSettings struct {
IsVisibleTwoWayStatePath string
OnConfirmFunc string
// OptionalFields
ActionsContent templ.Component
CancelButtonLabel string
CancelFunc string
ConfirmButtonIcon string
ConfirmButtonId string
ConfirmButtonLabel string
HeaderContent templ.Component
HeaderIcon string
HeaderIconBackgroundColor string
HeaderIconBorderRadius string
HeaderIconColor string
HeaderIconPaddingSize string
HeaderIconPosition string
HeaderSize string
HeaderSubHeading string
HeaderSubHeadingColor string
HeaderSubHeadingOneWayStatePath string
HeaderTitle string
HeaderTitleColor string
HeaderTitleOneWayStatePath string
IsTypeToConfirmEnabled bool
IsUncloseable bool
Message string
MessageContent templ.Component
OnCloseFunc string
Size string
TargetIdStatePath string
TargetNameStatePath string
TextCase string
TextColor string
TypeToConfirmExpectedValue string
TypeToConfirmValueTwoWayStatePath string
WidthPercent int
HeightPercent int
MinWidthPercent int
MaxWidthPercent int
MinHeightPercent int
MaxHeightPercent int
}
type HeaderBlockSettings ¶ added in v0.2.2
type HeaderBlockSettings struct {
// OptionalFields
ActionsContent templ.Component
HeaderIcon string
HeaderIconBackgroundColor string
HeaderIconBorderRadius string
HeaderIconColor string
HeaderIconPaddingSize string
HeaderIconPosition string
HeaderSize string
HeaderSubHeading string
HeaderSubHeadingColor string
HeaderSubHeadingOneWayStatePath string
HeaderTitle string
HeaderTitleColor string
HeaderTitleOneWayStatePath string
HeadingLevel string
TextCase string
TextColor string
}
type HeaderIconSettings ¶ added in v0.2.2
type LoadingOverlaySettings ¶ added in v0.0.6
type ModalSettings ¶ added in v0.0.9
type ModalSettings struct {
MiddleContent templ.Component
// OptionalFields
Title string
TitleOneWayStatePath string
HeaderContent templ.Component
InitialSize string
CurrentSizeTwoWayStatePath string
PossibleSizes []string
WidthPercent int
HeightPercent int
MinWidthPercent int
MaxWidthPercent int
MinHeightPercent int
MaxHeightPercent int
ShouldHeightMatchContent bool
BackdropColor string
BackgroundColor string
TextColor string
BorderRadius string
ShadowSize string
RingColor string
RingThickness string
IsVisibleTwoWayStatePath string
IsUncloseable bool
IsUnresizable bool
IsMiddleContentScrollDisabled bool
OnCloseFunc string
OnResizeFunc string
}
type TagSettings ¶
type TagSettings struct {
// OptionalFields
Size string
TextCase string
OuterRingThickness string
OuterRingColor string
OuterBackgroundColor string
OuterTextColor string
OuterLeftIcon string
OuterLeftLabel string
OuterLeftLabelOneWayStatePath string
OuterLeftOnClickFunc string
OuterRightIcon string
OuterRightLabel string
OuterRightLabelOneWayStatePath string
OuterRightOnClickFunc string
OuterRadius string
OnRemoveFunc string
RemoveButtonLabel string
InnerIcon string
InnerLabel string
InnerLabelOneWayStatePath string
InnerValueOneWayStatePath string
InnerBackgroundColor string
InnerTextColor string
InnerRadius string
}
Click to show internal directories.
Click to hide internal directories.