navigation

Documentation

Overview

Copyright 2021 The Hugo Authors. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type Menu
  • func (m Menu) Add(me *MenuEntry) Menu
  • func (m Menu) ByName() Menu
  • func (m Menu) ByWeight() Menu
  • func (m Menu) Clone() Menu
  • func (m Menu) Limit(n int) Menu
  • func (m Menu) Reverse() Menu
  • func (m Menu) Sort() Menu
• type MenuEntry
  • func (m *MenuEntry) HasChildren() bool
  • func (m *MenuEntry) IsEqual(inme *MenuEntry) bool
  • func (m *MenuEntry) IsSameResource(inme *MenuEntry) bool
  • func (m *MenuEntry) KeyName() string
  • func (m *MenuEntry) MarshallMap(ime map[string]interface{}) error
  • func (m *MenuEntry) Title() string
  • func (m *MenuEntry) URL() string
• type MenuQueryProvider
  • func NewMenuQueryProvider(pagem PageMenusGetter, sitem MenusGetter, p Page) MenuQueryProvider
• type Menus
• type MenusGetter
• type Page
• type PageMenus
  • func PageMenusFromPage(p Page) (PageMenus, error)
• type PageMenusGetter
• type PageMenusProvider

Variables

var NopPageMenus = new(nopPageMenus)

Types

type Menu

type Menu []*MenuEntry

Menu is a collection of menu entries.

func (Menu) Add

func (m Menu) Add(me *MenuEntry) Menu

func (Menu) ByName

func (m Menu) ByName() Menu

ByName sorts the menu by the name defined in the menu configuration.

func (Menu) ByWeight

func (m Menu) ByWeight() Menu

ByWeight sorts the menu by the weight defined in the menu configuration.

func (Menu) Clone

func (m Menu) Clone() Menu

func (Menu) Limit

func (m Menu) Limit(n int) Menu

Limit limits the returned menu to n entries.

func (Menu) Reverse

func (m Menu) Reverse() Menu

Reverse reverses the order of the menu entries.

func (Menu) Sort

func (m Menu) Sort() Menu

Sort sorts the menu by weight, name and then by identifier.

type MenuEntry

type MenuEntry struct {
	ConfiguredURL string // The URL value from front matter / config.
	Page          Page
	PageRef       string // The path to the page, only relevant for site config.
	Name          string
	Menu          string
	Identifier    string

	Pre      template.HTML
	Post     template.HTML
	Weight   int
	Parent   string
	Children Menu
	Params   maps.Params
	// contains filtered or unexported fields
}

MenuEntry represents a menu item defined in either Page front matter or in the site config.

func (*MenuEntry) HasChildren

func (m *MenuEntry) HasChildren() bool

HasChildren returns whether this menu item has any children.

func (*MenuEntry) IsEqual

func (m *MenuEntry) IsEqual(inme *MenuEntry) bool

IsEqual returns whether the two menu entries represents the same menu entry.

func (*MenuEntry) IsSameResource

func (m *MenuEntry) IsSameResource(inme *MenuEntry) bool

IsSameResource returns whether the two menu entries points to the same resource (URL).

func (*MenuEntry) KeyName

func (m *MenuEntry) KeyName() string

KeyName returns the key used to identify this menu entry.

func (*MenuEntry) MarshallMap

func (m *MenuEntry) MarshallMap(ime map[string]interface{}) error

func (*MenuEntry) Title

func (m *MenuEntry) Title() string

func (*MenuEntry) URL

func (m *MenuEntry) URL() string

type MenuQueryProvider

type MenuQueryProvider interface {
	HasMenuCurrent(menuID string, me *MenuEntry) bool
	IsMenuCurrent(menuID string, inme *MenuEntry) bool
}

func NewMenuQueryProvider

func NewMenuQueryProvider(
	pagem PageMenusGetter,
	sitem MenusGetter,
	p Page) MenuQueryProvider

type Menus

type Menus map[string]Menu

Menus is a dictionary of menus.

type MenusGetter

type MenusGetter interface {
	Menus() Menus
}

type Page

type Page interface {
	LinkTitle() string
	RelPermalink() string
	Path() string
	Section() string
	Weight() int
	IsPage() bool
	IsSection() bool
	IsAncestor(other interface{}) (bool, error)
	Params() maps.Params
}

A narrow version of page.Page.

type PageMenus

type PageMenus map[string]*MenuEntry

PageMenus is a dictionary of menus defined in the Pages.

func PageMenusFromPage

func PageMenusFromPage(p Page) (PageMenus, error)

type PageMenusGetter

type PageMenusGetter interface {
	Menus() PageMenus
}

type PageMenusProvider

type PageMenusProvider interface {
	PageMenusGetter
	MenuQueryProvider
}