PageFactory (Kirby Plugin)

Nav()

Renders a navigation menu that reflects the currently published pages.

nav()

Renders a navigation menu that reflects the currently published pages.

Supported wrapperClasses:

  • pfy-nav-horizontalhorizontal navigation menu
  • pfy-nav-indented sub-elements get hierarchically indented
  • pfy-nav-collapsed sub-elements are initially collapsed and can be opened
  • pfy-nav-collapsible sub-elements are initially open and can be collapsed
  • pfy-nav-hoveropen sub-elements opened on mouse over
  • pfy-nav-open-current nav tree is pre-opened down to the current page, the rest is collapsed
  • pfy-nav-animated adds an animation effect when opening/closing
  • pfy-nav-colored applies some default coloring based on --nav-base-color1 and --nav-base-color2

Supported CSS-Variables:

Base Colors (used by pfy-nav-colored):

  • --nav-base-color1
  • --nav-base-color2

Text:

  • --pfy-nav-txt-size
  • --pfy-nav-txt-color
  • --pfy-nav-sub-txt-color
  • --pfy-nav-active-txt-color
  • --pfy-nav-curr-txt-color
  • --pfy-nav-surrogate-txt-color
  • --pfy-nav-hover-txt-color

Background and border-left:

  • --pfy-nav-bg-color
  • --pfy-nav-elem-bg-color
  • --pfy-nav-hover-bg-color
  • --pfy-nav-sub-bg-color
  • --pfy-nav-active-bg-color
  • --pfy-nav-curr-bg-color
  • --pfy-nav-surrogate-bg-color

Focus Frame Colors:

  • --pfy-focus-frame-color1
  • --pfy-focus-frame-color2

Arguments

wrapperClass
Class applied to the Nav's wrapper. (default: )
class
Class applied to the Nav element. (default: )
id
Id applied to the Nav element. (default: )
type
[top,side,branch|primary]. (default: )
isPrimary
By default, first Nav is primary. Set to false to override. (default: false)
listTag
[ul,ol] The tag to be used in list of nav-elements. (default: ol)

Examples

{{ nav() }}

Rendered Output:

Colored