Documentation
¶
Overview ¶
Package tooltip provides tooltip/hint components.
Available variants:
- New() creates a tooltip (template: "lvt:tooltip:default:v1")
Required lvt-* attributes: lvt-on:mouseenter, lvt-on:mouseleave, lvt-on:focus, lvt-on:blur
Example usage:
// In your controller/state
HelpTip: tooltip.New("help-tip",
tooltip.WithContent("Click to learn more"),
tooltip.WithPosition(tooltip.PositionTop),
)
// In your template
{{template "lvt:tooltip:default:v1" .HelpTip}}
Index ¶
- func Templates() *base.TemplateSet
- type Option
- func WithArrow(show bool) Option
- func WithContent(content string) Option
- func WithDelay(delay int) Option
- func WithHideDelay(delay int) Option
- func WithMaxWidth(width string) Option
- func WithPosition(position Position) Option
- func WithStyled(styled bool) Option
- func WithTrigger(trigger Trigger) Option
- func WithVisible(visible bool) Option
- type Position
- type Tooltip
- func (t *Tooltip) ArrowClasses() string
- func (t *Tooltip) HasContent() bool
- func (t *Tooltip) Hide()
- func (t *Tooltip) IsBottom() bool
- func (t *Tooltip) IsClickTrigger() bool
- func (t *Tooltip) IsFocusTrigger() bool
- func (t *Tooltip) IsHoverTrigger() bool
- func (t *Tooltip) IsLeft() bool
- func (t *Tooltip) IsRight() bool
- func (t *Tooltip) IsTop() bool
- func (t *Tooltip) PositionClasses() string
- func (t *Tooltip) Show()
- func (t *Tooltip) Styles() styles.TooltipStyles
- func (t *Tooltip) Toggle()
- type Trigger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Templates ¶
func Templates() *base.TemplateSet
Templates returns the tooltip component's template set for registration with the LiveTemplate framework.
Example usage in main.go:
import "github.com/livetemplate/lvt/components/tooltip"
tmpl, err := livetemplate.New("app",
livetemplate.WithComponentTemplates(tooltip.Templates()),
)
Available templates:
- "lvt:tooltip:default:v1" - Basic tooltip
Types ¶
type Option ¶
type Option func(*Tooltip)
Option is a functional option for configuring tooltips.
func WithHideDelay ¶
WithHideDelay sets the hide delay in milliseconds.
func WithPosition ¶
WithPosition sets the tooltip position.
func WithVisible ¶
WithVisible sets the initial visibility state.
type Position ¶
type Position string
Position defines where the tooltip appears relative to trigger.
const ( PositionTop Position = "top" PositionTopStart Position = "top-start" PositionTopEnd Position = "top-end" PositionBottom Position = "bottom" PositionBottomStart Position = "bottom-start" PositionBottomEnd Position = "bottom-end" PositionLeft Position = "left" PositionLeftStart Position = "left-start" PositionLeftEnd Position = "left-end" PositionRight Position = "right" PositionRightStart Position = "right-start" PositionRightEnd Position = "right-end" )
type Tooltip ¶
type Tooltip struct {
base.Base
// Content is the tooltip text
Content string
// Position is where the tooltip appears
Position Position
// Trigger is what action shows the tooltip
Trigger Trigger
// Visible indicates whether the tooltip is shown
Visible bool
// Delay in milliseconds before showing (for hover)
Delay int
// HideDelay in milliseconds before hiding (for hover)
HideDelay int
// Arrow shows a pointing arrow
Arrow bool
// MaxWidth limits tooltip width
MaxWidth string
}
Tooltip is a contextual hint component. Use template "lvt:tooltip:default:v1" to render.
func New ¶
New creates a tooltip.
Example:
t := tooltip.New("help",
tooltip.WithContent("Help text"),
tooltip.WithPosition(tooltip.PositionTop),
)
func (*Tooltip) ArrowClasses ¶
ArrowClasses returns CSS classes for the arrow.
func (*Tooltip) HasContent ¶
HasContent returns true if tooltip has content.
func (*Tooltip) IsClickTrigger ¶
IsClickTrigger returns true if trigger is click.
func (*Tooltip) IsFocusTrigger ¶
IsFocusTrigger returns true if trigger is focus.
func (*Tooltip) IsHoverTrigger ¶
IsHoverTrigger returns true if trigger is hover.
func (*Tooltip) PositionClasses ¶
PositionClasses returns CSS classes for position.
func (*Tooltip) Styles ¶
func (t *Tooltip) Styles() styles.TooltipStyles
Styles returns the resolved TooltipStyles for this component.
Source Files