navtree

Documentation

Index

• Constants
• func ApplyAdminIA(root *NavTreeRoot)
• func Sort(nodes []*NavLink)
• type NavLink
  • func AppendIfNotNil(children []*NavLink, newChild *NavLink) []*NavLink
  • func FindById(nodes []*NavLink, id string) *NavLink
  • func (node *NavLink) Sort()
• type NavTreeRoot
  • func (root *NavTreeRoot) AddSection(node *NavLink)
  • func (root *NavTreeRoot) FindById(id string) *NavLink
  • func (root *NavTreeRoot) MarshalJSON() ([]byte, error)
  • func (root *NavTreeRoot) RemoveEmptySectionsAndApplyNewInformationArchitecture(topNavEnabled bool)
  • func (root *NavTreeRoot) RemoveSection(node *NavLink)
  • func (root *NavTreeRoot) Sort()
• type Service

Constants

const (
	WeightHome = (iota - 20) * 100
	WeightSavedItems
	WeightCreate
	WeightDashboard
	WeightExplore
	WeightAlerting
	WeightDataConnections
	WeightPlugin
	WeightConfig
	WeightAlertsAndIncidents
	WeightMonitoring
	WeightApps
	WeightAdmin
	WeightProfile
	WeightHelp
)

const (
	NavSectionCore   string = "core"
	NavSectionPlugin string = "plugin"
	NavSectionConfig string = "config"
)

const (
	NavIDRoot               = "root"
	NavIDDashboards         = "dashboards"
	NavIDDashboardsBrowse   = "dashboards/browse"
	NavIDCfg                = "cfg" // NavIDCfg is the id for org configuration navigation node
	NavIDAdmin              = "admin"
	NavIDAlertsAndIncidents = "alerts-and-incidents"
	NavIDAlerting           = "alerting"
	NavIDAlertingLegacy     = "alerting-legacy"
	NavIDMonitoring         = "monitoring"
	NavIDReporting          = "reports"
	NavIDApps               = "apps"
)

Functions

func ApplyAdminIA

func ApplyAdminIA(root *NavTreeRoot)

func Sort

func Sort(nodes []*NavLink)

Types

type NavLink

type NavLink struct {
	Id               string     `json:"id,omitempty"`
	Text             string     `json:"text"`
	Section          string     `json:"section,omitempty"`
	SubTitle         string     `json:"subTitle,omitempty"`
	Icon             string     `json:"icon,omitempty"` // Available icons can be browsed in Storybook: https://developers.grafana.com/ui/latest/index.html?path=/story/docs-overview-icon--icons-overview
	Img              string     `json:"img,omitempty"`
	Url              string     `json:"url,omitempty"`
	Target           string     `json:"target,omitempty"`
	SortWeight       int64      `json:"sortWeight,omitempty"`
	Divider          bool       `json:"divider,omitempty"`
	HideFromMenu     bool       `json:"hideFromMenu,omitempty"`
	HideFromTabs     bool       `json:"hideFromTabs,omitempty"`
	ShowIconInNavbar bool       `json:"showIconInNavbar,omitempty"`
	RoundIcon        bool       `json:"roundIcon,omitempty"`
	IsSection        bool       `json:"isSection,omitempty"`
	Children         []*NavLink `json:"children,omitempty"`
	HighlightText    string     `json:"highlightText,omitempty"`
	HighlightID      string     `json:"highlightId,omitempty"`
	EmptyMessageId   string     `json:"emptyMessageId,omitempty"`
	PluginID         string     `json:"pluginId,omitempty"` // (Optional) The ID of the plugin that registered nav link (e.g. as a standalone plugin page)
	IsCreateAction   bool       `json:"isCreateAction,omitempty"`
}

func AppendIfNotNil

func AppendIfNotNil(children []*NavLink, newChild *NavLink) []*NavLink

func FindById

func FindById(nodes []*NavLink, id string) *NavLink

func (*NavLink) Sort

func (node *NavLink) Sort()

type NavTreeRoot

type NavTreeRoot struct {
	Children []*NavLink
}

func (*NavTreeRoot) AddSection

func (root *NavTreeRoot) AddSection(node *NavLink)

func (*NavTreeRoot) FindById

func (root *NavTreeRoot) FindById(id string) *NavLink

func (*NavTreeRoot) MarshalJSON

func (root *NavTreeRoot) MarshalJSON() ([]byte, error)

func (*NavTreeRoot) RemoveEmptySectionsAndApplyNewInformationArchitecture

func (root *NavTreeRoot) RemoveEmptySectionsAndApplyNewInformationArchitecture(topNavEnabled bool)

func (*NavTreeRoot) RemoveSection

func (root *NavTreeRoot) RemoveSection(node *NavLink)

func (*NavTreeRoot) Sort

func (root *NavTreeRoot) Sort()

type Service

type Service interface {
	GetNavTree(c *contextmodel.ReqContext, hasEditPerm bool, prefs *pref.Preference) (*NavTreeRoot, error)
}