Record

Frame

type Frame = {
  navbar: Array[Docgen.TocItem],
  toc: Array[Docgen.TocItem],
  trail: Array[Docgen.TocItem],
  previous: Option[Docgen.TocItem],
  next: Option[Docgen.TocItem],
  editUrl: Str,
  updated: Str,
  features: Array[Str],
  root: Str,
  pdf: Str,
  tocPath: Str,
  navPath: Str
}

View source

Navigation and history around a page

Fields

Name	Type	Description
`navbar`	`Array[Docgen.TocItem]`
`toc`	`Array[Docgen.TocItem]`
`trail`	`Array[Docgen.TocItem]`
`previous`	`Option[Docgen.TocItem]`
`next`	`Option[Docgen.TocItem]`
`editUrl`	`Str`
`updated`	`Str`
`features`	`Array[Str]`
`root`	`Str`
`pdf`	`Str`
`tocPath`	`Str`
`navPath`	`Str`

Name	Description
`view`	The view of a page: site identity, navigation, content, and interface text. Page metadata switches parts off with `_disableToc`, `_disableAffix`, `_disableBreadcrumb`, `_disableNavbar`, `_disableContribution`, `_disableNextArticle`, and `_enableSearch: false`.