One Logo Pool Ball
Accessibility · IOS API REFERENCE

AttributeScopes.AccessibilityAttributes.HeadingLevelAttribute

enum · iOS 15.0+ · SDK 27.1

@frozen enum HeadingLevelAttribute

An attribute for the level of this heading. Assistive technologies can use this property to improve navigation and describe the level number of levels ``HeadingLevel/h1`` through ``HeadingLevel/h6`` alongside the text. For example, you can rank sections within UI using a heading level. The most important section is marked with``HeadingLevel/h1``. Nested sections can use subsequent heading levels. For unranked headings, use ``HeadingLevel/unspecified``.

Members (5)

get · iOS 15.0+

markdownName

TypeScript
static get markdownName(): string
Swift declaration
static let markdownName: String

The Markdown name associated with an attributed string key.

static · iOS 15.0+

decodeMarkdown

TypeScript
static decodeMarkdown(decoder: SDKHandle): AttributeScopes_AccessibilityAttributes_HeadingLevelAttribute_HeadingLevel
Swift declaration
static func decodeMarkdown(from decoder: any Decoder) throws -> AttributeScopes.AccessibilityAttributes.HeadingLevelAttribute.HeadingLevel

Decodes a value from the provided decoder. This method throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid. - Parameter decoder: The decoder to read data from. - Returns: The decoded value.

static · iOS 15.0+

objectiveCValue

TypeScript
static objectiveCValue(value: AttributeScopes_AccessibilityAttributes_HeadingLevelAttribute_HeadingLevel): _Foundation_NSNumber
Swift declaration
static func objectiveCValue(for value: AttributeScopes.AccessibilityAttributes.HeadingLevelAttribute.HeadingLevel) throws -> NSNumber

Returns an Objective-C typed value for a given value of this key's type. - Parameter value: The value to convert. - Returns: `value`, expressed as the Objective-C type defined by ``ObjectiveCConvertibleAttributedStringKey/ObjectiveCValue``.

get · iOS 15.0+

name

TypeScript
static get nameValue(): string
Swift declaration
static var name: String { get }

The name of the key.

static · iOS 15.0+

value

TypeScript
static value(object: _Foundation_NSNumber): AttributeScopes_AccessibilityAttributes_HeadingLevelAttribute_HeadingLevel
Swift declaration
static func value(for object: NSNumber) throws -> AttributeScopes.AccessibilityAttributes.HeadingLevelAttribute.HeadingLevel

Returns a value of this key's type for a given Objective-C value. - Parameter object: The Objective-C value to convert. - Returns: `object`, expressed as this key's type.

Skipped declarations

No declarations were skipped in this snapshot.

All Accessibility types →