readium-shared/org.readium.r2.shared.accessibility/AccessibilityMetadataDisplayGuide/AccessibilitySummary

AccessibilitySummary

data class AccessibilitySummary(val summary: String? = null) : AccessibilityMetadataDisplayGuide.Field

The accessibility summary was intended (in EPUB Accessibility 1.0) to describe in human-readable prose the accessibility features present in the publication as well as any shortcomings. Starting with EPUB Accessibility version 1.1 the accessibility summary became a human- readable summary of the accessibility that complements, but does not duplicate, the other discoverability metadata.

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

Constructors

Link copied to clipboard
constructor(summary: String? = null)

Types

Link copied to clipboard
object Companion

Properties

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
open override val statements: List<AccessibilityMetadataDisplayGuide.Statement>

List of accessibility claims to display for this field.

Link copied to clipboard
val summary: String?

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.

Generated by Dokka
© 2026 Copyright