leshkens/orchid-help-hint-layout

Orchid help hint layout

v3.0.0 2021-11-04 13:32 UTC

Requires

• php: >=7.3
• illuminate/support: ^8.0
• orchid/platform: ^10.0

Requires (Dev)

• phpunit/phpunit: ^9.0

MIT

• Leshkens

• hint
• help
• layout
• orchid

README

Installation

Install via composer: composer require leshkens/orchid-help-hint-layout

For old orchid versions:

Orchid version	Composer command
Orchid 9.x	composer require leshkens/orchid-help-hint-layout:^2.0
Orchid 8.x	composer require leshkens/orchid-help-hint-layout:^1.0

Install package migration:

php artisan migrate

Publish config file:

php artisan vendor:publish --provider="Leshkens\OrchidHelpHintLayout\Providers\ServiceProvider"

Usage

It easy. Add to you screen:

public function layout(): array
{
    return [
        HelpHintLayout::make('foobar')
    ];
}

Then add it to the hint map (in config/platform-hints.php):

'hints_map' => [
    'foobar' => 'My hint is somewhere'
],

Grant the user rights to hints and add an entry to the database in http://yousite.loc/dashboard/systems/help-hints/create

Credits

• All contributors