Skip to content
Brok UI

Loading…

No results

Scroll Reveal

Open source

A two-column scroll-reveal — a sticky media panel that swaps as the reader scrolls through numbered content parts.

Preview

resources/views/blocks/scroll-reveal.blade.php Blade
@props([
    'items' => null,
])

@php
    // Scroll-reveal content (abui "Scroll Reveal Content A" shape): a sticky
    // media panel on one side that swaps as the reader scrolls through numbered
    // content parts on the other. The active part is emphasised while the rest
    // dim, and a vertical accent line lights up section by section. Driven by an
    // IntersectionObserver; reduced-motion users see every part at full opacity
    // with the media swapping instantly (no transitions).
    $items ??= [
        [
            'title' => 'Join the community',
            'description' => 'Join over a billion people around the world who come to build, connect and ship together.',
            'media' => 'from-info/30 via-info/10 to-primary/20',
            'icon' => 'M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2 M9 11a4 4 0 1 0 0-8 4 4 0 0 0 0 8 M22 21v-2a4 4 0 0 0-3-3.87 M16 3.13a4 4 0 0 1 0 7.75',
        ],
        [
            'title' => 'Bask in the spotlight',
            'description' => 'This is where attention locks in — your brand placed directly in the action, front and centre.',
            'media' => 'from-warning/30 via-warning/10 to-success/20',
            'icon' => 'M12 2v4 M12 18v4 M4.93 4.93l2.83 2.83 M16.24 16.24l2.83 2.83 M2 12h4 M18 12h4 M4.93 19.07l2.83-2.83 M16.24 7.76l2.83-2.83',
        ],
        [
            'title' => 'Drive big results',
            'description' => 'Reach massive, high-intent audiences — and turn attention into awareness, engagement and sales.',
            'media' => 'from-success/30 via-success/10 to-info/20',
            'icon' => 'M3 3v18h18 M7 16l4-4 3 3 5-6',
        ],
    ];

    $reveal = <<<'JS'
    {
        active: 0,
        reduced: window.matchMedia('(prefers-reduced-motion: reduce)').matches,
        init() {
            const sections = Array.from(this.$el.querySelectorAll('[data-reveal-index]'));
            const observer = new IntersectionObserver((entries) => {
                entries.forEach((entry) => {
                    if (entry.isIntersecting) {
                        this.active = Number(entry.target.dataset.revealIndex);
                    }
                });
            }, { rootMargin: '-45% 0px -45% 0px', threshold: 0 });
            sections.forEach((section) => observer.observe(section));
        },
    }
    JS;
@endphp

<x-ui.section
    x-data="{{ $reveal }}"
    space="xl" {{ $attributes }}
>
    <div class="mx-auto grid max-w-6xl gap-10 px-4 lg:grid-cols-2 lg:gap-16">
        {{-- Content parts --}}
        <div class="flex flex-col gap-16 sm:gap-28">
            @foreach ($items as $i => $item)
                <div
                    data-reveal-index="{{ $i }}"
                    class="flex gap-6 transition-opacity duration-500 motion-reduce:transition-none"
                    :class="(reduced || active === {{ $i }}) ? 'opacity-100' : 'opacity-40'"
                >
                    <span
                        class="text-3xl font-bold tabular-nums transition-colors duration-500 motion-reduce:transition-none sm:text-4xl"
                        :class="active === {{ $i }} ? 'text-foreground' : 'text-muted-foreground'"
                        aria-hidden="true"
                    >{{ str_pad((string) ($i + 1), 2, '0', STR_PAD_LEFT) }}</span>

                    <div
                        class="border-s-2 ps-6 transition-colors duration-500 motion-reduce:transition-none"
                        :class="active === {{ $i }} ? 'border-primary' : 'border-border'"
                    >
                        <h3 class="text-balance text-3xl font-bold tracking-tight sm:text-4xl">{{ __($item['title']) }}</h3>
                        <p class="mt-4 text-pretty text-base text-muted-foreground sm:text-lg">{{ __($item['description']) }}</p>
                    </div>
                </div>
            @endforeach
        </div>

        {{-- Sticky media that swaps with the active part --}}
        <div class="order-first lg:order-last">
            <x-ui.card class="relative aspect-[4/5] overflow-hidden p-0 lg:sticky lg:top-24">
                @foreach ($items as $i => $item)
                    <div
                        class="absolute inset-0 flex items-center justify-center bg-gradient-to-br {{ $item['media'] }} transition-opacity duration-700 ease-out motion-reduce:transition-none"
                        :class="active === {{ $i }} ? 'opacity-100' : 'opacity-0'"
                        @if (! $loop->first) x-cloak @endif
                        aria-hidden="true"
                    >
                        <span class="flex size-20 items-center justify-center rounded-lg border border-border bg-card/70 text-foreground shadow-sm backdrop-blur">
                            <svg class="size-9" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round">
                                @foreach (explode(' M', ltrim($item['icon'], 'M')) as $seg)
                                    <path d="M{{ $seg }}" />
                                @endforeach
                            </svg>
                        </span>
                        <span class="absolute bottom-4 end-5 text-5xl font-bold tabular-nums text-foreground/15">{{ str_pad((string) ($i + 1), 2, '0', STR_PAD_LEFT) }}</span>
                    </div>
                @endforeach
            </x-ui.card>
        </div>
    </div>
</x-ui.section>

Installation

terminal
php artisan ui:add blocks/scroll-reveal

Installs these dependencies automatically:

Registry contract

Install confidence

php artisan ui:add blocks/scroll-reveal writes only the generated targets below. The CLI validates each file hash before writing and prompts before replacing local changes unless --force is used.

Version
1.0.6
License
open
Stability
stable
Contract
v1
Foundation
≥ 1.0.0
Type Generated target
blade resources/views/blocks/scroll-reveal.blade.php

Registry dependencies

card section

Package dependencies

composer: jml/brok:^0.2

npm: alpinejs

Use with AI

A brief for your coding agent: what the block is, the install command, how to render it, its props and the rules. Copy it, or open a prompt about this block in an assistant.

scroll-reveal.md
# Brok UI block: Scroll Reveal (`scroll-reveal`)

A two-column scroll-reveal: a sticky media panel that swaps as the reader scrolls through numbered content parts, with the active part emphasised and a vertical accent line. Reduced-motion safe.

Brok UI is a Laravel Blade registry. `ui:add` copies this block into the app as plain Blade the app owns; it composes installed `<brok:*>` primitives and semantic design tokens.

## Install

```bash
php artisan ui:add blocks/scroll-reveal
```

## Render it

```blade
<x-blocks.scroll-reveal />
```

## Props

- `items` (mixed|null, default `null`) — Numbered content parts, each with a title, description, media gradient and icon; null falls back to sample data.

## Use when

- Telling a short numbered story where a sticky media panel swaps as the reader scrolls through content parts.
- Wanting scroll-driven emphasis on the active part without pulling in a full scrollytelling library.

## Avoid when

- Needing a static two-column layout without scroll-driven behaviour; use features-cards or another plain features block instead.

## Rules

- Render the installed block with `<x-blocks.scroll-reveal />` and pass data through its props; edit the copied file only for structural changes.
- Keep the semantic design tokens (`bg-background`, `text-muted-foreground`); never swap in raw colour utilities.
- Keep the `data-slot` attributes and the logical (start/end) spacing so the markup still mirrors under `dir="rtl"`.

## Links

- Docs: https://brokui.dev/blocks/scroll-reveal
- Registry JSON (files, props, contract): https://brokui.dev/r/open/blocks/scroll-reveal.json

Working in Claude Code, Cursor or Codex? Give the agent the whole registry through the MCP server or the Brok UI skill.

Guidance

Use when

  • Telling a short numbered story where a sticky media panel swaps as the reader scrolls through content parts.
  • Wanting scroll-driven emphasis on the active part without pulling in a full scrollytelling library.

Avoid when

  • Needing a static two-column layout without scroll-driven behaviour; use features-cards or another plain features block instead.

Anti-patterns

  • Do not replace semantic props with conflicting utility classes.
  • Do not remove labels, focus styles, or state attributes.

Usage

Render the block as a component, passing data where useful:

resources/views/welcome.blade.php Blade
<x-blocks.scroll-reveal />

Built from primitives

Composes <brok:*> Semantic tokens Re-themeable RTL-ready

This block composes installed <brok:*> primitives and semantic design tokens only — it does not reimplement any primitive. Re-theme it (light, dark, admin, customer) by editing CSS variables; flip the preview to RTL to confirm it mirrors.

Source

The exact, editable file ui:add writes into your app. The preview above renders this same source — there are no preview-only blocks.

resources/views/blocks/scroll-reveal.blade.php Blade
@props([
    'items' => null,
])

@php
    // Scroll-reveal content (abui "Scroll Reveal Content A" shape): a sticky
    // media panel on one side that swaps as the reader scrolls through numbered
    // content parts on the other. The active part is emphasised while the rest
    // dim, and a vertical accent line lights up section by section. Driven by an
    // IntersectionObserver; reduced-motion users see every part at full opacity
    // with the media swapping instantly (no transitions).
    $items ??= [
        [
            'title' => 'Join the community',
            'description' => 'Join over a billion people around the world who come to build, connect and ship together.',
            'media' => 'from-info/30 via-info/10 to-primary/20',
            'icon' => 'M16 21v-2a4 4 0 0 0-4-4H6a4 4 0 0 0-4 4v2 M9 11a4 4 0 1 0 0-8 4 4 0 0 0 0 8 M22 21v-2a4 4 0 0 0-3-3.87 M16 3.13a4 4 0 0 1 0 7.75',
        ],
        [
            'title' => 'Bask in the spotlight',
            'description' => 'This is where attention locks in — your brand placed directly in the action, front and centre.',
            'media' => 'from-warning/30 via-warning/10 to-success/20',
            'icon' => 'M12 2v4 M12 18v4 M4.93 4.93l2.83 2.83 M16.24 16.24l2.83 2.83 M2 12h4 M18 12h4 M4.93 19.07l2.83-2.83 M16.24 7.76l2.83-2.83',
        ],
        [
            'title' => 'Drive big results',
            'description' => 'Reach massive, high-intent audiences — and turn attention into awareness, engagement and sales.',
            'media' => 'from-success/30 via-success/10 to-info/20',
            'icon' => 'M3 3v18h18 M7 16l4-4 3 3 5-6',
        ],
    ];

    $reveal = <<<'JS'
    {
        active: 0,
        reduced: window.matchMedia('(prefers-reduced-motion: reduce)').matches,
        init() {
            const sections = Array.from(this.$el.querySelectorAll('[data-reveal-index]'));
            const observer = new IntersectionObserver((entries) => {
                entries.forEach((entry) => {
                    if (entry.isIntersecting) {
                        this.active = Number(entry.target.dataset.revealIndex);
                    }
                });
            }, { rootMargin: '-45% 0px -45% 0px', threshold: 0 });
            sections.forEach((section) => observer.observe(section));
        },
    }
    JS;
@endphp

<x-ui.section
    x-data="{{ $reveal }}"
    space="xl" {{ $attributes }}
>
    <div class="mx-auto grid max-w-6xl gap-10 px-4 lg:grid-cols-2 lg:gap-16">
        {{-- Content parts --}}
        <div class="flex flex-col gap-16 sm:gap-28">
            @foreach ($items as $i => $item)
                <div
                    data-reveal-index="{{ $i }}"
                    class="flex gap-6 transition-opacity duration-500 motion-reduce:transition-none"
                    :class="(reduced || active === {{ $i }}) ? 'opacity-100' : 'opacity-40'"
                >
                    <span
                        class="text-3xl font-bold tabular-nums transition-colors duration-500 motion-reduce:transition-none sm:text-4xl"
                        :class="active === {{ $i }} ? 'text-foreground' : 'text-muted-foreground'"
                        aria-hidden="true"
                    >{{ str_pad((string) ($i + 1), 2, '0', STR_PAD_LEFT) }}</span>

                    <div
                        class="border-s-2 ps-6 transition-colors duration-500 motion-reduce:transition-none"
                        :class="active === {{ $i }} ? 'border-primary' : 'border-border'"
                    >
                        <h3 class="text-balance text-3xl font-bold tracking-tight sm:text-4xl">{{ __($item['title']) }}</h3>
                        <p class="mt-4 text-pretty text-base text-muted-foreground sm:text-lg">{{ __($item['description']) }}</p>
                    </div>
                </div>
            @endforeach
        </div>

        {{-- Sticky media that swaps with the active part --}}
        <div class="order-first lg:order-last">
            <x-ui.card class="relative aspect-[4/5] overflow-hidden p-0 lg:sticky lg:top-24">
                @foreach ($items as $i => $item)
                    <div
                        class="absolute inset-0 flex items-center justify-center bg-gradient-to-br {{ $item['media'] }} transition-opacity duration-700 ease-out motion-reduce:transition-none"
                        :class="active === {{ $i }} ? 'opacity-100' : 'opacity-0'"
                        @if (! $loop->first) x-cloak @endif
                        aria-hidden="true"
                    >
                        <span class="flex size-20 items-center justify-center rounded-lg border border-border bg-card/70 text-foreground shadow-sm backdrop-blur">
                            <svg class="size-9" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.75" stroke-linecap="round" stroke-linejoin="round">
                                @foreach (explode(' M', ltrim($item['icon'], 'M')) as $seg)
                                    <path d="M{{ $seg }}" />
                                @endforeach
                            </svg>
                        </span>
                        <span class="absolute bottom-4 end-5 text-5xl font-bold tabular-nums text-foreground/15">{{ str_pad((string) ($i + 1), 2, '0', STR_PAD_LEFT) }}</span>
                    </div>
                @endforeach
            </x-ui.card>
        </div>
    </div>
</x-ui.section>

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.0.6
Status
Stable
License
open
Deprecation
Not deprecated
Contract
v1
Foundation
≥ 1.0.0