The headinglevel
parameter is an optional parameter that can be:
url
argument in the $Trumba.addSpud() method.The headinglevel
parameter is an accessibility feature.
Screen reader users rely on hierarchical heading level structures to successfully navigate webpages. By default, 25Live spuds are assigned a heading level of 2 (<h2>). With the headinglevel
parameter, you can assign specific heading levels on a spud-by-spud basis, making it easy to integrate spuds into any webpage hierarchy.
For example, headinglevel: 2
sets the heading level for a spud to <h2>.
In main calendar spuds, heading level parameter settings apply to group labels (such as the current month, week, or day) and event titles.
In promotion spuds, heading level parameter settings apply to event titles.
In control spuds, heading level parameter settings apply to the spud labels.
The following image shows a screen-reader hierarchy readout for a webpage in which a calendar list, filter, view chooser, and main calendar spud are embedded. The list below the image describes the headinglevel
parameter values assigned to each spud.
url
argument, $Trumba.addSpud() method, Main calendar spudSets the main calendar view to list and applies a heading level of <h2> to the calendar's group headings and event titles. The group headings and event titles will appear indented under a top-level heading in the webpage hierarchy.
url
argument, $Trumba.addSpud() method, Filter control spudApplies a heading level of <h1> to the filter spud's label. The spud label will appear at the top level in the webpage heading hierarchy.