MujicaUI/layout/app_shell.go

package layout

import (
	"log/slog"

	"github.com/egoist/mygo/ui"

	"git.zacharyzhang.com/ZacharyZhang-NY/MujicaUI/core"
	"git.zacharyzhang.com/ZacharyZhang-NY/MujicaUI/icons"
	"git.zacharyzhang.com/ZacharyZhang-NY/MujicaUI/theme"
)

// AppShellOptions are the slots of an AppShell. Content is required; the others are optional.
type AppShellOptions struct {
	// TitleBar goes across the top, as a TitleBar.
	TitleBar func()
	// Sidebar scrolls on its own beside the content and collapses to a rail.
	Sidebar func()
	// Content scrolls on its own.
	Content func()
	// StatusBar goes across the bottom, as a StatusBar.
	StatusBar func()
	// SidebarWidth is the open sidebar's width in DIPs; zero is 240.
	SidebarWidth float32
	// ContentScroll keeps the content's offset; nil keeps it by the shell's place.
	ContentScroll *ui.ScrollState
}

// AppShellResult is an AppShell and its event in this frame.
type AppShellResult struct {
	Element ui.Element
	// Toggled reports the sidebar opened or collapsed.
	Toggled bool
}

// AppShell lays out title bar, sidebar, content and status bar; *collapsed folds the sidebar.
func AppShell(c *ui.Context, collapsed *bool, opts AppShellOptions) AppShellResult {
	if collapsed == nil {
		panic("mujica: AppShell needs a collapsed state")
	}
	if opts.Content == nil {
		panic("mujica: AppShell needs Content")
	}
	if opts.SidebarWidth < 0 {
		panic("mujica: AppShell SidebarWidth must not be negative")
	}
	k := core.Tokens(c)
	var res AppShellResult
	toggle := func() {
		*collapsed = !*collapsed
		res.Toggled = true
		slog.Debug("mujica: app_shell toggled", "collapsed", *collapsed)
	}
	if opts.Sidebar != nil && c.Shortcut(ui.Cmd, ui.KeyB) {
		toggle()
	}
	e := ui.Column(c).Fill().AlignItems(ui.Stretch).Background(k.Background)
	e.Children(func() {
		if opts.TitleBar != nil {
			opts.TitleBar()
		}
		ui.Row(c).Grow(1).MinHeight(0).AlignItems(ui.Stretch).Children(func() {
			if opts.Sidebar != nil && appShellSidebar(c, *collapsed, opts) {
				toggle()
			}
			ScrollArea(c, opts.ContentScroll, ScrollAreaOptions{}, opts.Content).Grow(1).MinWidth(0)
		})
		if opts.StatusBar != nil {
			opts.StatusBar()
		}
	})
	res.Element = e
	return res
}

// appShellSidebar builds the sidebar or its rail and reports whether its toggle was pressed.
func appShellSidebar(c *ui.Context, collapsed bool, opts AppShellOptions) bool {
	k := core.Tokens(c)
	u := core.Density(c).Unit()
	open := opts.SidebarWidth
	if open == 0 {
		open = 240
	}
	rail := theme.MinHitSize + 4*u
	target := open
	if collapsed {
		target = rail
	}
	side := ui.Column(c).Shrink(0).Clip().AlignItems(ui.Stretch).Background(k.Surface).
		BorderWidth(0, theme.BorderWidth, 0, 0).BorderColor(k.Border)
	side.Width(side.AnimateWith("app_shell.width", target, core.Motion(c, theme.StateDuration), ui.EaseOut))
	var pressed bool
	side.Children(func() {
		head := ui.Row(c).Shrink(0).Padding(u * 2).Justify(ui.End)
		if collapsed {
			head.Justify(ui.Center)
		}
		head.Children(func() {
			label := core.Msg(c, "app_shell.collapse")
			if collapsed {
				label = core.Msg(c, "app_shell.expand")
			}
			pressed = core.IconAction(c, icons.Must("panel-left"), label).Tooltip(label).Clicked()
		})
		if !collapsed {
			ScrollArea(c, nil, ScrollAreaOptions{}, opts.Sidebar).Grow(1).MinHeight(0)
		}
	})
	return pressed
}