navi

Documentation

Index

• Constants
• Variables
• type ActionBar
  • func (ab *ActionBar) Layout(gtx layout.Context, th *theme.Theme) layout.Dimensions
  • func (ab *ActionBar) SetActions(actions []view.ViewAction, maxVisibleActions int)
• type C
• type D
• type NavDrawer
  • func NewNavDrawer(vm view.ViewManager) *NavDrawer
  • func (nv *NavDrawer) AddSection(item NavSection)
  • func (nv *NavDrawer) InsertAt(index int, item NavSection)
  • func (nv *NavDrawer) Layout(gtx C, th *theme.Theme) D
  • func (nv *NavDrawer) OnItemSelected(gtx C, item *NavItemStyle)
  • func (nv *NavDrawer) RemoveSection(index int)
• type NavItem
• type NavItemStyle
  • func NewNavItem(item NavItem, drawer *NavDrawer) *NavItemStyle
  • func (n *NavItemStyle) IsSelected() bool
  • func (n *NavItemStyle) Layout(gtx C, th *theme.Theme) D
  • func (n *NavItemStyle) Unselect()
  • func (n *NavItemStyle) Update(gtx C) bool
• type NavSection
  • func SimpleItemSection(icon *widget.Icon, name string, targetView view.ViewID, openAsModal bool) NavSection
• type NaviDrawerStyle
  • func (ns NaviDrawerStyle) Layout(gtx C, th *theme.Theme) D
• type Tab
  • func (tab *Tab) IsSelected() bool
  • func (tab *Tab) Layout(gtx C, th *theme.Theme) D
  • func (tab *Tab) Update(gtx C) []TabEvent
• type TabEvent
• type Tabbar
  • func NewTabbar(vm view.ViewManager, options *TabbarOptions) *Tabbar
  • func (tb *Tabbar) Layout(gtx C, th *theme.Theme) D
• type TabbarOptions

Constants

const (
	TabSelectedEvent = TabEvent("TabSelected")
	TabClosedEvent   = TabEvent("TabClosed")
)

Variables

var NavItemPadding = layout.Inset{
	Left:   unit.Dp(4),
	Right:  unit.Dp(4),
	Top:    unit.Dp(1),
	Bottom: unit.Dp(1),
}

Types

type ActionBar

type ActionBar struct {
	// contains filtered or unexported fields
}

func (*ActionBar) Layout

func (ab *ActionBar) Layout(gtx layout.Context, th *theme.Theme) layout.Dimensions

func (*ActionBar) SetActions

func (ab *ActionBar) SetActions(actions []view.ViewAction, maxVisibleActions int)

type C

type C = layout.Context

type D

type D = layout.Dimensions

type NavDrawer

type NavDrawer struct {

	// used to set inset of each section.
	SectionInset layout.Inset
	// contains filtered or unexported fields
}

func NewNavDrawer

func NewNavDrawer(vm view.ViewManager) *NavDrawer

func (*NavDrawer) AddSection

func (nv *NavDrawer) AddSection(item NavSection)

func (*NavDrawer) InsertAt

func (nv *NavDrawer) InsertAt(index int, item NavSection)

func (*NavDrawer) Layout

func (nv *NavDrawer) Layout(gtx C, th *theme.Theme) D

func (*NavDrawer) OnItemSelected

func (nv *NavDrawer) OnItemSelected(gtx C, item *NavItemStyle)

func (*NavDrawer) RemoveSection

func (nv *NavDrawer) RemoveSection(index int)

type NavItem

type NavItem interface {
	OnSelect(gtx layout.Context) view.Intent
	Icon() *widget.Icon
	Layout(gtx layout.Context, th *theme.Theme, textColor color.NRGBA) D
	// when there's menu options, a context menu should be attached to this navItem.
	// The returned boolean value suggest the position of the popup menu should be at
	// fixed position or not. NavItemStyle should place a clickable icon to guide user interactions.
	ContextMenuOptions(gtx layout.Context) ([][]menu.MenuOption, bool)
	Children() []NavItem
}

type NavItemStyle

type NavItemStyle struct {
	// contains filtered or unexported fields
}

func NewNavItem

func NewNavItem(item NavItem, drawer *NavDrawer) *NavItemStyle

func (*NavItemStyle) IsSelected

func (n *NavItemStyle) IsSelected() bool

func (*NavItemStyle) Layout

func (n *NavItemStyle) Layout(gtx C, th *theme.Theme) D

func (*NavItemStyle) Unselect

func (n *NavItemStyle) Unselect()

func (*NavItemStyle) Update

func (n *NavItemStyle) Update(gtx C) bool

type NavSection

type NavSection interface {
	Title() string
	Layout(gtx C, th *theme.Theme) D
	Attach(d *NavDrawer)
}

func SimpleItemSection

func SimpleItemSection(icon *widget.Icon, name string, targetView view.ViewID, openAsModal bool) NavSection

type NaviDrawerStyle

type NaviDrawerStyle struct {
	*NavDrawer
	Inset layout.Inset
	Bg    color.NRGBA
	Width unit.Dp
}

func (NaviDrawerStyle) Layout

func (ns NaviDrawerStyle) Layout(gtx C, th *theme.Theme) D

type Tab

type Tab struct {
	// contains filtered or unexported fields
}

func (*Tab) IsSelected

func (tab *Tab) IsSelected() bool

func (*Tab) Layout

func (tab *Tab) Layout(gtx C, th *theme.Theme) D

func (*Tab) Update

func (tab *Tab) Update(gtx C) []TabEvent

type TabEvent

type TabEvent string

type Tabbar

type Tabbar struct {
	// contains filtered or unexported fields
}

func NewTabbar

func NewTabbar(vm view.ViewManager, options *TabbarOptions) *Tabbar

func (*Tabbar) Layout

func (tb *Tabbar) Layout(gtx C, th *theme.Theme) D

type TabbarOptions

type TabbarOptions struct {
	Height            unit.Dp
	MaxVisibleActions int
}