box

package

v0.0.0-...-48f2f3c Latest Latest Go to latest Published: Jun 14, 2025 License: MIT Imports: 6 Imported by: 0

Details

This section is empty.

This section is empty.

func Box(c *app.Ctx, props app.Props) string

Box is the functional component for rendering a box with a viewport.

func New(c *app.Ctx, child app.FC, opts ...BoxProp) *app.C

New creates a new Box component.

func NewEmpty(c *app.Ctx, opts ...BoxProp) *app.C

NewEmpty creates a new Box component with no children.

type BoxProp func(*BoxProps)

BoxProp is a function type for setting BoxProps.

func WithBg(bg color.Color) BoxProp

WithBg sets the background color for the box.

func WithBorder(border lipgloss.Border) BoxProp

func WithBorderBottom(border lipgloss.Border) BoxProp

func WithBorderColor(color color.Color) BoxProp

func WithBorderLeft(border lipgloss.Border) BoxProp

func WithBorderRight(border lipgloss.Border) BoxProp

func WithBorderTop(border lipgloss.Border) BoxProp

func WithDisableFollow(disable bool) BoxProp

WithDisableFollow disables the viewport's auto-scrolling to the bottom on content change.

func WithGrow(grow bool) BoxProp

func WithGrowX(grow bool) BoxProp

func WithGrowY(grow bool) BoxProp

func WithHeight(height int) BoxProp

func WithKey(key string) BoxProp

func WithWidth(width int) BoxProp

type BoxProps struct {
	Key           string
	Bg            color.Color
	DisableFollow bool
	Child         app.FC
	app.Layout
	app.Border
}

BoxProps defines the properties for the Box component.

Path	Synopsis
viewport Package viewport provides a component for rendering a viewport in a Bubble Tea.	Package viewport provides a component for rendering a viewport in a Bubble Tea.