1. class
  2. Filament
  3. \
  4. Navigation
  5. \
  6. NavigationItem

NavigationItem

class NavigationItem extends Component (View source)

Traits

Conditionable
Configurable
EvaluatesClosures
Macroable
Tappable

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected string|Closure|null $group
protected string|Closure|null $parentItem
protected bool|Closure|null $isActive
protected Htmlable|Closure|null $icon
protected Htmlable|Closure|null $activeIcon
protected string|Closure $label
protected string|Closure|null $badge
protected string $badgeColor
protected string|Closure|null $badgeTooltip
protected bool|Closure $shouldOpenUrlInNewTab
protected int|Closure|null $sort
protected string|Closure|null $url
protected bool|Closure $isHidden
protected bool|Closure $isVisible
protected NavigationItem[] $childItems

Methods

static mixed
configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

from  Configurable
Configurable
configure()

No description

from  Configurable
void
setUp()

No description

from  Configurable
mixed
evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

from  EvaluatesClosures
mixed
resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

from  EvaluatesClosures
array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

from  EvaluatesClosures
string|null
getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

from  EvaluatesClosures
static void
macro(string $name, callable $macro)

No description

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

No description

from  Macroable
static void
flushMacros()

No description

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

No description

from  Macroable
mixed
__call(string $method, array $parameters)

No description

from  Macroable
static callable|null
getMacro(string $method)

No description

from  Macroable
__construct(string|Closure|null $label = null)

No description

static NavigationItem
make(string|Closure|null $label = null)

No description

NavigationItem
badge(string|Closure|null $badge, string|array|Closure|null $color = null)

No description

NavigationItem
group(string|Closure|null $group)

No description

NavigationItem
parentItem(string|Closure|null $group)

No description

NavigationItem
icon(Htmlable|Closure|null $icon)

No description

NavigationItem
badgeTooltip(string|Closure|null $tooltip)

No description

NavigationItem
visible(bool|Closure $condition = true)

No description

NavigationItem
hidden(bool|Closure $condition = true)

No description

NavigationItem
activeIcon(Htmlable|Closure|null $activeIcon)

No description

NavigationItem
isActiveWhen(Closure|null $callback)

No description

NavigationItem
label(string|Closure $label)

No description

NavigationItem
openUrlInNewTab(bool|Closure $condition = true)

No description

NavigationItem
sort(int|Closure|null $sort)

No description

NavigationItem
url(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

string|null
getBadge()

No description

string|array|null
getBadgeColor()

No description

string|null
getBadgeTooltip()

No description

string|null
getGroup()

No description

string|null
getParentItem()

No description

Htmlable|null
getIcon()

No description

bool
isVisible()

No description

bool
isHidden()

No description

Htmlable|null
getActiveIcon()

No description

string
getLabel()

No description

int
getSort()

No description

string|null
getUrl()

No description

bool
isActive()

No description

bool
isChildItemsActive()

No description

bool
shouldOpenUrlInNewTab()

No description

NavigationItem
childItems(Arrayable $items)

No description

Arrayable
getChildItems()

No description

Details

in Configurable at line 10
static mixed configureUsing(Closure $modifyUsing, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $modifyUsing
Closure|null $during
bool $isImportant

Return Value

mixed

in Configurable at line 20
Configurable configure()

No description

Return Value

Configurable

in Configurable at line 30
protected void setUp()

No description

Return Value

void

in EvaluatesClosures at line 23
mixed evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 42
protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

in EvaluatesClosures at line 104
protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

in EvaluatesClosures at line 112
protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

in EvaluatesClosures at line 117
protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

in Macroable at line 17
static void macro(string $name, callable $macro)

No description

Parameters

string $name
callable $macro

Return Value

void

in Macroable at line 22
static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

in Macroable at line 37
static void flushMacros()

No description

Return Value

void

in Macroable at line 45
static mixed __callStatic(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 67
mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

in Macroable at line 86
static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

at line 49
final __construct(string|Closure|null $label = null)

No description

Parameters

string|Closure|null $label

at line 56
static NavigationItem make(string|Closure|null $label = null)

No description

Parameters

string|Closure|null $label

Return Value

NavigationItem

at line 67
NavigationItem badge(string|Closure|null $badge, string|array|Closure|null $color = null)

No description

Parameters

string|Closure|null $badge
string|array|Closure|null $color

Return Value

NavigationItem

at line 75
NavigationItem group(string|Closure|null $group)

No description

Parameters

string|Closure|null $group

Return Value

NavigationItem

at line 82
NavigationItem parentItem(string|Closure|null $group)

No description

Parameters

string|Closure|null $group

Return Value

NavigationItem

at line 89
NavigationItem icon(Htmlable|Closure|null $icon)

No description

Parameters

Htmlable|Closure|null $icon

Return Value

NavigationItem

at line 96
NavigationItem badgeTooltip(string|Closure|null $tooltip)

No description

Parameters

string|Closure|null $tooltip

Return Value

NavigationItem

at line 103
NavigationItem visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

at line 110
NavigationItem hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

at line 117
NavigationItem activeIcon(Htmlable|Closure|null $activeIcon)

No description

Parameters

Htmlable|Closure|null $activeIcon

Return Value

NavigationItem

at line 124
NavigationItem isActiveWhen(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

NavigationItem

at line 131
NavigationItem label(string|Closure $label)

No description

Parameters

string|Closure $label

Return Value

NavigationItem

at line 138
NavigationItem openUrlInNewTab(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

at line 145
NavigationItem sort(int|Closure|null $sort)

No description

Parameters

int|Closure|null $sort

Return Value

NavigationItem

at line 152
NavigationItem url(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

Parameters

string|Closure|null $url
bool|Closure $shouldOpenInNewTab

Return Value

NavigationItem

at line 160
string|null getBadge()

No description

Return Value

string|null

at line 168
string|array|null getBadgeColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

at line 173
string|null getBadgeTooltip()

No description

Return Value

string|null

at line 178
string|null getGroup()

No description

Return Value

string|null

at line 183
string|null getParentItem()

No description

Return Value

string|null

at line 188
Htmlable|null getIcon()

No description

Return Value

Htmlable|null

at line 199
bool isVisible()

No description

Return Value

bool

at line 204
bool isHidden()

No description

Return Value

bool

at line 213
Htmlable|null getActiveIcon()

No description

Return Value

Htmlable|null

at line 218
string getLabel()

No description

Return Value

string

at line 223
int getSort()

No description

Return Value

int

at line 228
string|null getUrl()

No description

Return Value

string|null

at line 233
bool isActive()

No description

Return Value

bool

at line 242
bool isChildItemsActive()

No description

Return Value

bool

at line 253
bool shouldOpenUrlInNewTab()

No description

Return Value

bool

at line 261
NavigationItem childItems(Arrayable $items)

No description

Parameters

Arrayable $items

Return Value

NavigationItem

at line 271
Arrayable getChildItems()

No description

Return Value

Arrayable

| Arrayable