Mobile Bottom Navigation for Filament

https://github.com/hammadzafar05/mobile-bottom-nav
Admin
A thumb-friendly mobile bottom navigation bar for Filament panels that automatically extracts items...
Tokens:30,668
Snippets:231
Trust Score:7.9
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example: calling packageBooted()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Example invocation of packageBooted() for documentation purposes. It is not called by application code.

```php
// Callback invoked by the package-tools boot sequence; not called by
// application code.
$provider->packageBooted();
```

--------------------------------

### make() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Example of using the static make() factory to create an item.

```php
$item = MobileBottomNavItem::make('Inbox');
```

--------------------------------

### Example: calling configurePackage()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Example invocation of configurePackage() for documentation purposes. It is not called by application code.

```php
// Invoked by laravel-package-tools during provider discovery; not
// called by application code. Shown here purely to document the contract.
$provider = new MobileBottomNavServiceProvider($app);
$provider->configurePackage($package);
```

--------------------------------

### get() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Shows how to retrieve the registered MobileBottomNav instance from anywhere in app code using MobileBottomNav::get(), then reconfigure it with fromNavigation() and moreButtonLabel(). Reconfiguration affects the registered render closure, which captures $this, and takes effect on the next panel render.

```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;

// Retrieve the registered instance from anywhere in app code.
$plugin = MobileBottomNav::get();

// Reconfiguration affects the registered render closure, which
// captures $this — take effect on the next panel render.
$plugin->fromNavigation(4)->moreButtonLabel('Menu');
```

--------------------------------

### Install via Composer

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/README.md

Run this command in your terminal to install the package. No custom theme or additional CSS configuration is required.

```bash
composer require hammadzafar05/mobile-bottom-nav
```

--------------------------------

### moreButtonLabel() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Example usage of moreButtonLabel('Menu') to set the label to 'Menu'.

```php
MobileBottomNav::make()->moreButtonLabel('Menu');
```

--------------------------------

### register() direct call example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Example of calling register() directly. Normally Filament invokes register() during panel boot for every plugin in the panel's ->plugins([...]) list. A direct call is only sensible inside custom plugin wiring, where the $panel argument comes from Filament's boot sequence.

```php
// Usually not needed in application code — Filament invokes register()
// during panel boot for every plugin in the panel's ->plugins([...]) list.
// A direct call is only sensible inside custom plugin wiring, where the
// $panel argument comes from Filament's boot sequence:

MobileBottomNav::get()->register($panel);
```

--------------------------------

### Constructor usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Shows how to instantiate MobileBottomNavItem directly with the constructor, though make() is recommended.

```php
$item = new MobileBottomNavItem('Home');
echo $item->getLabel(); // 'Home'
```

--------------------------------

### get() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Declares the static accessor method get() that returns a static instance of MobileBottomNav. It takes no parameters and retrieves the plugin instance registered with the Filament manager under getId(), using the filament() global helper.

```php
public static function get(): static
```

--------------------------------

### renderHook() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Example usage of renderHook(). Attaches the bar to the 'panels::body.start' render hook. Returns the MobileBottomNav instance for chaining.

```php
MobileBottomNav::make()->renderHook('panels::body.start');
```

--------------------------------

### getId() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Shows how to get the plugin identifier by calling getId() on a MobileBottomNav instance. The output is the string 'mobile-bottom-nav'. This identifier is used by Filament to key the plugin in its registry, and get() relies on it.

```php
$plugin = MobileBottomNav::make();

echo $plugin->getId(); // 'mobile-bottom-nav'
```

--------------------------------

### moreButton() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Example usage of moreButton(false) to disable the 'More' button and hideSidebarToggle(false) to keep the topbar hamburger visible.

```php
// No "More" button — Filament's topbar hamburger must stay visible,
// so opt out of the toggle hiding too.
MobileBottomNav::make()
    ->moreButton(false)
    ->hideSidebarToggle(false);
```

--------------------------------

### get()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Static method to retrieve the currently registered MobileBottomNav plugin instance from the Filament manager.

```APIDOC
## `get()`

### Description
Retrieves the plugin instance currently registered with the Filament manager under its ID. Requires the plugin to be registered in the panel's plugins array.

### Method
`get` (static)

### Signature
`public static function get(): static`

### Parameters
None.

### Returns
`static` (`MobileBottomNav`) — the plugin instance registered with the Filament manager, fetched via `filament(app(static::class)->getId())`.

### Example
```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;

// Retrieve the registered instance from anywhere in app code.
$plugin = MobileBottomNav::get();

// Reconfiguration affects the registered render closure, which
// captures $this — take effect on the next panel render.
$plugin->fromNavigation(4)->moreButtonLabel('Menu');
```
```

--------------------------------

### label() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Overrides the constructor label with a closure that is invoked by getLabel() on each call.

```php
MobileBottomNavItem::make('Home')
    ->label(fn () => 'Dashboard');
```

--------------------------------

### badge() setter examples

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the badge value and color. Numeric values render as a count pill, non-empty strings as a dot, and ''/null renders nothing. Color string resolves to var(--{$color}-500).

```php
MobileBottomNavItem::make('Inbox')
    ->badge(5, 'danger');
```

```php
// numeric + closure color:
MobileBottomNavItem::make('Inbox')
    ->badge(fn () => unreadCount(), fn () => 'success');
```

--------------------------------

### Publish mobile-bottom-nav views

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/configuration.md

Publishes the plugin's Blade view for customization. Run this command after installing the package, then edit the published template according to the view render data contract.

```bash
php artisan vendor:publish --tag="mobile-bottom-nav-views"
```

--------------------------------

### Getter usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Demonstrates creating a MobileBottomNavItem and calling several getters. The badge closure is re-evaluated on each call, and getBadgeColor() returns null, causing the view to fall back to var(--primary-500).

```php
$item = MobileBottomNavItem::make('Inbox')
    ->icon('heroicon-o-inbox')
    ->badge(fn () => unreadCount());

$item->getLabel();      // 'Inbox'
$item->getIcon();       // 'heroicon-o-inbox'
$item->getBadge();      // current unread count (closure re-evaluated)
$item->getBadgeColor(); // null -> view falls back to var(--primary-500)
```

--------------------------------

### hideSidebarToggle() usage example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Example usage of hideSidebarToggle(false) to keep the topbar hamburger visible.

```php
MobileBottomNav::make()->hideSidebarToggle(false); // keep the topbar hamburger
```

--------------------------------

### url() setter examples

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the link target. When unset, getUrl() returns null and the view renders an href-less anchor. Extraction mode defaults to '#' for items without a URL.

```php
MobileBottomNavItem::make('Profile')->url('/admin/profile');
```

```php
// evaluated per render:
MobileBottomNavItem::make('Settings')
    ->url(fn () => auth()->user()?->settingsUrl());
```

--------------------------------

### Register MobileBottomNav plugin on a Filament panel

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/index.md

Register the MobileBottomNav plugin on a Filament panel by adding it to the panel's plugins array. This is the minimal setup required to enable the bottom navigation bar.

```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;

public function panel(Panel $panel): Panel
{
    return $panel->plugins([
        MobileBottomNav::make(),
    ]);
}
```

--------------------------------

### badgeColor() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the badge color independently of badge(), with the same semantics as badge()'s $color parameter.

```php
MobileBottomNavItem::make('Updates')->badge('new')->badgeColor('warning');
```

--------------------------------

### sort() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the sort hint. In manual-item mode the array order is preserved; extraction mode sets it from NavigationItem::getSort().

```php
MobileBottomNavItem::make('Home')->sort(1);
```

--------------------------------

### icon() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the icon rendered via Filament's generate_icon_html at IconSize::Large.

```php
MobileBottomNavItem::make('Home')->icon('heroicon-o-home');
```

--------------------------------

### activeIcon() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the icon shown instead of icon while the item is active, based on isActiveState() and getActiveIcon().

```php
MobileBottomNavItem::make('Home')
    ->icon('heroicon-o-home')
    ->activeIcon('heroicon-s-home');
```

--------------------------------

### isActive() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets the active state. When active, the view adds the fi-active class and aria-current="page".

```php
MobileBottomNavItem::make('Admin')
    ->isActive(fn () => request()->is('admin'));
```

--------------------------------

### visible() setter example

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Sets visibility. MobileBottomNav::resolveItems() filters manual items with isVisible(), dropping invisible ones. Extraction mode never produces hidden items.

```php
MobileBottomNavItem::make('Admin')
    ->visible(fn () => auth()->user()?->isAdmin());
```

--------------------------------

### Keep sidebar toggle when More button disabled

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/README.md

When the More button is disabled, the plugin keeps Filament's topbar hamburger visible by default. This example explicitly sets hideSidebarToggle(false) to ensure the hamburger stays.

```php
MobileBottomNav::make()
    ->moreButton(false)
    ->hideSidebarToggle(false)
```

--------------------------------

### boot() method

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

No-op method required by the Filament Plugin contract. The package performs no boot-time work.

```php
public function boot(Panel $panel): void {}
```

--------------------------------

### make()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Static factory method to create or retrieve the MobileBottomNav plugin instance from the application container.

```APIDOC
## `make()`

### Description
Creates a new instance of the MobileBottomNav plugin, resolved from the application container. Repeated calls return the same container-bound instance (singleton semantics).

### Method
`make` (static)

### Signature
`public static function make(): static`

### Parameters
None.

### Returns
`static` (`MobileBottomNav`) — the plugin instance resolved from the application container via `app(static::class)`.

### Example
```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;

public function panel(Panel $panel): Panel
{
    return $panel->plugins([
        MobileBottomNav::make(),
    ]);
}
```
```

--------------------------------

### configurePackage() body

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Configures the package name, view namespace, and translations. This is the body of configurePackage().

```php
$package->name(static::$name)
    ->hasViews(static::$viewNamespace)
    ->hasTranslations();
```

--------------------------------

### make() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Declares the static factory method make() that returns a static instance of MobileBottomNav. It takes no parameters and resolves the plugin from the application container via app(static::class), with singleton semantics.

```php
public static function make(): static
```

--------------------------------

### packageBooted() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Signature of the packageBooted method, which is called during the package-tools boot sequence.

```php
public function packageBooted(): void
```

--------------------------------

### make() method definition

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Static factory method that creates a new MobileBottomNavItem instance.

```php
public static function make(string $label): static
```

--------------------------------

### Run tests with Composer

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/README.md

Use this command to execute the test suite for the package. It runs the PHPUnit tests via Composer.

```bash
composer test
```

--------------------------------

### packageBooted() body

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Registers an empty asset list under the Composer package name with FilamentAsset. This enables asset tracking for the plugin's inline style block.

```php
FilamentAsset::register(
    [],
    $this->getAssetPackageName()
);
```

--------------------------------

### MobileBottomNavItem::__construct()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Constructor for MobileBottomNavItem, accepting a label string. It is final and used internally; instances should be created via the make() factory.

```APIDOC
## `__construct()` (final)

```php
final public function __construct(protected string $label) {}
```

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$label` | `string` | yes | — | The item label, stored as a promoted constructor property. Used only if no override is set via `label()`. |

### Returns

Not documented — constructor.

### Example

Instances should be built with `make()`; the constructor itself is used internally:

```php
$item = new MobileBottomNavItem('Home');
echo $item->getLabel(); // 'Home'
```
```

--------------------------------

### MobileBottomNavItem::make()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Static factory method to create a new MobileBottomNavItem instance with the given label. Returns a new instance of the class.

```APIDOC
## `make()` (static factory)

```php
public static function make(string $label): static
```

### Parameters

| Parameter | Type | Required | Default | Description |
|-----------|------|----------|---------|-------------|
| `$label` | `string` | yes | — | The item label. |

### Returns

`static` (`MobileBottomNavItem`) — a new instance (`new static($label)`).

### Example

```php
$item = MobileBottomNavItem::make('Inbox');
```
```

--------------------------------

### MobileBottomNavItem

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Documentation for the MobileBottomNavItem fluent value object, including constructor, fluent setters, getters, closure semantics, and default property values.

```APIDOC
## MobileBottomNavItem

### Description
A fluent value object describing a single mobile bottom-bar entry (label, icons, URL, active state, badge, visibility, sort). Used both as the input type for `MobileBottomNav::items()` and as the output of the registry auto-extraction.

### Constructor
- **label** (string) - Required - The label for the navigation item.

### Methods

#### icon
- **icon** (string | BackedEnum | Htmlable | null) - Optional - Sets the icon for the item. Returns `static`.

#### activeIcon
- **activeIcon** (string | BackedEnum | Htmlable | null) - Optional - Sets the active icon for the item. Returns `static`.

#### url
- **url** (string | Closure | null) - Optional - Sets the URL for the item. Accepts a closure for lazy evaluation. Returns `static`.

#### isActive
- **isActive** (bool | Closure) - Optional - Sets the active state. Accepts a closure for lazy evaluation. Returns `static`.

#### badge
- **badge** (string | int | null | Closure) - Optional - Sets the badge text or number. Accepts a closure for lazy evaluation. Returns `static`.

#### badgeColor
- **badgeColor** (string | array | null | Closure) - Optional - Sets the badge color. Accepts a closure for lazy evaluation. Returns `static`.

#### sort
- **sort** (int) - Optional - Sets the sort order. Returns `static`.

#### isVisible
- **isVisible** (bool | Closure) - Optional - Sets the visibility. Accepts a closure for lazy evaluation. Returns `static`.

#### labelOverride
- **labelOverride** (string | Closure | null) - Optional - Sets a label override. Accepts a closure for lazy evaluation. Returns `static`.

### Getters
Each getter evaluates closures lazily on every call. Non-closure values are returned as stored; booleans from closures are cast with `(bool)`.

- **getLabel()** - Returns the label.
- **getIcon()** - Returns the icon.
- **getActiveIcon()** - Returns the active icon.
- **getUrl()** - Returns the URL.
- **getIsActive()** - Returns the active state (bool).
- **getBadge()** - Returns the badge.
- **getBadgeColor()** - Returns the badge color.
- **getSort()** - Returns the sort order.
- **getIsVisible()** - Returns the visibility (bool).
- **getLabelOverride()** - Returns the label override.

### Closure Semantics
Every "soft" value (`labelOverride`, `url`, `isActive`, `badge`, `badgeColor`, `isVisible`) accepts `Closure` (a PHP arrow function `fn () => ...`). Closures are **not** evaluated at assignment time — each getter invokes `($closure)()` on every call, so state is always evaluated lazily and re-read on each render.

### Defaults
| Property | Type | Default |
|----------|------|---------|
| `label` | `string` | constructor argument (promoted) |
| `icon` | `string \| BackedEnum \| Htmlable \| null` | `null` |
| `activeIcon` | `string \| BackedEnum \| Htmlable \| null` | `null` |
| `url` | `string \| Closure \| null` | `null` |
| `isActive` | `bool \| Closure` | `false` |
| `badge` | `string \| int \| null \| Closure` | `null` |
| `badgeColor` | `string \| array \| null \| Closure` | `null` |
| `sort` | `int` | `0` |
| `isVisible` | `bool \| Closure` | `true` |
| `labelOverride` | `string \| Closure \| null` | `null` |
```

--------------------------------

### fromNavigation()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Method to enable automatic extraction of navigation items from the registry and set the total slot count.

```APIDOC
## `fromNavigation()`

### Description
Re-enables automatic extraction of navigation items from the registry and sets the total number of bottom-bar slots.

### Method
`fromNavigation`

### Signature
```php
public function fromNavigation(int $limit = 3): static
```

### Parameters
- **$limit** (int) - Optional - Default: `3` - Total number of bottom-bar slots, **including** the "More" button when enabled.

### Returns
`static` (`MobileBottomNav`) — the instance, for chaining.

### Behavior
Re-enables registry extraction (`useNavigationExtraction = true`). Slot math (see `extractFromNavigation()`): when `moreButtonEnabled` is `true`, navigation items shown are `max(1, $limit - 1)`; when `false`, `max(1, $limit)`. With defaults (`limit = 3`, More enabled): 2 items + 1 More button = 3 slots.

### Example
```php
// 4 nav items + 1 "More" button = 5 slots
MobileBottomNav::make()->fromNavigation(5);

// 4 nav items, no more button (set limit to 4 AND disable the button)
MobileBottomNav::make()
    ->fromNavigation(4)
    ->moreButton(false);
```
```

--------------------------------

### configurePackage() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Signature of the configurePackage method, which is part of the package-tools lifecycle and receives a Package object.

```php
public function configurePackage(Package $package): void
```

--------------------------------

### Constructor definition

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

The final constructor that accepts a label string and stores it as a promoted property.

```php
final public function __construct(protected string $label) {}
```

--------------------------------

### Define custom navigation items

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/README.md

Provides custom MobileBottomNavItem instances instead of auto-extracting from the navigation registry. Each item can have an icon, active icon, URL, and optional badge.

```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;
use Hammadzafar05\MobileBottomNav\MobileBottomNavItem;

MobileBottomNav::make()
    ->items([
        MobileBottomNavItem::make('Home')
            ->icon('heroicon-o-home')
            ->activeIcon('heroicon-s-home')
            ->url('/admin')
            ->isActive(fn () => request()->is('admin')),
        MobileBottomNavItem::make('Inbox')
            ->icon('heroicon-o-inbox')
            ->url('/admin/inbox')
            ->badge(5, 'danger'),
        MobileBottomNavItem::make('Profile')
            ->icon('heroicon-o-user')
            ->url('/admin/profile'),
    ])
```

--------------------------------

### register()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Registers the mobile bottom navigation plugin with a Filament panel. This method is part of the Filament plugin contract and is invoked by Filament during panel boot.

```APIDOC
## `register()` — Plugin contract

### Description
Registers the render closure with the Filament panel. This method is part of the Filament plugin contract and is called by Filament during panel boot when the plugin is listed in `->plugins([...])`. Applications normally never call it directly.

### Method
`register`

### Signature
```php
public function register(Panel $panel): void
```

### Parameters
- **$panel** (`Filament\Panel`) - Required - The panel being booted; supplied by Filament's plugin system.

### Returns
`void`.

### Behavior
Registers the render closure with the panel: `$panel->renderHook($this->renderHook, fn (): string => $this->render())`. The closure captures `$this`, so configuration performed after registration (via `get()`) still affects subsequent renders.

### Example
```php
// Usually not needed in application code — Filament invokes register()
// during panel boot for every plugin in the panel's ->plugins([...]) list.
// A direct call is only sensible inside custom plugin wiring, where the
// $panel argument comes from Filament's boot sequence:

MobileBottomNav::get()->register($panel);
```
```

--------------------------------

### fromNavigation() - Set number of slots from navigation

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Re-enables registry extraction (useNavigationExtraction = true). The limit includes the More button when enabled; with defaults (limit=3, More enabled) 2 items + 1 More button = 3 slots. When moreButtonEnabled is true, shown items are max(1, limit-1); when false, max(1, limit).

```php
// 4 nav items + 1 "More" button = 5 slots
MobileBottomNav::make()->fromNavigation(5);

// 4 nav items, no more button (set limit to 4 AND disable the button)
MobileBottomNav::make()
    ->fromNavigation(4)
    ->moreButton(false);
```

--------------------------------

### isActiveState() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns (bool) ($isActive)() for closures, else the stored boolean. Defaults to false.

```php
public function isActiveState(): bool
```

--------------------------------

### getUrl() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns ($url)() when $url is a Closure, otherwise the stored string; null when unset.

```php
public function getUrl(): ?string
```

--------------------------------

### MobileBottomNavItem Fluent Setters

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Fluent setter methods for configuring a MobileBottomNavItem instance.

```APIDOC
## `label()`

### Description
Overrides the constructor label. A closure is invoked by `getLabel()` on each call.

### Method
`public function label(string | Closure $label): static`

### Parameters
- `$label` (string | Closure) - Required - Overrides the constructor label. A closure is invoked by `getLabel()` on each call.

### Example
```php
MobileBottomNavItem::make('Home')
    ->label(fn () => 'Dashboard');
```
```

```APIDOC
## `icon()`

### Description
Sets the icon rendered via `Filament\Support\generate_icon_html` at `IconSize::Large`.

### Method
`public function icon(string | BackedEnum | Htmlable $icon): static`

### Parameters
- `$icon` (string | BackedEnum | Htmlable) - Required - Icon rendered via `Filament\Support\generate_icon_html` at `IconSize::Large`.

### Example
```php
MobileBottomNavItem::make('Home')->icon('heroicon-o-home');
```
```

```APIDOC
## `activeIcon()`

### Description
Sets the icon shown instead of `icon` while the item is active (the view checks `isActiveState() && getActiveIcon()`).

### Method
`public function activeIcon(string | BackedEnum | Htmlable $activeIcon): static`

### Parameters
- `$activeIcon` (string | BackedEnum | Htmlable) - Required - Icon shown instead of `icon` while the item is active (the view checks `isActiveState() && getActiveIcon()`).

### Example
```php
MobileBottomNavItem::make('Home')
    ->icon('heroicon-o-home')
    ->activeIcon('heroicon-s-home');
```
```

```APIDOC
## `url()`

### Description
Sets the link target. When unset, `getUrl()` returns `null` and the view's `generate_href_html($item->getUrl())` renders an href-less anchor. Extraction mode defaults to `'#'` for items without a URL.

### Method
`public function url(string | Closure $url): static`

### Parameters
- `$url` (string | Closure) - Required - Link target. When unset, `getUrl()` returns `null` and the view's `generate_href_html($item->getUrl())` renders an href-less anchor. Extraction mode defaults to `'#'` for items without a URL.

### Example
```php
MobileBottomNavItem::make('Profile')->url('/admin/profile');

// evaluated per render:
MobileBottomNavItem::make('Settings')
    ->url(fn () => auth()->user()?->settingsUrl());
```
```

```APIDOC
## `isActive()`

### Description
Sets the active state. Closure results are cast with `(bool)`. When active, the view adds the `fi-active` class and `aria-current="page"`.

### Method
`public function isActive(bool | Closure $isActive = true): static`

### Parameters
- `$isActive` (bool | Closure) - Optional, default `true` - Active state. Closure results are cast with `(bool)`. When active, the view adds the `fi-active` class and `aria-current="page"`.

### Example
```php
MobileBottomNavItem::make('Admin')
    ->isActive(fn () => request()->is('admin'));
```
```

```APIDOC
## `badge()`

### Description
Sets the badge value and optional color. Numeric values render as a count pill (`.fi-bottom-nav-badge`); non-empty string values render as a dot (`.fi-bottom-nav-badge-dot`); `''`/`null` renders nothing.

### Method
`public function badge(string | int | null | Closure $badge, string | array | null | Closure $color = null): static`

### Parameters
- `$badge` (string | int | null | Closure) - Required - Badge value. Numeric values render as a count pill (`.fi-bottom-nav-badge`); non-empty string values render as a dot (`.fi-bottom-nav-badge-dot`); `''`/`null` renders nothing.
- `$color` (string | array | null | Closure) - Optional, default `null` - Badge color. A string resolves to CSS variable `var(--{$color}-500)` (e.g. `'danger'` → `var(--danger-500)`); `null` or an array falls back to `var(--primary-500)`. View default when unset: `'primary'`.

### Example
```php
MobileBottomNavItem::make('Inbox')
    ->badge(5, 'danger');

// numeric + closure color:
MobileBottomNavItem::make('Inbox')
    ->badge(fn () => unreadCount(), fn () => 'success');
```
```

```APIDOC
## `badgeColor()`

### Description
Sets the badge color independently of `badge()`. Same semantics as `badge()`'s `$color` parameter.

### Method
`public function badgeColor(string | array | null | Closure $color): static`

### Parameters
- `$color` (string | array | null | Closure) - Required - Sets the badge color independently of `badge()`. Same semantics as `badge()`'s `$color` parameter.

### Example
```php
MobileBottomNavItem::make('Updates')->badge('new')->badgeColor('warning');
```
```

```APIDOC
## `sort()`

### Description
Sets the sort hint. In manual-item mode the array order is preserved (sort is not applied); extraction mode sets it from `NavigationItem::getSort()`.

### Method
`public function sort(int $sort): static`

### Parameters
- `$sort` (int) - Required - Sort hint. In manual-item mode the array order is preserved (sort is not applied); extraction mode sets it from `NavigationItem::getSort()`.

### Example
```php
MobileBottomNavItem::make('Home')->sort(1);
```
```

```APIDOC
## `visible()`

### Description
Sets the visibility. `MobileBottomNav::resolveItems()` filters manual items with `isVisible()`, dropping invisible ones from the bar. Extraction mode never produces hidden items (hidden `NavigationItem`s are skipped).

### Method
`public function visible(bool | Closure $condition = true): static`

### Parameters
- `$condition` (bool | Closure) - Optional, default `true` - Visibility. `MobileBottomNav::resolveItems()` filters manual items with `isVisible()`, dropping invisible ones from the bar. Extraction mode never produces hidden items (hidden `NavigationItem`s are skipped).

### Example
```php
MobileBottomNavItem::make('Admin')
    ->visible(fn () => auth()->user()?->isAdmin());
```
```

--------------------------------

### render() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of the protected render() method. Returns an empty string when the bar is suppressed (unauthenticated, no tenant, or empty items).

```php
protected function render(): string
```

--------------------------------

### getBadge() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns ($badge)() for closures, else the stored value; null when unset.

```php
public function getBadge(): string | int | null
```

--------------------------------

### register() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of the register() method, part of the plugin contract. Called by Filament during panel boot when the plugin is listed in ->plugins([...]). Applications normally never call it directly.

```php
public function register(Panel $panel): void
```

--------------------------------

### getId() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Declares the instance method getId() that returns a string. It takes no parameters and returns the fixed plugin identifier 'mobile-bottom-nav'.

```php
public function getId(): string
```

--------------------------------

### moreButton()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Configures the visibility of the "More" button in the mobile bottom navigation.

```APIDOC
## `moreButton()`

### Description
Shows or hides the "More" button that opens the sidebar in the view.

### Method
`moreButton`

### Signature
`public function moreButton(bool $enabled = true): static`

### Parameters
- **$enabled** (bool) - Optional - Default: `true` - Show/hide the "More" button that opens the sidebar (`$store.sidebar.open()` in the view).

### Returns
`static` (`MobileBottomNav`) — the instance, for chaining.

### Example
```php
// No "More" button — Filament's topbar hamburger must stay visible,
// so opt out of the toggle hiding too.
MobileBottomNav::make()
    ->moreButton(false)
    ->hideSidebarToggle(false);
```
```

--------------------------------

### Translation file for mobile-bottom-nav

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Defines the translation key 'more' with the value 'More' in the file resources/lang/en/mobile-bottom-nav.php. This key is namespaced as mobile-bottom-nav::mobile-bottom-nav.more and is the default moreButtonLabel consumed via __() in MobileBottomNav::render().

```php
return [
    'more' => 'More',
];
```

--------------------------------

### MobileBottomNavItem property declarations

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/types.md

Property declarations for the MobileBottomNavItem value object. The constructor promotes the required `label` string property; all other fields have defaults and support closures or nullable types as shown.

```php
protected string | BackedEnum | Htmlable | null $icon = null;

protected string | BackedEnum | Htmlable | null $activeIcon = null;

protected string | Closure | null $url = null;

protected bool | Closure $isActive = false;

protected string | int | null | Closure $badge = null;

/**
 * @var string | array<string> | null | Closure
 */
protected string | array | null | Closure $badgeColor = null;

protected int $sort = 0;

protected bool | Closure $isVisible = true;

protected string | Closure | null $labelOverride = null;
```

--------------------------------

### moreButton() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of the moreButton() method. It accepts a boolean parameter to enable or disable the 'More' button.

```php
public function moreButton(bool $enabled = true): static
```

--------------------------------

### renderHook()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Configures the Filament panel render hook where the mobile bottom navigation bar is rendered.

```APIDOC
## `renderHook()`

### Description
Sets which Filament panel render hook the mobile bottom navigation bar is attached to.

### Method
`renderHook`

### Signature
```php
public function renderHook(string $hook): static
```

### Parameters
- **$hook** (string) - Required - The Filament panel render hook name. Defaults to `PanelsRenderHook::BODY_END`. Hook names take the Filament `panel`/`panels` hook format (e.g., `'panels::body.start'`).

### Returns
`static` (`MobileBottomNav`) - The instance, for chaining.

### Example
```php
MobileBottomNav::make()->renderHook('panels::body.start');
```
```

--------------------------------

### items()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Method to set custom bottom-bar items for the navigation component.

```APIDOC
## `items()`

### Description
Sets custom bottom-bar items for the navigation. When set, it disables automatic extraction from the navigation registry.

### Method
`items`

### Signature
```php
public function items(array $items): static
```

### Parameters
- **$items** (array<MobileBottomNavItem>) - Required - Custom bottom-bar items. Setting them disables registry auto-extraction (`useNavigationExtraction = false`).

### Returns
`static` (`MobileBottomNav`) — the instance, for chaining.

### Behavior
Manual items are filtered by `isVisible()` in `resolveItems()`, preserving array order.

### Example
```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;
use Hammadzafar05\MobileBottomNav\MobileBottomNavItem;

MobileBottomNav::make()
    ->items([
        MobileBottomNavItem::make('Home')
            ->icon('heroicon-o-home')
            ->activeIcon('heroicon-s-home')
            ->url('/admin')
            ->isActive(fn () => request()->is('admin')),
        MobileBottomNavItem::make('Inbox')
            ->icon('heroicon-o-inbox')
            ->url('/admin/inbox')
            ->badge(5, 'danger'),
    ]);
```
```

--------------------------------

### render() view return

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Renders the bottom-navigation view with the documented data contract. The hidesSidebarToggle flag is only true when the More button is enabled.

```php
return view('mobile-bottom-nav::bottom-navigation', [
    'items' => $items,
    'moreButtonEnabled' => $this->moreButtonEnabled,
    'moreButtonLabel' => __($this->moreButtonLabel),
    // Only safe once we know the bar drew and the More button can open the sidebar.
    'hidesSidebarToggle' => $this->hidesSidebarToggle && $this->moreButtonEnabled,
])->render();
```

--------------------------------

### getId()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Instance method that returns the plugin's fixed identifier string.

```APIDOC
## `getId()`

### Description
Returns the fixed plugin identifier used by Filament to key the plugin in its registry.

### Method
`getId` (instance)

### Signature
`public function getId(): string`

### Parameters
None.

### Returns
`string` — the fixed plugin identifier `'mobile-bottom-nav'`.

### Example
```php
$plugin = MobileBottomNav::make();

echo $plugin->getId(); // 'mobile-bottom-nav'
```
```

--------------------------------

### Resolving the published view

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Renders the 'mobile-bottom-nav::bottom-navigation' view with the given data, returning the HTML string.

```php
$html = view('mobile-bottom-nav::bottom-navigation', [
    'items' => [],
    'moreButtonEnabled' => true,
    'moreButtonLabel' => 'More',
    'hidesSidebarToggle' => true,
])->render();
```

--------------------------------

### MobileBottomNavItem

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/types.md

Value object / builder representing a single navigation item. Its public properties define the item's icon, URL, active state, badge, visibility, and label.

```APIDOC
## MobileBottomNavItem

### Description
Value object / builder representing a single navigation item. Its public properties define the item's icon, URL, active state, badge, visibility, and label.

### Properties

#### label
- **Type**: `string`
- **Required**: yes
- **Default**: (none)
- **Description**: Constructor label; fallback for `getLabel()`.

#### icon
- **Type**: `string | BackedEnum | Htmlable | null`
- **Required**: no
- **Default**: `null`
- **Description**: Inactive-state icon.

#### activeIcon
- **Type**: `string | BackedEnum | Htmlable | null`
- **Required**: no
- **Default**: `null`
- **Description**: Active-state icon (used when active).

#### url
- **Type**: `string | Closure | null`
- **Required**: no
- **Default**: `null`
- **Description**: Link target; closure evaluated by `getUrl()`.

#### isActive
- **Type**: `bool | Closure`
- **Required**: no
- **Default**: `false`
- **Description**: Active state; closure cast to `bool`.

#### badge
- **Type**: `string | int | null | Closure`
- **Required**: no
- **Default**: `null`
- **Description**: Badge value (numeric → pill, string → dot).

#### badgeColor
- **Type**: `string | array | null | Closure`
- **Required**: no
- **Default**: `null`
- **Description**: Badge color (`var(--{$color}-500)` or primary fallback).

#### sort
- **Type**: `int`
- **Required**: no
- **Default**: `0`
- **Description**: Sort hint from registry extraction.

#### isVisible
- **Type**: `bool | Closure`
- **Required**: no
- **Default**: `true`
- **Description**: Visibility gate for manual items.

#### labelOverride
- **Type**: `string | Closure | null`
- **Required**: no
- **Default**: `null`
- **Description**: Overrides `label` in `getLabel()`.

### Example
```php
protected string | BackedEnum | Htmlable | null $icon = null;

protected string | BackedEnum | Htmlable | null $activeIcon = null;

protected string | Closure | null $url = null;

protected bool | Closure $isActive = false;

protected string | int | null | Closure $badge = null;

/**
 * @var string | array<string> | null | Closure
 */
protected string | array | null | Closure $badgeColor = null;

protected int $sort = 0;

protected bool | Closure $isVisible = true;

protected string | Closure | null $labelOverride = null;
```
```

--------------------------------

### moreButtonLabel() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of the moreButtonLabel() method. It accepts a string label for the 'More' button.

```php
public function moreButtonLabel(string $label): static
```

--------------------------------

### getIcon() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns the icon exactly as stored (no closure support). Returns null when never set.

```php
public function getIcon(): string | BackedEnum | Htmlable | null
```

--------------------------------

### extractFromNavigation() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of extractFromNavigation(). Iterates navigation groups in registry order and builds MobileBottomNavItem instances, skipping items with no icon.

```php
/**
 * @return array<MobileBottomNavItem>
 */
protected function extractFromNavigation(): array
```

--------------------------------

### MobileBottomNav

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/types.md

Main plugin class implementing Filament's Plugin contract. Its public properties control the navigation items, layout limits, and rendering behavior.

```APIDOC
## MobileBottomNav

### Description
Main plugin class implementing Filament's Plugin contract. Its public properties control the navigation items, layout limits, and rendering behavior.

### Properties

#### items
- **Type**: `?array` (of `MobileBottomNavItem`)
- **Default**: `null`
- **Description**: Manual items; `null` = extraction mode.

#### navigationLimit
- **Type**: `int`
- **Default**: `3`
- **Description**: Total slots, including "More".

#### moreButtonEnabled
- **Type**: `bool`
- **Default**: `true`
- **Description**: Whether the sidebar-opening "More" button renders.

#### hidesSidebarToggle
- **Type**: `bool`
- **Default**: `true`
- **Description**: Whether the topbar hamburger is hidden below `1024px`.

#### moreButtonLabel
- **Type**: `string`
- **Default**: `'mobile-bottom-nav::mobile-bottom-nav.more'`
- **Description**: Translation key for the "More" label.

#### renderHook
- **Type**: `string`
- **Default**: `PanelsRenderHook::BODY_END`
- **Description**: Filament panel render hook.

#### useNavigationExtraction
- **Type**: `bool`
- **Default**: `true`
- **Description**: `true` = registry extraction, `false` = manual items.

### Example
```php
protected ?array $items = null;

protected int $navigationLimit = 3;

protected bool $moreButtonEnabled = true;

protected bool $hidesSidebarToggle = true;

protected string $moreButtonLabel = 'mobile-bottom-nav::mobile-bottom-nav.more';

protected string $renderHook = PanelsRenderHook::BODY_END;

protected bool $useNavigationExtraction = true;
```
```

--------------------------------

### Static property $name

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavServiceProvider.md

Defines the Laravel package identifier used by package tooling. No table needed.

```php
public static string $name = 'mobile-bottom-nav';
```

--------------------------------

### isVisible() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns (bool) ($isVisible)() for closures, else the stored boolean. Defaults to true.

```php
public function isVisible(): bool
```

--------------------------------

### Set navigation limit with More button

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/README.md

Adjusts the total number of bottom bar slots. By default 2 nav items plus a More button; passing 5 gives 4 nav items plus the More button.

```php
MobileBottomNav::make()
    ->fromNavigation(5)     // 4 nav items + 1 More button
```

--------------------------------

### extractFromNavigation() limit slicing

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Slices the resolved items to the navigation limit, with a floor of one. When the More button is enabled, one slot is reserved for it.

```php
$limit = $this->moreButtonEnabled
    ? $this->navigationLimit - 1
    : $this->navigationLimit;

return array_slice($allItems, 0, max(1, $limit));
```

--------------------------------

### resolveItems() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Signature of resolveItems(). When manual items are set and extraction is disabled, filters items by isVisible() (closures evaluated) preserving order; otherwise delegates to extractFromNavigation().

```php
/**
 * @return array<MobileBottomNavItem>
 */
protected function resolveItems(): array
```

--------------------------------

### moreButtonLabel()

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Sets the label for the "More" button in the mobile bottom navigation.

```APIDOC
## `moreButtonLabel()`

### Description
Sets the label for the "More" button, which can be a translation key or a plain string.

### Method
`moreButtonLabel`

### Signature
`public function moreButtonLabel(string $label): static`

### Parameters
- **$label** (string) - Required - Label for the "More" button. Passed through `__()` in `render()`, so a translation key or a plain string both work. The bundled `en` translation resolves the default to `'More'`.

### Returns
`static` (`MobileBottomNav`) — the instance, for chaining.

### Example
```php
MobileBottomNav::make()->moreButtonLabel('Menu');
```
```

--------------------------------

### items() - Define custom bottom-bar items

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNav.md

Manually define bottom-bar items. Setting items disables registry auto-extraction (useNavigationExtraction = false). Items are filtered by isVisible() in resolveItems(), preserving array order.

```php
use Hammadzafar05\MobileBottomNav\MobileBottomNav;
use Hammadzafar05\MobileBottomNav\MobileBottomNavItem;

MobileBottomNav::make()
    ->items([
        MobileBottomNavItem::make('Home')
            ->icon('heroicon-o-home')
            ->activeIcon('heroicon-s-home')
            ->url('/admin')
            ->isActive(fn () => request()->is('admin')),
        MobileBottomNavItem::make('Inbox')
            ->icon('heroicon-o-inbox')
            ->url('/admin/inbox')
            ->badge(5, 'danger'),
    ]);
```

--------------------------------

### getLabel() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns the labelOverride result when set (closure invoked), otherwise the constructor label. The view renders this inside .fi-bottom-nav-label.

```php
public function getLabel(): string
```

--------------------------------

### getSort() method signature

Source: https://github.com/hammadzafar05/mobile-bottom-nav/blob/5.x/_autodocs/api-reference/MobileBottomNavItem.md

Returns the stored integer (default 0).

```php
public function getSort(): int
```
Tokens:
Raw