Documentation
¶
Index ¶
- Constants
- func Card(componentSettings CardSettings) templ.Component
- func Carousel[Item any](componentSettings CarouselSettings[Item]) templ.Component
- func CarouselDefaultEmptyState() templ.Component
- func CarouselDefaultSearchBox() templ.Component
- func CarouselItemTooltip(componentSettings CarouselItemTooltipSettings) templ.Component
- func CarouselRefreshRegions[Item any](componentSettings CarouselSettings[Item]) templ.Component
- func DataTable[Row any](componentSettings DataTableSettings[Row]) templ.Component
- func DataTableDefaultEmptyState() templ.Component
- func DataTableDefaultSearchBox() templ.Component
- func DataTableRefreshRegion[Row any](componentSettings DataTableSettings[Row]) templ.Component
- func FilterBar(componentSettings FilterBarSettings) templ.Component
- func PageHeading(componentSettings PageHeadingSettings) templ.Component
- func Pagination(componentSettings PaginationSettings) templ.Component
- func Sidebar(componentSettings SidebarSettings) templ.Component
- func Tabs(componentSettings TabSettings) templ.Component
- type CardSettings
- type CarouselItemTooltipSettings
- type CarouselItemsPerViewSettings
- type CarouselSettings
- type DataTableColumnSettings
- type DataTableDensity
- type DataTableSettings
- type DataTableSortDirection
- type FilterBarSettings
- type FilterChipStyle
- type FilterSettings
- type HorizontalAlignment
- type ItemsPerPage
- type PageHeadingSettings
- type PaginationSettings
- type SidebarSettings
- type TabItemSettings
- type TabSettings
- type TextAlignment
Constants ¶
View Source
const ( CarouselUrlPlaceholderPageNumber string = DataTableUrlPlaceholderPageNumber CarouselUrlPlaceholderItemsPerPage string = DataTableUrlPlaceholderItemsPerPage CarouselUrlPlaceholderSearch string = DataTableUrlPlaceholderSearch CarouselArrowsPositionInside string = "inside" CarouselArrowsPositionOutside string = "outside" CarouselDotsPositionTop string = "top" CarouselDotsPositionBottom string = "bottom" CarouselSearchBoxPositionTop string = "top" CarouselSearchBoxPositionBottom string = "bottom" CarouselArrowsSizeSm string = "sm" CarouselArrowsSizeMd string = "md" CarouselArrowsSizeLg string = "lg" CarouselDotsSizeSm string = "sm" CarouselDotsSizeMd string = "md" CarouselDotsSizeLg string = "lg" )
View Source
const ( DataTableUrlPlaceholderPageNumber string = "{pageNumber}" DataTableUrlPlaceholderItemsPerPage string = "{itemsPerPage}" DataTableUrlPlaceholderSortKey string = "{sortKey}" DataTableUrlPlaceholderSortDirection string = "{sortDirection}" DataTableUrlPlaceholderSearch string = "{search}" )
View Source
const ( FilterKindTextContains string = "textContains" FilterKindEnumSelect string = "enumSelect" FilterKindMultiEnumSelect string = "multiEnumSelect" FilterKindNumberRange string = "numberRange" FilterKindDateRange string = "dateRange" )
View Source
const ( PageHeadingLevelPage string = "page" PageHeadingLevelSection string = "section" )
View Source
const ( SidebarSideLeft string = "left" SidebarSideRight string = "right" SidebarAttachmentModeInline string = "inline" SidebarAttachmentModeFixed string = "fixed" )
View Source
const ( TabOrientationHorizontal string = "horizontal" TabOrientationVertical string = "vertical" TabSideLeft string = "left" TabSideRight string = "right" TabAlignmentTop string = "top" TabAlignmentCenter string = "center" TabAlignmentBottom string = "bottom" TabIconPositionLeft string = "left" TabIconPositionTop string = "top" )
Variables ¶
This section is empty.
Functions ¶
func Card ¶ added in v0.2.2
func Card(componentSettings CardSettings) templ.Component
func Carousel ¶ added in v0.2.5
func Carousel[Item any](componentSettings CarouselSettings[Item]) templ.Component
func CarouselDefaultEmptyState ¶ added in v0.2.5
func CarouselDefaultSearchBox ¶ added in v0.2.5
func CarouselItemTooltip ¶ added in v0.2.5
func CarouselItemTooltip(componentSettings CarouselItemTooltipSettings) templ.Component
func CarouselRefreshRegions ¶ added in v0.2.8
func CarouselRefreshRegions[Item any](componentSettings CarouselSettings[Item]) templ.Component
func DataTableRefreshRegion ¶ added in v0.2.8
func DataTableRefreshRegion[Row any](componentSettings DataTableSettings[Row]) templ.Component
func FilterBar ¶
func FilterBar(componentSettings FilterBarSettings) templ.Component
func PageHeading ¶ added in v0.2.2
func PageHeading(componentSettings PageHeadingSettings) templ.Component
func Pagination ¶
func Pagination(componentSettings PaginationSettings) templ.Component
func Sidebar ¶
func Sidebar(componentSettings SidebarSettings) templ.Component
func Tabs ¶ added in v0.2.4
func Tabs(componentSettings TabSettings) templ.Component
Types ¶
type CardSettings ¶ added in v0.2.2
type CardSettings struct {
MiddleContent templ.Component
// OptionalFields
ActionsContent templ.Component
BackgroundColor string
BorderRadius string
GapSize 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
PaddingSize string
RingColor string
RingThickness string
ShadowSize string
TextCase string
TextColor string
}
type CarouselItemTooltipSettings ¶ added in v0.2.5
type CarouselItemsPerViewSettings ¶ added in v0.2.5
type CarouselSettings ¶ added in v0.2.5
type CarouselSettings[Item any] struct { ItemRenderer func(item Item) templ.Component Items []Item // OptionalFields ArrowsBackgroundColor string ArrowsIconColor string ArrowsPosition string ArrowsShape string ArrowsSize string AutoplayIntervalMs uint BackgroundColor string BorderRadius string DotsActiveColor string DotsInactiveColor string DotsPosition string DotsSize string EmptyState templ.Component FilterChipStyle FilterChipStyle FilterDropdownBackgroundColor string Filters []FilterSettings GapSize string Id string InitialFilterValues map[string]any InitialSearchQuery string IsAutoplay bool IsAutoplayPausedOnHover bool IsPaginationHiddenWhenSinglePage bool IsSearchBoxCompact bool IsSwipeEnabled bool ItemBackgroundColor string ItemBorderRadius string ItemPaddingSize string ItemRingColor string ItemRingThickness string ItemShadowSize string ItemsPerPage ItemsPerPage ItemsPerPageSizeChoices []ItemsPerPage ItemsPerView CarouselItemsPerViewSettings ItemsTotal uint PageNumber uint PaddingSize string PaginationAriaLabel string PagesTotal uint QueryUrlTemplate string RefreshDebounceMs uint RefreshOnEvents []string RingColor string RingThickness string SearchBox templ.Component SearchBoxAlignment HorizontalAlignment SearchBoxPosition string ShadowSize string ShouldUseOneBasedPageDisplay bool TextColor string }
type DataTableColumnSettings ¶
type DataTableDensity ¶
type DataTableDensity string
const ( DataTableDensityComfortable DataTableDensity = "comfortable" DataTableDensityDense DataTableDensity = "dense" )
type DataTableSettings ¶
type DataTableSettings[Row any] struct { Columns []DataTableColumnSettings[Row] Rows []Row // OptionalFields BulkActions templ.Component CheckboxCheckedColor string CheckboxShape string CheckboxSize string CheckboxUncheckedColor string Density DataTableDensity EmptyState templ.Component FilterChipStyle FilterChipStyle FilterDropdownBackgroundColor string Filters []FilterSettings HeaderActions templ.Component HeaderClass string Id string InitialFilterValues map[string]any InitialSearchQuery string InitialSortDirection DataTableSortDirection InitialSortKey string IsHeaderStatic bool IsPaginationHiddenWhenSinglePage bool IsSearchBoxCompact bool IsStriped bool ItemsPerPage ItemsPerPage ItemsPerPageDropdownBackgroundColor string ItemsPerPageSizeChoices []ItemsPerPage ItemsTotal uint MaxHeightClass string MaxVisibleRows uint MaxWidthClass string MinHeightClass string MinWidthClass string PageNumber uint PaginationAriaLabel string PagesTotal uint QueryUrlTemplate string RefreshDebounceMs uint RefreshOnEvents []string RowClassResolver func(row Row) string RowIdResolver func(row Row) string RowLabelResolver func(row Row) string SearchBox templ.Component SearchBoxAlignment HorizontalAlignment ShouldUseOneBasedPageDisplay bool StickyHeaderBackgroundColor string TextCase string }
type DataTableSortDirection ¶
type DataTableSortDirection string
const ( DataTableSortDirectionAsc DataTableSortDirection = "asc" DataTableSortDirectionDesc DataTableSortDirection = "desc" )
type FilterBarSettings ¶
type FilterBarSettings struct {
Filters []FilterSettings
ValuesTwoWayStatePath string
// OptionalFields
DropdownBackgroundColor string
EnumSelectRadioGroupNamePrefix string
OnChangeFunc string
ChipStyle FilterChipStyle
}
type FilterChipStyle ¶ added in v0.2.6
type FilterSettings ¶
type HorizontalAlignment ¶ added in v0.2.5
type HorizontalAlignment string
const ( HorizontalAlignmentLeft HorizontalAlignment = "left" HorizontalAlignmentCenter HorizontalAlignment = "center" HorizontalAlignmentRight HorizontalAlignment = "right" )
type ItemsPerPage ¶ added in v0.2.5
type ItemsPerPage uint
type PageHeadingSettings ¶ added in v0.2.2
type PageHeadingSettings struct {
HeaderTitle string
Level string
// OptionalFields
ActionsContent templ.Component
Description string
HeaderIcon string
HeaderIconBackgroundColor string
HeaderIconBorderRadius string
HeaderIconColor string
HeaderIconPaddingSize string
HeaderIconPosition string
HeaderSize string
HeaderSubHeading string
HeaderSubHeadingColor string
HeaderSubHeadingOneWayStatePath string
HeaderTitleColor string
HeaderTitleOneWayStatePath string
TextCase string
TextColor string
}
type PaginationSettings ¶
type PaginationSettings struct {
PageNumberTwoWayStatePath string
ItemsPerPageTwoWayStatePath string
ItemsTotal uint
// OptionalFields
AriaLabel string
DropdownBackgroundColor string
IsDisabledOneWayStatePath string
IsHiddenWhenSinglePage bool
ItemsPerPageInputName string
ItemsPerPageSizeChoices []uint
OnChangeFunc string
PagesTotal uint
ShouldUseOneBasedPageDisplay bool
}
type SidebarSettings ¶
type SidebarSettings struct {
MiddleContent templ.Component
// OptionalFields
HeaderContent templ.Component
Width string
BackgroundColor string
IsVisibleTwoWayStatePath string
IsCollapsed bool
IsCollapsedTwoWayStatePath string
AttachmentMode string
AttachmentModeTwoWayStatePath string
Side string
SideTwoWayStatePath string
IsOffCanvas bool
IsOffCanvasTwoWayStatePath string
}
type TabItemSettings ¶ added in v0.2.4
type TabItemSettings struct {
Label string
Value string
// OptionalFields
BadgeBackgroundColor string
BadgeBorderRadius string
BadgeCount uint
BadgeCountOneWayStatePath string
BadgeRingColor string
BadgeRingThickness string
BadgeTextColor string
Content templ.Component
Icon string
IconPosition string
}
type TabSettings ¶ added in v0.2.4
type TabSettings struct {
Items []TabItemSettings
SelectedValueTwoWayStatePath string
// OptionalFields
Alignment string
AriaLabel string
BackgroundColor string
BorderRadius string
ContentBackgroundColor string
ContentBorderRadius string
ContentPaddingSize string
ContentRingColor string
ContentRingThickness string
ContentShadowSize string
ContentTextColor string
GapSize string
IsUrlHashSynced bool
MaxHeightClass string
MaxHeightPercent uint
MaxWidthClass string
MaxWidthPercent uint
MaxVisibleTabs uint
MinHeightClass string
MinHeightPercent uint
MinWidthClass string
MinWidthPercent uint
Orientation string
PaddingSize string
RingColor string
RingThickness string
ShadowSize string
Side string
TextCase string
TextColor string
}
type TextAlignment ¶ added in v0.2.5
type TextAlignment string
const ( TextAlignmentLeft TextAlignment = "left" TextAlignmentCenter TextAlignment = "center" TextAlignmentRight TextAlignment = "right" )
Click to show internal directories.
Click to hide internal directories.