PHPackages                             clevyr/nova-help - 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 &amp; Helpers](/categories/utility)
4. /
5. clevyr/nova-help

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

clevyr/nova-help
================

A Laravel Nova help field.

v3.0.0(1y ago)017.4k↓12.5%1[1 issues](https://github.com/clevyr/nova-help/issues)MITPHPPHP &gt;=8.2

Since Nov 3Pushed 1y agoCompare

[ Source](https://github.com/clevyr/nova-help)[ Packagist](https://packagist.org/packages/clevyr/nova-help)[ RSS](/packages/clevyr-nova-help/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (2)Versions (6)Used By (0)

Laravel Nova Help Field
=======================

[](#laravel-nova-help-field)

A custom Nova fields which allows to show custom help messages within form, detail and index screens.

[![Base example](./docs/nova-help.jpg)](./docs/nova-help.jpg)

Changelog
---------

[](#changelog)

See [changelog here](changelog.md).

Install
-------

[](#install)

Run this command in your nova project:

```
composer require clevyr/nova-help
```

Then you can use the field in your resource as follow:

```
use Clevyr\Nova\Fields\Help\Help;

public function fields(Request $request)
{
    return [
        Help::make('Help title', 'Help message!'),
    ];
}
```

[![Base example](./docs/base.png)](./docs/base.png)

Options
-------

[](#options)

**Nova Help Field** has many options as follow:

### Default templates

[](#default-templates)

```
Help::make('title', 'message'); // Default help message
Help::success('title', 'message');
Help::info('title', 'message');
Help::warning('title', 'message');
Help::danger('title', 'message');

// There's also a special template for headings
Help::header('title', 'subtitle');

// If you prefer you can call the non static type method
Help::make('title', 'message')->type('warning');
```

#### Help templates:

[](#help-templates)

[![Base example](./docs/templates.png)](./docs/templates.png)

#### Headings template:

[](#headings-template)

[![Base example](./docs/headings.png)](./docs/headings.png)

### Both title and message are optional

[](#both-title-and-message-are-optional)

```
Help::make('Only title');
Help::make()->message('Only message');
```

### Messages can also be callable

[](#messages-can-also-be-callable)

```
Help::make()->message(function () {
    return "{$this->name} is awesome!";
});
```

### Icons

[](#icons)

You can pick one of the default SVG icons () provided by [Steve Schoger](https://twitter.com/steveschoger).

```
Help::make('Title')->icon('help'); // the default one
Help::make('Title')->icon('info');
Help::make('Title')->icon('warning');
Help::make('Title')->icon('danger');
// Load a custom one
Help::make('Love you')
    ->message('Yes, I love you!')
    ->icon('');
// or show no icon at all
Help::make('Sad')->withoutIcon();
```

[![Base example](./docs/love.png)](./docs/love.png)

### Render html messages

[](#render-html-messages)

```
Help::make('Title', 'Message with link')->displayAsHtml();
```

From v0.2 the `displayAsHtml()` method applies also to the field name (unless shown as column header on index).

### Full width on details screen

[](#full-width-on-details-screen)

```
// Remove annoing padding in detail screen, also the default behaviour for the heading template
Help::make('Negative margin')->showFullWidthOnDetail();
```

[![Base example](./docs/details-padding.png)](./docs/details-padding.png)

### With side label

[](#with-side-label)

```
// Show a side label instead of the title on the top
Help::make('Look I\'m on the side')
    ->message('I\'m not...')
    ->withSideLabel();
```

[![Base example](./docs/label.png)](./docs/label.png)

### Collapsible help fields

[](#collapsible-help-fields)

Help fields can be made collapsible using the fluent method `collapsible()`. Collapsible help fields are collapsed by default and toggle their state clicking on their title. Also, keep in mind that collapsible fields must define both a title and message and cannot be used with side labels.

```
// Collapsible field
Help::info('Click here to toggle', 'Lorem ipsum dolor sit amet...')
    ->collapsible();
```

[![Base example](./docs/collapsible.png)](./docs/collapsible.png)

### Show help messages on index

[](#show-help-messages-on-index)

```
/**
 * By default help messages aren't shown on index,
 * when enabled they are shown as an hoverable
 * icon showing a plain (no html) tooltip.
 */
Help::make('Column title')
    ->message('Message with link') // The link code will be stripped out on index
    ->alsoOnIndex();

// Field icons can be shown conditionally on index
Help::make()->message(function () {
    return $this->name?"{$this->name} is awesome!":null;
})->onlyOnIndex();
```

[![Base example](./docs/tooltip.png)](./docs/tooltip.png)

###  Health Score

40

—

FairBetter than 88% of packages

Maintenance46

Moderate activity, may be stable

Popularity27

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~170 days

Total

4

Last Release

416d ago

Major Versions

v1.0.0 → v2.0.02024-12-17

v2.0.1 → v3.0.02025-03-28

PHP version history (2 changes)v1.0.0PHP &gt;=8.1

v2.0.0PHP &gt;=8.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/826043?v=4)[Clevyr](/maintainers/clevyr)[@clevyr](https://github.com/clevyr)

---

Top Contributors

[![micc83](https://avatars.githubusercontent.com/u/1750404?v=4)](https://github.com/micc83 "micc83 (9 commits)")[![fritz-c](https://avatars.githubusercontent.com/u/4413963?v=4)](https://github.com/fritz-c "fritz-c (4 commits)")[![mikebronner](https://avatars.githubusercontent.com/u/1791050?v=4)](https://github.com/mikebronner "mikebronner (2 commits)")[![harlekoy](https://avatars.githubusercontent.com/u/10015302?v=4)](https://github.com/harlekoy "harlekoy (2 commits)")[![rimoomey](https://avatars.githubusercontent.com/u/45639947?v=4)](https://github.com/rimoomey "rimoomey (2 commits)")[![bomshteyn](https://avatars.githubusercontent.com/u/4259699?v=4)](https://github.com/bomshteyn "bomshteyn (1 commits)")[![weeg](https://avatars.githubusercontent.com/u/1826324?v=4)](https://github.com/weeg "weeg (1 commits)")[![clevyr-anthony](https://avatars.githubusercontent.com/u/138018028?v=4)](https://github.com/clevyr-anthony "clevyr-anthony (1 commits)")[![JeffBeltran](https://avatars.githubusercontent.com/u/22965241?v=4)](https://github.com/JeffBeltran "JeffBeltran (1 commits)")[![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4)](https://github.com/renovate[bot] "renovate[bot] (1 commits)")[![spaantje](https://avatars.githubusercontent.com/u/477362?v=4)](https://github.com/spaantje "spaantje (1 commits)")

---

Tags

laravelhelpnova

### Embed Badge

![Health badge](/badges/clevyr-nova-help/health.svg)

```
[![Health](https://phpackages.com/badges/clevyr-nova-help/health.svg)](https://phpackages.com/packages/clevyr-nova-help)
```

###  Alternatives

[spatie/nova-backup-tool

A Laravel Nova tool to backup your application.

361560.7k1](/packages/spatie-nova-backup-tool)[datomatic/nova-enum-field

A Laravel Nova PHP 8.1 enum field with filters

20134.2k](/packages/datomatic-nova-enum-field)[advoor/nova-editor-js

A Laravel Nova field bringing EditorJs magic to Nova.

92179.0k3](/packages/advoor-nova-editor-js)[simplesquid/nova-enum-field

A Laravel Nova field to add enums to resources.

52391.9k2](/packages/simplesquid-nova-enum-field)[genealabs/laravel-changelog

A Laravel Nova tool.

55250.7k](/packages/genealabs-laravel-changelog)[sbine/route-viewer

A Laravel Nova tool to view your registered routes.

57215.9k](/packages/sbine-route-viewer)

PHPackages © 2026

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