PHPackages                             discoverlance/filament-page-hints - 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. [Utility & Helpers](/categories/utility)
4. /
5. discoverlance/filament-page-hints

ActiveLibrary[Utility & Helpers](/categories/utility)

discoverlance/filament-page-hints
=================================

Create hints for your Filament pages that can serve as a guideline for users.

v1.0.3(3y ago)15147↓100%5[2 issues](https://github.com/discoverlance-com/filament-page-hints/issues)[3 PRs](https://github.com/discoverlance-com/filament-page-hints/pulls)MITPHPPHP ^8.1

Since Feb 18Pushed 2y ago2 watchersCompare

[ Source](https://github.com/discoverlance-com/filament-page-hints)[ Packagist](https://packagist.org/packages/discoverlance/filament-page-hints)[ Docs](https://github.com/discoverlance-com/filament-page-hints)[ RSS](/packages/discoverlance-filament-page-hints/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (7)Dependencies (18)Versions (10)Used By (0)

Filament Page Hints for Filament Admin Panel
============================================

[](#filament-page-hints-for-filament-admin-panel)

[![Latest Version on Packagist](https://camo.githubusercontent.com/4f43561e7c72d4a86e1094f1bb87baf2e90ac4088a1e42eed044d49d9bdee65e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646973636f7665726c616e63652f66696c616d656e742d706167652d68696e74732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/discoverlance/filament-page-hints)[![Total Downloads](https://camo.githubusercontent.com/b53eceec3f6410334312570839ea57ad65f1273f041d282080006451ee00178c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646973636f7665726c616e63652f66696c616d656e742d706167652d68696e74732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/discoverlance/filament-page-hints)

Create hints for your Filament pages that can serve as a guideline for users. You can create hints for each page and it will open a sidebar when the user clicks on it to view hints for a page.

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

[](#installation)

You can install the package via composer:

```
composer require discoverlance/filament-page-hints
```

### Quickstart

[](#quickstart)

To quickly get started, you can install the package config, migration and optionally run the your migrations with the commmand:

```
php artisan filament-page-hints:install
```

You can publish and run the migrations with:

```
php artisan vendor:publish --tag="filament-page-hints-migrations"
php artisan migrate
```

Optionally, you can publish the config file with:

```
php artisan vendor:publish --tag="filament-page-hints-config"
```

This is the contents of the published config file, find options such as setting a different table name, and updating the icon and class used for styling parts of the hint feature.

```
return [
    /**
     * Filament page table
     */
    'table_name' => 'filament_page_hints',
    /**
     * This is the icon of the hint button in the topbar
     */
    'hint_icon' => 'heroicon-o-question-mark-circle',

    /**
     * The class of the hint button can be changed here
     */
    'hint_class' => 'w-5 h-5 cursor-pointer text-gray-800 dark:text-white',

    /**
     * Creating or updating a hint button color can be changed here
     */
    'upsert_hint_button_color' => 'success',
    'delete_hint_button_color' => 'warning',

    /**
     * Use this option to control whether you want to show the page hint resource in the navigation.
     */
    'show_resource_in_navigation' => true,
    /**
     * Rich Text Editor used for hints toolbar buttons can be edited here.
     */
    'toolbar_buttons' => [
        'blockquote',
        'bold',
        'bulletList',
        'codeBlock',
        'h3',
        'italic',
        'link',
        'orderedList',
        'strike',
    ],
];
```

Optionally, you can publish the views using

```
php artisan vendor:publish --tag="filament-page-hints-views"
```

Optionally, you can publish the translations using

```
php artisan vendor:publish --tag="filament-page-hints-translations"
```

Usage
-----

[](#usage)

To show hints in the application for users to access, you will need to have at least published your migration. You can change the table name using the config option:

```
'table_name' => 'filament_page_hints'
```

### Add a new Hint

[](#add-a-new-hint)

To add a new hint:

- Click on the hint icon on the topbar.
- Click on **New Hint**.
- Fill in the form to create a new hint.

You can update the `RichEditor` component's toolbar used for the hint in your config option (`'toolbar_buttons' => [...]`)

### Edit a hint

[](#edit-a-hint)

To edit a hint:

- Click on the hint icon on the topbar.
- Click on **Edit Hint**.
- Make your updates and submit the form.

### Edit a hint

[](#edit-a-hint-1)

To delete a hint:

- Click on the hint icon on the topbar.
- Click on **Delete Hint**.

### Store and Seed database with page hints

[](#store-and-seed-database-with-page-hints)

As a convienient helper, you can run the command `php artisan filament-page-hints:seeder` and it will load all your current page hints into a seeder class, `database\seeder\PageHintSeeder`.

> NOTE: If you have quotes, like single quote in your hint from the database, you might have to fix this more manually with escape (/). I was not able to find a way to fix that so for now as even `addslashes` was adding double // instead of one /, so ensure that after you generate your seeder class, you check the `$allPageHints` array (json) to make sure there are no issues with quotes.

### Adding permissions to hint operations

[](#adding-permissions-to-hint-operations)

Because there's not a global method for assigning permissions in filament admin panel as you might be using `filament-shield` or a different package to handle your user permissions, for now, this is a suggestive approach to handling this:

You can mostly do this in the blade:

```
// First publish the views _if you have not already done_ so with the command:
php artisan vendor:publish --tag="filament-page-hints-views"
```

An example to restrict the create action with **create\_hints** permission will be:

```
// `views/vendor/filament-page-hints/components/modal/actions.blade.php`
// hide the create action
@can('create_hints')

        ... // other blade code here

@endcan

// `views/vendor/filament-page-hints/page-hints.blade.php`
// also hide the create/edit modal
@can('create_hints')

        ... // other blade code here

@endcan
```

If you want to also hide the edit/delete actions, you can do so in the `views/vendor/filament-page-hints/components/modal/index.blade.php`

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

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

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

[](#contributing)

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

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Lance Armah-Abraham](https://github.com/discoverlance-com)
- [All Contributors](../../contributors)

License
-------

[](#license)

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

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance17

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 95% 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

7

Last Release

1173d ago

Major Versions

0.0.3 → 1.0.02023-02-19

### Community

Maintainers

![](https://www.gravatar.com/avatar/f597442ac77a1cb1f0bf740a42939602740f657242428e70ec92c09de268ffdc?d=identicon)[discoverlance-com](/maintainers/discoverlance-com)

---

Top Contributors

[![discoverlance-com](https://avatars.githubusercontent.com/u/52635726?v=4)](https://github.com/discoverlance-com "discoverlance-com (38 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (1 commits)")

---

Tags

laravelfilament-pluginfilament-admindiscoverlance-comfilament-page-hints

###  Code Quality

TestsPest

Code StyleLaravel Pint

### Embed Badge

![Health badge](/badges/discoverlance-filament-page-hints/health.svg)

```
[![Health](https://phpackages.com/badges/discoverlance-filament-page-hints/health.svg)](https://phpackages.com/packages/discoverlance-filament-page-hints)
```

###  Alternatives

[guava/calendar

Adds support for vkurko/calendar to Filament PHP.

298241.0k3](/packages/guava-calendar)[pboivin/filament-peek

Full-screen page preview modal for Filament

253319.6k12](/packages/pboivin-filament-peek)[bezhansalleh/filament-google-analytics

Google Analytics integration for FilamentPHP

205144.8k5](/packages/bezhansalleh-filament-google-analytics)[dotswan/filament-map-picker

Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications.

124139.3k2](/packages/dotswan-filament-map-picker)[creagia/filament-code-field

A Filamentphp input field to edit or view code data.

58289.3k3](/packages/creagia-filament-code-field)[hydrat/filament-table-layout-toggle

Filament plugin adding a toggle button to tables, allowing user to switch between Grid and Table layouts.

6292.3k1](/packages/hydrat-filament-table-layout-toggle)

PHPackages © 2026

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