PHPackages                             qalainau/filament-univer-sheet - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF &amp; Document Generation](/categories/documents)
4. /
5. qalainau/filament-univer-sheet

ActiveLibrary[PDF &amp; Document Generation](/categories/documents)

qalainau/filament-univer-sheet
==============================

Univer Sheet spreadsheet components for Filament

v1.1.0(1mo ago)9457↓40%5MITPHPPHP ^8.3CI passing

Since Apr 19Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/qalainau/filament-univer-sheet)[ Packagist](https://packagist.org/packages/qalainau/filament-univer-sheet)[ Docs](https://github.com/qalainau/filament-univer-sheet)[ RSS](/packages/qalainau-filament-univer-sheet/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (6)Versions (3)Used By (0)

Filament Univer Sheet
=====================

[](#filament-univer-sheet)

[![Latest Version on Packagist](https://camo.githubusercontent.com/f93b5f17c55abdb212e8f2ddbad1433816b749f19aa24cde770e69ec537fa91a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f71616c61696e61752f66696c616d656e742d756e697665722d73686565742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/qalainau/filament-univer-sheet)[![GitHub Tests Action Status](https://camo.githubusercontent.com/cc8d94e91eada061535487986345c679c5f6fee350777be5a7b3e5d97f2841b4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f71616c61696e61752f66696c616d656e742d756e697665722d73686565742f63692e796d6c3f6272616e63683d6d61696e266c6162656c3d7465737473267374796c653d666c61742d737175617265)](https://github.com/qalainau/filament-univer-sheet/actions?query=workflow%3ACI+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/85f295a71df63d7bb03bb13db0aef4378dc84cfec57bce55b2826e064c65aa28/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f71616c61696e61752f66696c616d656e742d756e697665722d73686565742e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/qalainau/filament-univer-sheet)

A [Filament](https://filamentphp.com) plugin that integrates [Univer Sheet](https://github.com/dream-num/univer) — a powerful, modern spreadsheet engine — as form fields, infolist entries, and table columns.

[![Filament Univer Sheet](art/screenshot.png)](art/screenshot.png)

Table of Contents
-----------------

[](#table-of-contents)

- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
    - [Form Field](#form-field)
    - [Infolist Entry](#infolist-entry)
    - [Table Column](#table-column)
    - [Database Setup](#database-setup)
- [Configuration](#configuration)
    - [Plugin Configuration](#plugin-configuration)
    - [Config File](#config-file)
- [API Reference](#api-reference)
    - [SpreadsheetField](#spreadsheetfield)
    - [SpreadsheetEntry](#spreadsheetentry)
    - [SpreadsheetColumn](#spreadsheetcolumn)
- [Development](#development)
- [Testing](#testing)
- [Changelog](#changelog)
- [License](#license)

Features
--------

[](#features)

- Full spreadsheet editor in Filament forms with toolbar, formula bar, and multi-sheet support
- Read-only spreadsheet display in infolists (editing disabled, selection disabled)
- Compact spreadsheet preview in table columns with row numbers
- Data persisted as JSON — compatible with Eloquent's `json` cast
- Configurable toolbar, formula bar, header bar, sheet tab, and context menu visibility
- Ribbon type selection (collapsed, simple, classic)
- English and Japanese translations included
- Supports Filament 5.x

Requirements
------------

[](#requirements)

- PHP 8.3+
- Laravel 11+
- Filament 5.x

Installation
------------

[](#installation)

Install the package via Composer:

```
composer require qalainau/filament-univer-sheet
```

Publish the Filament assets:

```
php artisan filament:assets
```

Register the plugin in your panel provider:

```
use Qalainau\UniverSheet\UniverSheetPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            UniverSheetPlugin::make(),
        ]);
}
```

Optionally, publish the config file:

```
php artisan vendor:publish --tag=filament-univer-sheet-config
```

Usage
-----

[](#usage)

### Form Field

[](#form-field)

Use `SpreadsheetField` to add a full spreadsheet editor to your forms:

```
use Qalainau\UniverSheet\SpreadsheetField;

public static function form(Schema $schema): Schema
{
    return $schema
        ->components([
            SpreadsheetField::make('data')
                ->columnSpanFull(),
        ]);
}
```

You may customize the appearance:

```
SpreadsheetField::make('data')
    ->height('600px')
    ->minHeight('400px')
    ->showToolbar(false)
    ->showFormulaBar(false)
    ->showSheetTabs(false)
    ->showHeaderBar(false)
    ->showContextMenu(false)
    ->ribbonType('collapsed') // 'collapsed', 'simple', or 'classic'
    ->columnSpanFull(),
```

### Infolist Entry

[](#infolist-entry)

Use `SpreadsheetEntry` to display spreadsheet data in a read-only view. Editing and selection are automatically disabled:

```
use Qalainau\UniverSheet\SpreadsheetEntry;

public static function infolist(Schema $schema): Schema
{
    return $schema
        ->components([
            SpreadsheetEntry::make('data')
                ->height('500px')
                ->columnSpanFull(),
        ]);
}
```

Note

By default, `SpreadsheetEntry` hides the toolbar and formula bar. You may re-enable them with `->showToolbar()` and `->showFormulaBar()`.

### Table Column

[](#table-column)

Use `SpreadsheetColumn` to show a compact spreadsheet preview in your table:

```
use Qalainau\UniverSheet\SpreadsheetColumn;

public static function table(Table $table): Table
{
    return $table
        ->columns([
            SpreadsheetColumn::make('data')
                ->previewRows(6)
                ->previewColumns(5),
        ]);
}
```

The preview renders as a mini spreadsheet with row numbers, header styling, and right-aligned numbers.

### Database Setup

[](#database-setup)

Store spreadsheet data in a `longText` or `json` column:

```
// Migration
Schema::create('spreadsheets', function (Blueprint $table) {
    $table->id();
    $table->string('name');
    $table->longText('data')->nullable();
    $table->timestamps();
});
```

```
// Model
protected $fillable = ['name', 'data'];

protected function casts(): array
{
    return [
        'data' => 'json',
    ];
}
```

Warning

Do not use `dehydrateStateUsing(fn ($state) => json_encode($state))`. Eloquent's JSON cast handles serialization automatically — double-encoding will corrupt the data.

Configuration
-------------

[](#configuration)

### Plugin Configuration

[](#plugin-configuration)

Configure defaults via the plugin instance in your panel provider:

```
UniverSheetPlugin::make()
    ->showToolbar(false)
    ->showFormulaBar(false)
    ->showSheetTabs(false)
    ->showHeaderBar(false)
    ->showContextMenu(false)
    ->ribbonType('collapsed')
    ->locale('ja-JP'),
```

### Config File

[](#config-file)

After publishing, you may edit `config/univer-sheet.php`:

```
return [
    'show_toolbar' => true,
    'show_formula_bar' => true,
    'show_sheet_tabs' => true,
    'show_header_bar' => true,
    'show_context_menu' => true,
    'ribbon_type' => null, // 'collapsed', 'simple', or 'classic'
    'locale' => 'en-US',
];
```

API Reference
-------------

[](#api-reference)

### SpreadsheetField

[](#spreadsheetfield)

MethodDefaultDescription`height(string|Closure|null)``null` (`60vh`)Fixed height of the spreadsheet`minHeight(string|Closure)``'400px'`Minimum height`showToolbar(bool|Closure)``true`Show/hide the toolbar`showFormulaBar(bool|Closure)``true`Show/hide the formula bar`showSheetTabs(bool|Closure)``true`Show/hide sheet tabs at the bottom`showHeaderBar(bool|Closure)``true`Show/hide the header bar (ribbon tabs, toolbar, formula bar area)`showContextMenu(bool|Closure)``true`Show/hide the right-click context menu`ribbonType(string|Closure|null)``null`Ribbon display style: `'collapsed'`, `'simple'`, or `'classic'`### SpreadsheetEntry

[](#spreadsheetentry)

MethodDefaultDescription`height(string|Closure)``'300px'`Height of the spreadsheet`showToolbar(bool|Closure)``false`Show/hide the toolbar`showFormulaBar(bool|Closure)``false`Show/hide the formula bar`showSheetTabs(bool|Closure)``true`Show/hide sheet tabs`showHeaderBar(bool|Closure)``false`Show/hide the header bar`showContextMenu(bool|Closure)``false`Show/hide the right-click context menu`ribbonType(string|Closure|null)``null`Ribbon display style### SpreadsheetColumn

[](#spreadsheetcolumn)

MethodDefaultDescription`previewRows(int|Closure)``4`Number of rows to display`previewColumns(int|Closure)``4`Number of columns to display`previewHeight(string|Closure|null)``null` (auto)Max height of the previewDevelopment
-----------

[](#development)

### Building JS Assets

[](#building-js-assets)

The plugin bundles [Univer Sheet](https://github.com/dream-num/univer) via esbuild. To rebuild:

```
cd packages/filament-univer-sheet
npm install
node bin/build.js
```

Then publish the assets from the project root:

```
php artisan filament:assets
```

### Watch Mode

[](#watch-mode)

```
node bin/build.js --watch
```

Testing
-------

[](#testing)

```
php artisan test --testsuite=UniverSheet
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Univer](https://github.com/dream-num/univer) — The spreadsheet engine
- [Filament](https://filamentphp.com) — The admin panel framework

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

This package bundles [Univer](https://github.com/dream-num/univer) which is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). See [NOTICE](NOTICE) for details of bundled third-party dependencies.

###  Health Score

47

—

FairBetter than 93% of packages

Maintenance90

Actively maintained with recent releases

Popularity26

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity50

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

50d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8680efcea0de29a5992da943fd048e5fe313832f65c4ed0a45d86efb1969adc0?d=identicon)[qalainau](/maintainers/qalainau)

---

Top Contributors

[![qalainau](https://avatars.githubusercontent.com/u/238779?v=4)](https://github.com/qalainau "qalainau (11 commits)")

---

Tags

laravelexcelspreadsheetfilamentuniver

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/qalainau-filament-univer-sheet/health.svg)

```
[![Health](https://phpackages.com/badges/qalainau-filament-univer-sheet/health.svg)](https://phpackages.com/packages/qalainau-filament-univer-sheet)
```

###  Alternatives

[rawilk/profile-filament-plugin

Profile &amp; MFA starter kit for filament.

3913.7k](/packages/rawilk-profile-filament-plugin)[stephenjude/filament-jetstream

A Laravel starter kit built with Filament inspired by Jetstream.

17758.9k2](/packages/stephenjude-filament-jetstream)[stephenjude/filament-two-factor-authentication

Filament Two Factor Authentication: Google 2FA + Passkey Authentication

84192.9k7](/packages/stephenjude-filament-two-factor-authentication)[marcelweidum/filament-passkeys

Use passkeys in your filamentphp app

6643.3k](/packages/marcelweidum-filament-passkeys)[jibaymcs/filament-tour

Bring the power of DriverJs to your Filament panels and start a tour !

12351.0k](/packages/jibaymcs-filament-tour)[mradder/filament-logger

Audit logging, activity tracking, exports, alerts, and dashboards for Filament admin panels.

2210.5k](/packages/mradder-filament-logger)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
