Download the PHP package qalainau/filament-univer-sheet without Composer
On this page you can find all versions of the php package qalainau/filament-univer-sheet. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download qalainau/filament-univer-sheet
More information about qalainau/filament-univer-sheet
Files in qalainau/filament-univer-sheet
Package filament-univer-sheet
Short Description Univer Sheet spreadsheet components for Filament
License MIT
Homepage https://github.com/qalainau/filament-univer-sheet
Informations about the package filament-univer-sheet
Filament Univer Sheet
A Filament plugin that integrates Univer Sheet — a powerful, modern spreadsheet engine — as form fields, infolist entries, and table columns.
Table of Contents
- Features
- Requirements
- Installation
- Usage
- Form Field
- Infolist Entry
- Table Column
- Database Setup
- Configuration
- Plugin Configuration
- Config File
- API Reference
- SpreadsheetField
- SpreadsheetEntry
- SpreadsheetColumn
- Development
- Testing
- Changelog
- License
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
jsoncast - 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
- PHP 8.3+
- Laravel 11+
- Filament 5.x
Installation
Install the package via Composer:
Publish the Filament assets:
Register the plugin in your panel provider:
Optionally, publish the config file:
Usage
Form Field
Use SpreadsheetField to add a full spreadsheet editor to your forms:
You may customize the appearance:
Infolist Entry
Use SpreadsheetEntry to display spreadsheet data in a read-only view. Editing and selection are automatically disabled:
[!NOTE] By default,
SpreadsheetEntryhides the toolbar and formula bar. You may re-enable them with->showToolbar()and->showFormulaBar().
Table Column
Use SpreadsheetColumn to show a compact spreadsheet preview in your table:
The preview renders as a mini spreadsheet with row numbers, header styling, and right-aligned numbers.
Database Setup
Store spreadsheet data in a longText or json column:
[!WARNING] Do not use
dehydrateStateUsing(fn ($state) => json_encode($state)). Eloquent's JSON cast handles serialization automatically — double-encoding will corrupt the data.
Configuration
Plugin Configuration
Configure defaults via the plugin instance in your panel provider:
Config File
After publishing, you may edit config/univer-sheet.php:
API Reference
SpreadsheetField
| Method | Default | Description |
|---|---|---|
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
| Method | Default | Description |
|---|---|---|
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
| Method | Default | Description |
|---|---|---|
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 preview |
Development
Building JS Assets
The plugin bundles Univer Sheet via esbuild. To rebuild:
Then publish the assets from the project root:
Watch Mode
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
The MIT License (MIT). Please see License File for more information.
This package bundles Univer which is licensed under the Apache License 2.0. See NOTICE for details of bundled third-party dependencies.
All versions of filament-univer-sheet with dependencies
filament/filament Version ^5.0
spatie/laravel-package-tools Version ^1.15 || ^2.0