Skip to content
Brok UI

Loading…

No results

Document Viewers

Pro

Pro viewers for the common document formats — PDF, Word, Excel and CSV.

Version
v1.2.0
Stability
stable
License
Commercial license
Related
PDF Viewer
DOCX Viewer
CSV Viewer

Excel Viewer — Renders an .xlsx workbook (fetched from `src` or given inline as `data`) as a token-styled table with sheet tabs inside document-frame; `editable` turns every cell into a contenteditable textbox that dispatches `workbook-change` with the in-memory sheets.

Preview

Workbook
Loading workbook…

Read-only spreadsheet view of a workbook.

previews.components.excel-viewer.default.blade.php Blade
<div class="mx-auto h-[32rem] w-full max-w-4xl">
    <x-ui.excel-viewer src="/samples/sample.xlsx" />
</div>

Installation

terminal
php artisan ui:add pro/excel-viewer

Note

This component ships an Alpine behavior module at resources/js/ui/excel-viewer.js. Import it once from your bundle so it registers on alpine:init:

resources/js/ui/index.js JS
import './excel-viewer.js';

Use with AI

A brief for your coding agent: install command, usage, props, guidance and the rules. Copy it, or open a prompt about this component in an assistant.

excel-viewer.md
# Brok UI: Excel Viewer (`excel-viewer`)

Renders an .xlsx workbook (fetched from `src` or given inline as `data`) as a token-styled table with sheet tabs inside document-frame; `editable` turns every cell into a contenteditable textbox that dispatches `workbook-change` with the in-memory sheets.

Brok UI is a Laravel Blade component registry. Installed components are plain Blade files the app owns.

## Install

```bash
php artisan ui:add pro/excel-viewer
```

## Usage

```blade
<div class="mx-auto h-[32rem] w-full max-w-4xl">
    <x-ui.excel-viewer src="/samples/sample.xlsx" />
</div>
```

## Use when

- Use when users need to upload, inspect, edit, annotate, or sign real documents as part of the workflow.
- Previewing or lightly editing an .xlsx workbook with multiple sheets entirely in the browser.
- Needing an in-memory spreadsheet edit surface that dispatches a change event instead of round-tripping to a server.

## Avoid when

- Do not use a heavy document interface when the same task can be completed more simply in structured product UI.
- The source is a plain CSV with a single table; use csv-viewer for a lighter-weight viewer.
- Full spreadsheet functionality (formulas, charts, formatting) is required; this renders values as a table, not a spreadsheet engine.

## Anti-patterns

- Heavy document UI when structured fields are simpler

## Rules

- Use the `<brok:excel-viewer>` tag (or `<x-ui.excel-viewer>`) in Blade; do not rewrite the component.
- Prefer the documented props and variants over utility-class overrides; when a utility must win, use the `!` important modifier.
- Use semantic design tokens (`bg-primary`, `text-muted-foreground`), never raw colour utilities.
- Keep the `data-slot` attributes; they are the styling and test hooks.

## Links

- Docs: https://brokui.dev/docs/components/excel-viewer

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

Examples

editable.blade.php Blade
<div class="mx-auto h-[32rem] w-full max-w-4xl">
    <x-ui.excel-viewer src="/samples/sample.xlsx" editable />
</div>

API

manifest knowledge + registry-derived coverage

Props

No documented props. Pass normal Blade attributes through the component root.

Slots

  • default —

Data slots

Stable hooks for CSS overrides and browser tests.

No data-slot selectors found in the registry source.

Behavior

  • Parses the workbook client-side and renders each sheet as a token-styled table with sheet tabs to switch between them.
  • With editable set, cell edits update the in-memory sheets and dispatch a workbook-change event carrying the current data, so the host can persist it.
  • Installs a JavaScript behavior module when the registry item includes resources/js/ui files.

Guidance

Document workflow

Upload, inspect, edit, annotate, or sign a real document.

Use when

  • Use when users need to upload, inspect, edit, annotate, or sign real documents as part of the workflow.
  • Previewing or lightly editing an .xlsx workbook with multiple sheets entirely in the browser.
  • Needing an in-memory spreadsheet edit surface that dispatches a change event instead of round-tripping to a server.

Avoid when

  • Do not use a heavy document interface when the same task can be completed more simply in structured product UI.
  • The source is a plain CSV with a single table; use csv-viewer for a lighter-weight viewer.
  • Full spreadsheet functionality (formulas, charts, formatting) is required; this renders values as a table, not a spreadsheet engine.

Use instead

  • Structured product form
  • Direct data entry

Anti-patterns

  • Heavy document UI when structured fields are simpler
Anatomy
root excel-viewer-grid

Accessibility

WCAG 2.2 AA Keyboard focus-visible RTL-ready Localized labels Dark mode
Keyboard
No component-owned keyboard interaction; native element behavior applies.
Focus
none
  • Sheet tabs follow standard tab keyboard behaviour, so switching between sheets does not require a pointer.
  • The grid renders as a real table, so screen readers can navigate cells with normal table semantics.
  • Semantic HTML and a stable data-slot attribute for styling and scripting hooks.
  • Focus-visible rings use the ring token, so keyboard focus is always visible.
  • Disabled and invalid states are conveyed to assistive tech, not by color alone.
  • Targets WCAG 2.2 AA; verify contrast in light, dark, admin and customer surfaces in the preview.
  • Labels go through __() and layout uses logical properties (ms-*, text-start), so it mirrors under dir="rtl" — flip the preview to RTL to confirm.
  • Dark mode uses the same semantic tokens under the dark class; high contrast follows forced-color system tokens.

Livewire

Safe

Livewire can update this component through forwarded wire:* attributes.

Source

Source available with Pro

This preview shows the real Pro component, while its installable source is delivered only through the authenticated registry. Activate a license, then use the installation command above.

Open the authenticated source endpoint

Ownership & lifecycle

Owner, release state, review evidence and adoption for this item.
Owner
Platform UI (@JoshJML)
Current version
1.2.0
Status
Stable
License
pro
Accessibility reviewed
No review date recorded
Last breaking change
No date recorded
Deprecation
Not deprecated