README

Filament Check Whois Widget

The Filament Check Whois Widget is a package for the Filament PHP framework that allows you to easily check the WHOIS information for domains. It integrates seamlessly with Filament's AdminPanel, providing a clean and user-friendly interface. The widget fetches WHOIS data using an external API (requiring an API key), displaying key details like registrant information, registration date, and expiry date. Configuration options allow for customization of the widget's appearance and behavior, such as setting the number of domains displayed per row, the column span, and whether to show a title. This simplifies the process of obtaining crucial domain information within your Filament application.

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-check-whois-widget

You can publish the config file with:

php artisan vendor:publish --tag="filament-check-whois-widget-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-check-whois-widget-views"

This is the contents of the published config file:

return [
    'ip2_whois_api_key' => env('CHECK_WHOIS_API_KEY'),
];

Usage

Add in AdminPanelProvider.php

use JeffersonGoncalves\FilamentCheckWhoisWidget\FilamentCheckWhoisWidgetPlugin;

->plugins([
    FilamentCheckWhoisWidgetPlugin::make()
        ->domains([
            'filamentphp.com'
        ])
])

Optionally, you can add more configs as example below:

use JeffersonGoncalves\FilamentCheckWhoisWidget\FilamentCheckWhoisWidgetPlugin;

FilamentCheckWhoisWidgetPlugin::make()
    ->domains([
        'filamentphp.com'
    ])
    ->shouldShowTitle(false) // Optional show title default is: true
    ->setTitle('Whois') // Optional
    ->setDescription('Whois detail')  // Optional
    ->setQuantityPerRow(1) //Optional quantity per row default is: 1
    ->setColumnSpan('full') //Optional column span default is: '1/2' 
    ->setSort(10)

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

jeffersongoncalves / filament-check-whois-widget

Maintainers

Details