Download the PHP package discoverlance/filament-page-hints without Composer

On this page you can find all versions of the php package discoverlance/filament-page-hints. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package filament-page-hints

Filament Page Hints for Filament Admin Panel

Latest Version on Packagist Total Downloads

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

You can install the package via composer:

Quickstart

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

You can publish and run the migrations with:

Optionally, you can publish the config file with:

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.

Optionally, you can publish the views using

Optionally, you can publish the translations using

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:

Add a new Hint

To add a new hint:

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

Edit a hint

To edit a hint:

Edit a hint

To delete a hint:

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

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:

An example to restrict the create action with create_hints permission will be:

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

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.


All versions of filament-page-hints with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
filament/filament Version ^2.0
illuminate/contracts Version ^9.0
spatie/laravel-package-tools Version ^1.13.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package discoverlance/filament-page-hints contains the following files

Loading the files please wait ....