ReferencepaginatorControls

<paginatorControls>

Previous/next page controls referencing a paginator elsewhere in the document

<paginatorControls> is a Sectional component that works alongside the <paginator> component to provide navigation buttons.

Attributes and Properties

Attributes for <paginatorControls>

Other (4)
nextLabel

text. Default value: Next. Label for the "next page" button.

pageLabel

text. Default value: Page. Label format for the current page indicator.

paginator

reference. Reference to the <paginator> these controls operate on.

previousLabel

text. Default value: Previous. Label for the "previous page" button.

Common to all components (9)
copy

reference. Create an independent copy of another component by reference. Enter a references a $name.

disabled

boolean. Default value: false. Whether this component is disabled and cannot be interacted with.

extend

reference. Extend another component by reference, inheriting its children and attributes. Enter a reference as $name.

fixed

boolean. Default value: false. Whether this component's value is fixed and cannot be modified.

fixLocation

boolean. Default value: false. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

hide

boolean. Default value: false. Whether to hide this component from the rendered output.

isResponse

boolean. Default value: false. Whether this component is treated as a response for the purposes of assessment.

name

text. The name used to reference this component from elsewhere in the document.

styleNumber

integer. Default value: 1. The style number used to select this component's visual styling from the available style definitions.

Properties for <paginatorControls name="p">

Other (8)
$p.disabled

boolean. Whether this component is disabled and cannot be interacted with.

$p.disabledDirectly

boolean. Whether the controls are disabled directly (rather than via inheritance).

$p.fixed

boolean. Whether this component's value is fixed and cannot be modified.

$p.fixLocation

boolean. Whether this component's location is fixed (preventing it from being moved while still allowing other modifications).

$p.hidden

boolean. Whether this component is hidden from the rendered output.

$p.nextLabel

text. Label for the "next page" button.

$p.pageLabel

text. Label format for the current page indicator.

$p.previousLabel

text. Label for the "previous page" button.

Common to all components (4)
$p.doenetML

text. The DoenetML source code that produced this component.

$p.hide

boolean. Whether to hide this component from the rendered output.

$p.isResponse

boolean. Whether this component is treated as a response for the purposes of assessment.

$p.styleNumber

integer. The style number used to select this component's visual styling from the available style definitions.

Examples

Example: <paginatorControls> with a basic <paginator>

A <paginator> component creates a separate page for each sectional component it contains. The navigation buttons for the paginator are created using the <paginatorControls> component, and may be positioned either above or below the paginator content. The paginator attribute of the <paginatorControls> component references the name of the associated <paginator> component.

Example: <paginatorControls> with custom labels

The pageLabel, nextLabel, and previousLabel attributes of the <paginatorControls> component allow customization of the text displayed on the navigation buttons.

paginatorparabola