yugo / filament-quran

dev-main 2026-09-17 14:24 UTC

Requires

• php: ^8.3
• filament/filament: ^5.0
• illuminate/cache: ^11.0|^12.0|^13.0
• illuminate/config: ^11.0|^12.0|^13.0
• illuminate/contracts: ^11.0|^12.0|^13.0
• illuminate/http: ^11.0|^12.0|^13.0
• illuminate/support: ^11.0|^12.0|^13.0
• yugo/laravel-quran: ^0.2

Requires (Dev)

• laravel/pint: ^1.24
• orchestra/testbench: ^10.0|^11.0
• pestphp/pest: ^4.0
• pestphp/pest-plugin-laravel: ^4.0
• phpunit/phpunit: ^12.0

MIT

• Yugo

Published on Packagist.org on 2026-09-17 14:24 UTC

README

Filament Quran provides a Quran dashboard widget for Laravel Filament applications.

Quran data is provided by Yugo Quran Manager, a standalone Laravel package that can also be used outside Filament.

Installation

Install the package with Composer:

composer require yugo/filament-quran

Register the plugin in the Filament panel provider:

use Filament\Panel;
use Yugo\FilamentQuran\FilamentQuranPlugin;

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

Publish the configuration file when you need to customize the defaults:

php artisan vendor:publish --tag=filament-quran-config

Publish Filament assets after installing or updating the package:

php artisan filament:assets

The plugin adds the Quran widget to the configured Filament dashboard.

Configuration

Widget settings are configured through environment variables:

FILAMENT_QURAN_WIDGET_COLUMN_SPAN=full
FILAMENT_QURAN_WIDGET_DISPLAY_MODE=single

For complete installation instructions, provider configuration, caching, the Quran facade, and custom provider usage, see the Yugo Quran Manager README.

Set FILAMENT_QURAN_WIDGET_DISPLAY_MODE to all to display every verse in the active surah:

FILAMENT_QURAN_WIDGET_DISPLAY_MODE=all

The default single mode displays one verse at a time with surah and verse navigation.

The widget selects a translation using the application's locale. If that locale is unavailable, it falls back to Indonesian and then to the first available translation.