Skip to content

No results for

↑ ↓ navigate ↵ open Esc close 
php artisan aura:add reading-minimap

Copies the component source into resources/views/components/aura/. Run php artisan aura:init first if you haven't already. See the CLI guide for all options.

composer require bluestarsystem/aura-ui
php artisan aura:install

Full installation instructions in the Installation guide.

Pro Component — This component requires an Aura UI Pro license.

Overview

<x-aura::reading-minimap> draws one tick per section and highlights the current one. It must sit inside reading-shell.

Basic Usage

<x-aura::reading-spine>
    <x-aura::reading-minimap :items="$headings" />
</x-aura::reading-spine>

Props

Prop Type Default Description
items array [] Strings, or arrays with id and label.
label string|null null Unused — see below.

Why it is hidden from assistive technology

The table of contents a few centimetres away already carries this information as named links. A second copy, made of unlabelled ticks, is not an improvement — it is the same navigation in a worse form. So this is aria-hidden: sighted pointer users gain an affordance and nobody loses one.