Navigation

data class Navigation(val tableOfContents: Boolean = false, val index: Boolean = false, val headings: Boolean = false, val page: Boolean = false) : AccessibilityMetadataDisplayGuide.Field

Identifies the navigation features included in the publication.

https://w3c.github.io/publ-a11y/a11y-meta-display-guide/2.0/guidelines/#navigation

Parameters

tableOfContents

Table of contents to all chapters of the text via links.

index

Index with links to referenced entries.

headings

Elements such as headings, tables, etc for structured navigation.

page

Page list to go to pages from the print source version.

Constructors

Link copied to clipboard
constructor(tableOfContents: Boolean = false, index: Boolean = false, headings: Boolean = false, page: Boolean = false)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Indicates whether no information about navigation features is available.

Link copied to clipboard
Link copied to clipboard
open override val shouldDisplay: Boolean

Indicates whether this display field should be rendered in the user interface, because it contains useful information.

Link copied to clipboard

List of accessibility claims to display for this field.

Link copied to clipboard

Functions

Link copied to clipboard
open override fun localizedTitle(context: Context): String

Localized title for this display field, for example to use as a section header.