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

NavigationItem

class NavigationItem extends Component (View source)

Traits

Configurable
EvaluatesClosures
Macroable
Tappable

Properties

static protected array $configurations from  Configurable
static protected array $importantConfigurations from  Configurable
protected string $evaluationIdentifier from  EvaluatesClosures
protected array $evaluationParametersToRemove from  EvaluatesClosures
protected string|Closure|null $group
protected Closure|null $isActiveWhen
protected string|Closure $icon
protected string|Closure|null $activeIcon
protected string|Closure|null $iconColor
protected string|Closure $label
protected string|Closure|null $badge
protected string|Closure|null $badgeColor
protected bool|Closure $shouldOpenUrlInNewTab
protected int|Closure|null $sort
protected string|Closure|null $url
protected bool|Closure $isHidden
protected bool|Closure $isVisible

Methods

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

No description

from  Configurable
Configurable
configure()

No description

from  Configurable
void
setUp()

No description

from  Configurable
evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

from  EvaluatesClosures
array
getDefaultEvaluationParameters()

No description

from  EvaluatesClosures
resolveEvaluationParameter(string $parameter, Closure $value)

No description

from  EvaluatesClosures
bool
isEvaluationParameterRemoved(string $parameter)

No description

from  EvaluatesClosures
__construct(string|null $label = null)

No description

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

No description

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

No description

NavigationItem
group(string|Closure|null $group)

No description

NavigationItem
icon(string|Closure $icon)

No description

NavigationItem
visible(bool|Closure $condition = true)

No description

NavigationItem
hidden(bool|Closure $condition = true)

No description

NavigationItem
activeIcon(string|Closure $activeIcon)

No description

NavigationItem
iconColor(string|Closure|null $iconColor)

No description

NavigationItem
isActiveWhen(Closure $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|null
getBadgeColor()

No description

string|null
getGroup()

No description

string
getIcon()

No description

bool
isVisible()

No description

bool
isHidden()

No description

string|null
getActiveIcon()

No description

string|null
getIconColor()

No description

string
getLabel()

No description

int
getSort()

No description

string|null
getUrl()

No description

bool
isActive()

No description

bool
shouldOpenUrlInNewTab()

No description

Details

in Configurable at line 13
static configureUsing(Closure $callback, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $callback
Closure|null $during
bool $isImportant

in Configurable at line 38
Configurable configure()

No description

Return Value

Configurable

in Configurable at line 65
protected void setUp()

No description

Return Value

void

in EvaluatesClosures at line 13
evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

Parameters

$value
array $parameters
array $exceptParameters

in EvaluatesClosures at line 31
protected array getDefaultEvaluationParameters()

No description

Return Value

array

in EvaluatesClosures at line 36
protected resolveEvaluationParameter(string $parameter, Closure $value)

No description

Parameters

string $parameter
Closure $value

in EvaluatesClosures at line 45
protected bool isEvaluationParameterRemoved(string $parameter)

No description

Parameters

string $parameter

Return Value

bool

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

No description

Parameters

string|null $label

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

No description

Parameters

string|null $label

Return Value

NavigationItem

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

No description

Parameters

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

Return Value

NavigationItem

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

No description

Parameters

string|Closure|null $group

Return Value

NavigationItem

at line 63
NavigationItem icon(string|Closure $icon)

No description

Parameters

string|Closure $icon

Return Value

NavigationItem

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

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

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

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

at line 84
NavigationItem activeIcon(string|Closure $activeIcon)

No description

Parameters

string|Closure $activeIcon

Return Value

NavigationItem

at line 91
NavigationItem iconColor(string|Closure|null $iconColor)

No description

Parameters

string|Closure|null $iconColor

Return Value

NavigationItem

at line 98
NavigationItem isActiveWhen(Closure $callback)

No description

Parameters

Closure $callback

Return Value

NavigationItem

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

No description

Parameters

string|Closure $label

Return Value

NavigationItem

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

No description

Parameters

bool|Closure $condition

Return Value

NavigationItem

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

No description

Parameters

int|Closure|null $sort

Return Value

NavigationItem

at line 126
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 134
string|null getBadge()

No description

Return Value

string|null

at line 139
string|null getBadgeColor()

No description

Return Value

string|null

at line 144
string|null getGroup()

No description

Return Value

string|null

at line 149
string getIcon()

No description

Return Value

string

at line 154
bool isVisible()

No description

Return Value

bool

at line 159
bool isHidden()

No description

Return Value

bool

at line 168
string|null getActiveIcon()

No description

Return Value

string|null

at line 173
string|null getIconColor()

No description

Return Value

string|null

at line 178
string getLabel()

No description

Return Value

string

at line 183
int getSort()

No description

Return Value

int

at line 192
string|null getUrl()

No description

Return Value

string|null

at line 197
bool isActive()

No description

Return Value

bool

at line 208
bool shouldOpenUrlInNewTab()

No description

Return Value

bool