class Panel extends Component (View source)

Traits

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected Asset[]> $assets from  HasAssets
protected string|Closure $emailVerifiedMiddlewareName from  HasAuth
protected string $emailVerificationRouteAction from  HasAuth
protected string $emailVerificationPromptRouteSlug from  HasAuth
protected string $emailVerificationRouteSlug from  HasAuth
protected string $emailVerificationRoutePrefix from  HasAuth
protected bool $isEmailVerificationRequired from  HasAuth
protected string $loginRouteAction from  HasAuth
protected string $loginRouteSlug from  HasAuth
protected string $registrationRouteAction from  HasAuth
protected string $registrationRouteSlug from  HasAuth
protected string $requestPasswordResetRouteAction from  HasAuth
protected string $requestPasswordResetRouteSlug from  HasAuth
protected string $resetPasswordRouteAction from  HasAuth
protected string $resetPasswordRouteSlug from  HasAuth
protected string $resetPasswordRoutePrefix from  HasAuth
protected string|null $profilePage from  HasAuth
protected bool $isProfilePageSimple from  HasAuth
protected string $authGuard from  HasAuth
protected string|null $authPasswordBroker from  HasAuth
protected bool|Closure $arePasswordsRevealable from  HasAuth
protected string $defaultAvatarProvider from  HasAvatars
$brandLogo from  HasBrandLogo
protected string|Closure|null $brandLogoHeight from  HasBrandLogo
$darkModeBrandLogo from  HasBrandLogo
protected Htmlable|Closure|null $brandName from  HasBrandName
protected bool|Closure $hasBreadcrumbs from  HasBreadcrumbs
protected bool|Closure $hasBroadcasting from  HasBroadcasting
protected array $colors from  HasColors
protected array<string,class-string> $livewireComponents from  HasComponents
protected class-string[] $pages from  HasComponents
protected string[] $pageDirectories from  HasComponents
protected string[] $pageNamespaces from  HasComponents
protected class-string[] $clusters from  HasComponents
protected string[] $clusterDirectories from  HasComponents
protected string[] $clusterNamespaces from  HasComponents
protected Cluster>,class-string[]> $clusteredComponents from  HasComponents
protected class-string[] $resources from  HasComponents
protected string[] $resourceDirectories from  HasComponents
protected string[] $resourceNamespaces from  HasComponents
protected Widget>[] $widgets from  HasComponents
protected string[] $widgetDirectories from  HasComponents
protected string[] $widgetNamespaces from  HasComponents
protected bool|Closure $hasReadOnlyRelationManagersOnResourceViewPagesByDefault from  HasComponents
protected bool|null $hasCachedComponents from  HasComponents
protected bool $hasDarkMode from  HasDarkMode
protected bool $hasDarkModeForced from  HasDarkMode
protected bool|Closure $hasDatabaseTransactions from  HasDatabaseTransactions
protected string|Closure|null $favicon from  HasFavicon
protected string|null $fontFamily from  HasFont
protected string $fontProvider from  HasFont
protected string|null $fontUrl from  HasFont
protected string|Closure|null $globalSearchDebounce from  HasGlobalSearch
protected string[] $globalSearchKeyBindings from  HasGlobalSearch
protected string|bool $globalSearchProvider from  HasGlobalSearch
protected string|Closure|null $globalSearchFieldSuffix from  HasGlobalSearch
protected array<string,string> $icons from  HasIcons
protected string $id from  HasId
protected MaxWidth|string|null $maxContentWidth from  HasMaxContentWidth
protected string[] $middleware from  HasMiddleware
protected string[] $authMiddleware from  HasMiddleware
protected string[] $tenantMiddleware from  HasMiddleware
protected string[] $livewirePersistentMiddleware from  HasMiddleware
protected array $navigationGroups from  HasNavigation
protected NavigationItem[] $navigationItems from  HasNavigation
protected Closure|bool $navigationBuilder from  HasNavigation
protected NavigationManager|null $navigationManager from  HasNavigation
protected bool|Closure $hasDatabaseNotifications from  HasNotifications
protected bool|Closure $hasLazyLoadedDatabaseNotifications from  HasNotifications
protected string|Closure|null $databaseNotificationsPolling from  HasNotifications
protected Plugin> $plugins from  HasPlugins
protected Closure[]>> $renderHooks from  HasRenderHooks
protected array $routes from  HasRoutes
protected array $authenticatedRoutes from  HasRoutes
protected array $tenantRoutes from  HasRoutes
protected array $authenticatedTenantRoutes from  HasRoutes
protected string|Closure|null $homeUrl from  HasRoutes
protected string[] $domains from  HasRoutes
protected string $path from  HasRoutes
protected string $sidebarWidth from  HasSidebar
protected string $collapsedSidebarWidth from  HasSidebar
protected bool|Closure $isSidebarCollapsibleOnDesktop from  HasSidebar
protected bool|Closure $isSidebarFullyCollapsibleOnDesktop from  HasSidebar
protected bool|Closure $hasCollapsibleNavigationGroups from  HasSidebar
protected bool|Closure $hasSpaMode from  HasSpaMode
protected string[] $spaModeUrlExceptions from  HasSpaMode
protected Provider|null $tenantBillingProvider from  HasTenancy
protected string $tenantBillingRouteSlug from  HasTenancy
protected bool|Closure $hasTenantMenu from  HasTenancy
protected string|null $tenantRoutePrefix from  HasTenancy
protected string|null $tenantDomain from  HasTenancy
protected string|null $tenantModel from  HasTenancy
protected string|null $tenantProfilePage from  HasTenancy
protected string|null $tenantRegistrationPage from  HasTenancy
protected string|null $tenantSlugAttribute from  HasTenancy
protected string|null $tenantOwnershipRelationshipName from  HasTenancy
protected MenuItem[] $tenantMenuItems from  HasTenancy
protected bool $isTenantSubscriptionRequired from  HasTenancy
protected Theme|null $theme from  HasTheme
protected string $viteTheme from  HasTheme
protected string|null $viteThemeBuildDirectory from  HasTheme
protected ThemeMode $defaultThemeMode from  HasTheme
protected bool $hasTopbar from  HasTopbar
protected bool|Closure $hasTopNavigation from  HasTopNavigation
protected bool|Closure $hasUnsavedChangesAlerts from  HasUnsavedChangesAlerts
protected MenuItem[] $userMenuItems from  HasUserMenu
protected bool $isDefault
protected Closure> $bootCallbacks

Methods

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

No description

configure()

No description

void
setUp()

No description

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

No description

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

No description

array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

string|null
static void
macro(string $name, callable $macro)

No description

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

No description

static void
flushMacros()

No description

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

No description

mixed
__call(string $method, array $parameters)

No description

static callable|null
getMacro(string $method)

No description

string
getResourceUrl(Model $model, string $name = 'index', array $parameters = [], bool $isAbsolute = true, Model|null $tenant = null)

No description

assets(array $assets, string $package = 'app')

No description

void
registerAssets()

No description

emailVerification(string|Closure|array|null $promptAction = EmailVerificationPrompt::class, bool $isRequired = true)

No description

from  HasAuth
emailVerificationPromptRouteSlug(string $slug)

No description

from  HasAuth
emailVerificationRouteSlug(string $slug)

No description

from  HasAuth
emailVerificationRoutePrefix(string $prefix)

No description

from  HasAuth
emailVerifiedMiddlewareName(string|Closure $name)

No description

from  HasAuth
requiresEmailVerification(bool $condition = true)

No description

from  HasAuth
login(string|Closure|array|null $action = Login::class)

No description

from  HasAuth
loginRouteSlug(string $slug)

No description

from  HasAuth
passwordReset(string|Closure|array|null $requestAction = RequestPasswordReset::class, string|Closure|array|null $resetAction = ResetPassword::class)

No description

from  HasAuth
passwordResetRequestRouteSlug(string $slug)

No description

from  HasAuth
passwordResetRouteSlug(string $slug)

No description

from  HasAuth
passwordResetRoutePrefix(string $prefix)

No description

from  HasAuth
registration(string|Closure|array|null $action = Register::class)

No description

from  HasAuth
registrationRouteSlug(string $slug)

No description

from  HasAuth
profile(string|null $page = EditProfile::class, bool $isSimple = true)

No description

from  HasAuth
simpleProfilePage(bool $condition = true)

No description

from  HasAuth
Guard
auth()

No description

from  HasAuth
authGuard(string $guard)

No description

from  HasAuth
authPasswordBroker(string|null $broker = null)

No description

from  HasAuth
bool
isEmailVerificationRequired()

No description

from  HasAuth
bool
hasProfile()

No description

from  HasAuth
string|null
getProfilePage()

No description

from  HasAuth
bool
isProfilePageSimple()

No description

from  HasAuth
string|null
getEmailVerificationPromptUrl(array $parameters = [])

No description

from  HasAuth
string
from  HasAuth
string
getEmailVerifiedMiddleware()

No description

from  HasAuth
string|null
getLoginUrl(array $parameters = [])

No description

from  HasAuth
string|null
getRegistrationUrl(array $parameters = [])

No description

from  HasAuth
string|null
getRequestPasswordResetUrl(array $parameters = [])

No description

from  HasAuth
string
getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

from  HasAuth
string
getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

from  HasAuth
string|null
getProfileUrl(array $parameters = [])

No description

from  HasAuth
string
getLogoutUrl(array $parameters = [])

No description

from  HasAuth
string
from  HasAuth
string|Closure|array|null
from  HasAuth
string
from  HasAuth
string
getEmailVerificationRouteSlug(string $suffix)

No description

from  HasAuth
string
from  HasAuth
string|Closure|array|null
getLoginRouteAction()

No description

from  HasAuth
string
getLoginRouteSlug()

No description

from  HasAuth
string|Closure|array|null
getRegistrationRouteAction()

No description

from  HasAuth
string
getRegistrationRouteSlug()

No description

from  HasAuth
string|Closure|array|null
from  HasAuth
string
from  HasAuth
string|Closure|array|null
getResetPasswordRouteAction()

No description

from  HasAuth
string
getResetPasswordRouteSlug()

No description

from  HasAuth
string
getResetPasswordRoutePrefix()

No description

from  HasAuth
bool
hasEmailVerification()

No description

from  HasAuth
bool
hasLogin()

No description

from  HasAuth
bool
hasPasswordReset()

No description

from  HasAuth
bool
hasRegistration()

No description

from  HasAuth
string
getAuthGuard()

No description

from  HasAuth
string|null
getAuthPasswordBroker()

No description

from  HasAuth
revealablePasswords(bool|Closure $condition = true)

No description

from  HasAuth
bool
arePasswordsRevealable()

No description

from  HasAuth
defaultAvatarProvider(string $provider)

No description

string
getDefaultAvatarProvider()

No description

brandLogo(Htmlable|Closure|null $logo)

No description

brandLogoHeight(string|Closure|null $height)

No description

darkModeBrandLogo(Htmlable|Closure|null $logo)

No description

Htmlable|null
getBrandLogo()

No description

string|null
getBrandLogoHeight()

No description

Htmlable|null
getDarkModeBrandLogo()

No description

brandName(Htmlable|Closure|null $name)

No description

Htmlable
getBrandName()

No description

breadcrumbs(bool|Closure $condition = true)

No description

bool
hasBreadcrumbs()

No description

broadcasting(bool|Closure $condition = true)

No description

bool
hasBroadcasting()

No description

colors(array|Closure $colors)

No description

array
getColors()

No description

pages(array $pages)

No description

resources(array $resources)

No description

string|null
getModelResource(Model $model)

No description

widgets(array $widgets)

No description

string
normalizeWidgetClass(WidgetConfiguration $widget)

No description

discoverPages(string $in, string $for)

No description

array
getPageDirectories()

No description

array
getPageNamespaces()

No description

discoverClusters(string $in, string $for)

No description

array
getClusterDirectories()

No description

array
getClusterNamespaces()

No description

discoverResources(string $in, string $for)

No description

array
getResourceDirectories()

No description

array
getResourceNamespaces()

No description

discoverWidgets(string $in, string $for)

No description

array
getWidgetDirectories()

No description

array
getWidgetNamespaces()

No description

discoverLivewireComponents(string $in, string $for)

No description

array
getPages()

No description

array
getResources()

No description

array
getWidgets()

No description

void
discoverComponents(string $baseClass, array $register, string|null $directory, string|null $namespace)

No description

livewireComponents(array $components)

No description

void
registerLivewireComponents()

No description

string
normalizeRelationManagerClass(RelationManagerConfiguration $manager)

No description

void
registerToCluster(string $component)

No description

void
queueLivewireComponentForRegistration(string $component)

No description

readOnlyRelationManagersOnResourceViewPagesByDefault(bool|Closure $condition = true)

No description

array
getClusteredComponents(string|null $cluster = null)

No description

bool
hasCachedComponents()

No description

void
cacheComponents()

No description

void
restoreCachedComponents()

No description

void
clearCachedComponents()

No description

string
getComponentCachePath()

No description

darkMode(bool $condition = true, bool $isForced = false)

No description

bool
hasDarkMode()

No description

bool
hasDarkModeForced()

No description

databaseTransactions(bool|Closure $condition = true)

No description

favicon(string|Closure|null $url)

No description

string|null
getFavicon()

No description

font(string $family, string|null $url = null, string|null $provider = null)

No description

from  HasFont
string
getFontFamily()

No description

from  HasFont
Htmlable
getFontHtml()

No description

from  HasFont
string
getFontProvider()

No description

from  HasFont
string|null
getFontUrl()

No description

from  HasFont
globalSearch(string|bool $provider = true)

No description

globalSearchDebounce(string|Closure|null $debounce)

No description

globalSearchKeyBindings(array $keyBindings)

No description

globalSearchFieldSuffix(string|Closure|null $suffix)

No description

string
getGlobalSearchDebounce()

No description

array
getGlobalSearchKeyBindings()

No description

string|null
getGlobalSearchFieldSuffix()

No description

GlobalSearchProvider|null
getGlobalSearchProvider()

No description

icons(array $icons)

No description

from  HasIcons
array
getIcons()

No description

from  HasIcons
id(string $id)

No description

from  HasId
string
getId()

No description

from  HasId
maxContentWidth(MaxWidth|string|null $maxContentWidth)

No description

MaxWidth|string|null
getMaxContentWidth()

No description

middleware(array $middleware, bool $isPersistent = false)

No description

authMiddleware(array $middleware, bool $isPersistent = false)

No description

tenantMiddleware(array $middleware, bool $isPersistent = false)

No description

persistentMiddleware(array $middleware)

No description

array
getMiddleware()

No description

array
getAuthMiddleware()

No description

array
getTenantMiddleware()

No description

navigation(Closure|bool $builder = true)

No description

array
buildNavigation()

No description

navigationGroups(array $groups)

No description

navigationItems(array $items)

No description

bool
hasNavigation()

No description

bool
hasNavigationBuilder()

No description

array
getNavigation()

No description

array
getNavigationGroups()

No description

array
getNavigationItems()

No description

databaseNotifications(bool|Closure $condition = true, bool|Closure $isLazy = true)

No description

lazyLoadedDatabaseNotifications(bool|Closure $condition = true)

No description

databaseNotificationsPolling(string|Closure|null $interval)

No description

bool
hasDatabaseNotifications()

No description

string|null
plugin(Plugin $plugin)

No description

plugins(array $plugins)

No description

array
getPlugins()

No description

getPlugin(string $id)

No description

bool
hasPlugin(string $id)

No description

renderHook(string $name, Closure $hook, string|array|null $scopes = null)

No description

void
registerRenderHooks()

No description

path(string $path)

No description

domain(string|null $domain)

No description

domains(array $domains)

No description

homeUrl(string|Closure|null $url)

No description

routes(Closure|null $routes)

No description

authenticatedRoutes(Closure|null $routes)

No description

tenantRoutes(Closure|null $routes)

No description

authenticatedTenantRoutes(Closure|null $routes)

No description

string
route(string $name, mixed $parameters = [], bool $absolute = true)

No description

string
generateRouteName(string $name)

No description

array
getRoutes()

No description

array
getAuthenticatedRoutes()

No description

array
getTenantRoutes()

No description

array
getAuthenticatedTenantRoutes()

No description

string|null
getHomeUrl()

No description

array
getDomains()

No description

string
getPath()

No description

string|null
getUrl(Model|null $tenant = null)

No description

sidebarCollapsibleOnDesktop(bool|Closure $condition = true)

No description

sidebarFullyCollapsibleOnDesktop(bool|Closure $condition = true)

No description

collapsibleNavigationGroups(bool|Closure $condition = true)

No description

sidebarWidth(string $width)

No description

collapsedSidebarWidth(string $width)

No description

string
getSidebarWidth()

No description

string
getCollapsedSidebarWidth()

No description

bool
bool
bool
spa(bool|Closure $condition = true)

No description

spaUrlExceptions(array|Closure $exceptions)

No description

bool
hasSpaMode()

No description

array
getSpaUrlExceptions()

No description

requiresTenantSubscription(bool $condition = true)

No description

tenantMenuItems(array $items)

No description

tenantMenu(bool|Closure $condition = true)

No description

tenant(string|null $model, string|null $slugAttribute = null, string|null $ownershipRelationship = null)

No description

tenantRoutePrefix(string|null $prefix)

No description

tenantDomain(string|null $domain)

No description

tenantBillingProvider(Provider|null $provider)

No description

tenantBillingRouteSlug(string $slug)

No description

tenantProfile(string|null $page)

No description

tenantRegistration(string|null $page)

No description

bool
hasTenancy()

No description

bool
isTenantSubscriptionRequired()

No description

bool
hasTenantBilling()

No description

bool
hasTenantProfile()

No description

bool
hasTenantRegistration()

No description

bool
hasTenantRoutePrefix()

No description

string|null
getTenantRoutePrefix()

No description

bool
hasTenantDomain()

No description

string|null
getTenantDomain()

No description

Provider|null
getTenantBillingProvider()

No description

string
getTenantBillingRouteSlug()

No description

string|null
getTenantProfilePage()

No description

string|null
getTenantRegistrationPage()

No description

Model
getTenant(string $key)

No description

string|null
getTenantModel()

No description

string|null
getTenantSlugAttribute()

No description

string|null
getTenantBillingUrl(Model $tenant, array $parameters = [])

No description

string|null
getTenantProfileUrl(array $parameters = [])

No description

string|null
getTenantRegistrationUrl(array $parameters = [])

No description

bool
hasTenantMenu()

No description

array
getTenantMenuItems()

No description

string
viteTheme(string|array $theme, string|null $buildDirectory = null)

No description

from  HasTheme
theme(Theme $theme)

No description

from  HasTheme
getTheme()

No description

from  HasTheme
getDefaultTheme()

No description

from  HasTheme
defaultThemeMode(ThemeMode $mode)

No description

from  HasTheme
ThemeMode
getDefaultThemeMode()

No description

from  HasTheme
topbar(bool $condition = true)

No description

bool
hasTopbar()

No description

topNavigation(bool|Closure $condition = true)

No description

bool
hasTopNavigation()

No description

unsavedChangesAlerts(bool|Closure $condition = true)

No description

userMenuItems(array $items)

No description

array
getUserMenuItems()

No description

static Panel
make()

No description

default(bool $condition = true)

No description

void
register()

No description

void
boot()

No description

bootUsing(Closure|null $callback)

No description

bool
isDefault()

No description

Details

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

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

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

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

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

No description

Parameters

string $name
callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string $method
array $parameters

Return Value

mixed

mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

string getResourceUrl(Model $model, string $name = 'index', array $parameters = [], bool $isAbsolute = true, Model|null $tenant = null)

No description

Parameters

Model $model
string $name
array $parameters
bool $isAbsolute
Model|null $tenant

Return Value

string

HasAssets assets(array $assets, string $package = 'app')

No description

Parameters

array $assets
string $package

Return Value

HasAssets

void registerAssets()

No description

Return Value

void

HasAuth emailVerification(string|Closure|array|null $promptAction = EmailVerificationPrompt::class, bool $isRequired = true)

No description

Parameters

string|Closure|array|null $promptAction
bool $isRequired

Return Value

HasAuth

HasAuth emailVerificationPromptRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth emailVerificationRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth emailVerificationRoutePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

HasAuth

HasAuth emailVerifiedMiddlewareName(string|Closure $name)

No description

Parameters

string|Closure $name

Return Value

HasAuth

HasAuth requiresEmailVerification(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasAuth

HasAuth login(string|Closure|array|null $action = Login::class)

No description

Parameters

string|Closure|array|null $action

Return Value

HasAuth

HasAuth loginRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth passwordReset(string|Closure|array|null $requestAction = RequestPasswordReset::class, string|Closure|array|null $resetAction = ResetPassword::class)

No description

Parameters

string|Closure|array|null $requestAction
string|Closure|array|null $resetAction

Return Value

HasAuth

HasAuth passwordResetRequestRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth passwordResetRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth passwordResetRoutePrefix(string $prefix)

No description

Parameters

string $prefix

Return Value

HasAuth

HasAuth registration(string|Closure|array|null $action = Register::class)

No description

Parameters

string|Closure|array|null $action

Return Value

HasAuth

HasAuth registrationRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasAuth

HasAuth profile(string|null $page = EditProfile::class, bool $isSimple = true)

No description

Parameters

string|null $page
bool $isSimple

Return Value

HasAuth

HasAuth simpleProfilePage(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasAuth

Guard auth()

No description

Return Value

Guard

HasAuth authGuard(string $guard)

No description

Parameters

string $guard

Return Value

HasAuth

HasAuth authPasswordBroker(string|null $broker = null)

No description

Parameters

string|null $broker

Return Value

HasAuth

bool isEmailVerificationRequired()

No description

Return Value

bool

bool hasProfile()

No description

Return Value

bool

string|null getProfilePage()

No description

Return Value

string|null

bool isProfilePageSimple()

No description

Return Value

bool

string|null getEmailVerificationPromptUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string getEmailVerificationPromptRouteName()

No description

Return Value

string

string getEmailVerifiedMiddleware()

No description

Return Value

string

string|null getLoginUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string|null getRegistrationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string|null getRequestPasswordResetUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string getVerifyEmailUrl(Authenticatable $user, array $parameters = [])

No description

Parameters

Authenticatable $user
array $parameters

Return Value

string

string getResetPasswordUrl(string $token, Authenticatable $user, array $parameters = [])

No description

Parameters

string $token
Authenticatable $user
array $parameters

Return Value

string

string|null getProfileUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string getLogoutUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string

string getEmailVerifiedMiddlewareName()

No description

Return Value

string

string|Closure|array|null getEmailVerificationPromptRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

string getEmailVerificationPromptRouteSlug()

No description

Return Value

string

string getEmailVerificationRouteSlug(string $suffix)

No description

Parameters

string $suffix

Return Value

string

string getEmailVerificationRoutePrefix()

No description

Return Value

string

string|Closure|array|null getLoginRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

string getLoginRouteSlug()

No description

Return Value

string

string|Closure|array|null getRegistrationRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

string getRegistrationRouteSlug()

No description

Return Value

string

string|Closure|array|null getRequestPasswordResetRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

string getRequestPasswordResetRouteSlug()

No description

Return Value

string

string|Closure|array|null getResetPasswordRouteAction()

No description

Return Value

string|Closure|array|null

| Closure | array<class-string, string> | null

string getResetPasswordRouteSlug()

No description

Return Value

string

string getResetPasswordRoutePrefix()

No description

Return Value

string

bool hasEmailVerification()

No description

Return Value

bool

bool hasLogin()

No description

Return Value

bool

bool hasPasswordReset()

No description

Return Value

bool

bool hasRegistration()

No description

Return Value

bool

string getAuthGuard()

No description

Return Value

string

string|null getAuthPasswordBroker()

No description

Return Value

string|null

HasAuth revealablePasswords(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasAuth

bool arePasswordsRevealable()

No description

Return Value

bool

HasAvatars defaultAvatarProvider(string $provider)

No description

Parameters

string $provider

Return Value

HasAvatars

string getDefaultAvatarProvider()

No description

Return Value

string

No description

Parameters

Htmlable|Closure|null $logo

Return Value

HasBrandLogo

HasBrandLogo brandLogoHeight(string|Closure|null $height)

No description

Parameters

string|Closure|null $height

Return Value

HasBrandLogo

No description

Parameters

Htmlable|Closure|null $logo

Return Value

HasBrandLogo

No description

Return Value

Htmlable|null

string|null getBrandLogoHeight()

No description

Return Value

string|null

No description

Return Value

Htmlable|null

HasBrandName brandName(Htmlable|Closure|null $name)

No description

Parameters

Htmlable|Closure|null $name

Return Value

HasBrandName

Htmlable getBrandName()

No description

Return Value

Htmlable

HasBreadcrumbs breadcrumbs(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasBreadcrumbs

bool hasBreadcrumbs()

No description

Return Value

bool

HasBroadcasting broadcasting(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasBroadcasting

bool hasBroadcasting()

No description

Return Value

bool

HasColors colors(array|Closure $colors)

No description

Parameters

array|Closure $colors

Return Value

HasColors

array getColors()

No description

Return Value

array

HasComponents pages(array $pages)

No description

Parameters

array $pages

Return Value

HasComponents

HasComponents resources(array $resources)

No description

Parameters

array $resources

Return Value

HasComponents

string|null getModelResource(Model $model)

No description

Parameters

Model $model

Return Value

string|null

HasComponents widgets(array $widgets)

No description

Parameters

array $widgets

Return Value

HasComponents

protected string normalizeWidgetClass(WidgetConfiguration $widget)

No description

Parameters

WidgetConfiguration $widget

Return Value

string

HasComponents discoverPages(string $in, string $for)

No description

Parameters

string $in
string $for

Return Value

HasComponents

array getPageDirectories()

No description

Return Value

array

array getPageNamespaces()

No description

Return Value

array

HasComponents discoverClusters(string $in, string $for)

No description

Parameters

string $in
string $for

Return Value

HasComponents

array getClusterDirectories()

No description

Return Value

array

array getClusterNamespaces()

No description

Return Value

array

HasComponents discoverResources(string $in, string $for)

No description

Parameters

string $in
string $for

Return Value

HasComponents

array getResourceDirectories()

No description

Return Value

array

array getResourceNamespaces()

No description

Return Value

array

HasComponents discoverWidgets(string $in, string $for)

No description

Parameters

string $in
string $for

Return Value

HasComponents

array getWidgetDirectories()

No description

Return Value

array

array getWidgetNamespaces()

No description

Return Value

array

HasComponents discoverLivewireComponents(string $in, string $for)

No description

Parameters

string $in
string $for

Return Value

HasComponents

array getPages()

No description

Return Value

array

array getResources()

No description

Return Value

array

array getWidgets()

No description

Return Value

array

protected void discoverComponents(string $baseClass, array $register, string|null $directory, string|null $namespace)

No description

Parameters

string $baseClass
array $register
string|null $directory
string|null $namespace

Return Value

void

HasComponents livewireComponents(array $components)

No description

Parameters

array $components

Return Value

HasComponents

protected void registerLivewireComponents()

No description

Return Value

void

protected string normalizeRelationManagerClass(RelationManagerConfiguration $manager)

No description

Parameters

RelationManagerConfiguration $manager

Return Value

string

protected void registerToCluster(string $component)

No description

Parameters

string $component

Return Value

void

protected void queueLivewireComponentForRegistration(string $component)

No description

Parameters

string $component

Return Value

void

HasComponents readOnlyRelationManagersOnResourceViewPagesByDefault(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasComponents

bool hasReadOnlyRelationManagersOnResourceViewPagesByDefault()

No description

Return Value

bool

array getClusteredComponents(string|null $cluster = null)

No description

Parameters

string|null $cluster

Return Value

array

bool hasCachedComponents()

No description

Return Value

bool

void cacheComponents()

No description

Return Value

void

void restoreCachedComponents()

No description

Return Value

void

void clearCachedComponents()

No description

Return Value

void

string getComponentCachePath()

No description

Return Value

string

HasDarkMode darkMode(bool $condition = true, bool $isForced = false)

No description

Parameters

bool $condition
bool $isForced

Return Value

HasDarkMode

bool hasDarkMode()

No description

Return Value

bool

bool hasDarkModeForced()

No description

Return Value

bool

HasDatabaseTransactions databaseTransactions(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasDatabaseTransactions

bool hasDatabaseTransactions()

No description

Return Value

bool

HasFavicon favicon(string|Closure|null $url)

No description

Parameters

string|Closure|null $url

Return Value

HasFavicon

string|null getFavicon()

No description

Return Value

string|null

HasFont font(string $family, string|null $url = null, string|null $provider = null)

No description

Parameters

string $family
string|null $url
string|null $provider

Return Value

HasFont

string getFontFamily()

No description

Return Value

string

Htmlable getFontHtml()

No description

Return Value

Htmlable

string getFontProvider()

No description

Return Value

string

string|null getFontUrl()

No description

Return Value

string|null

HasGlobalSearch globalSearch(string|bool $provider = true)

No description

Parameters

string|bool $provider

Return Value

HasGlobalSearch

HasGlobalSearch globalSearchDebounce(string|Closure|null $debounce)

No description

Parameters

string|Closure|null $debounce

Return Value

HasGlobalSearch

HasGlobalSearch globalSearchKeyBindings(array $keyBindings)

No description

Parameters

array $keyBindings

Return Value

HasGlobalSearch

HasGlobalSearch globalSearchFieldSuffix(string|Closure|null $suffix)

No description

Parameters

string|Closure|null $suffix

Return Value

HasGlobalSearch

HasGlobalSearch globalSearchFieldKeyBindingSuffix()

No description

Return Value

HasGlobalSearch

string getGlobalSearchDebounce()

No description

Return Value

string

array getGlobalSearchKeyBindings()

No description

Return Value

array

string|null getGlobalSearchFieldSuffix()

No description

Return Value

string|null

GlobalSearchProvider|null getGlobalSearchProvider()

No description

Return Value

GlobalSearchProvider|null

HasIcons icons(array $icons)

No description

Parameters

array $icons

Return Value

HasIcons

array getIcons()

No description

Return Value

array

HasId id(string $id)

No description

Parameters

string $id

Return Value

HasId

string getId()

No description

Return Value

string

HasMaxContentWidth maxContentWidth(MaxWidth|string|null $maxContentWidth)

No description

Parameters

MaxWidth|string|null $maxContentWidth

Return Value

HasMaxContentWidth

MaxWidth|string|null getMaxContentWidth()

No description

Return Value

MaxWidth|string|null

HasMiddleware middleware(array $middleware, bool $isPersistent = false)

No description

Parameters

array $middleware
bool $isPersistent

Return Value

HasMiddleware

HasMiddleware authMiddleware(array $middleware, bool $isPersistent = false)

No description

Parameters

array $middleware
bool $isPersistent

Return Value

HasMiddleware

HasMiddleware tenantMiddleware(array $middleware, bool $isPersistent = false)

No description

Parameters

array $middleware
bool $isPersistent

Return Value

HasMiddleware

HasMiddleware persistentMiddleware(array $middleware)

No description

Parameters

array $middleware

Return Value

HasMiddleware

array getMiddleware()

No description

Return Value

array

array getAuthMiddleware()

No description

Return Value

array

array getTenantMiddleware()

No description

Return Value

array

protected void registerLivewirePersistentMiddleware()

No description

Return Value

void

HasNavigation navigation(Closure|bool $builder = true)

No description

Parameters

Closure|bool $builder

Return Value

HasNavigation

array buildNavigation()

No description

Return Value

array

HasNavigation navigationGroups(array $groups)

No description

Parameters

array $groups

Return Value

HasNavigation

HasNavigation navigationItems(array $items)

No description

Parameters

array $items

Return Value

HasNavigation

bool hasNavigation()

No description

Return Value

bool

bool hasNavigationBuilder()

No description

Return Value

bool

array getNavigation()

No description

Return Value

array

array getNavigationGroups()

No description

Return Value

array

array getNavigationItems()

No description

Return Value

array

HasNotifications databaseNotifications(bool|Closure $condition = true, bool|Closure $isLazy = true)

No description

Parameters

bool|Closure $condition
bool|Closure $isLazy

Return Value

HasNotifications

HasNotifications lazyLoadedDatabaseNotifications(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasNotifications

HasNotifications databaseNotificationsPolling(string|Closure|null $interval)

No description

Parameters

string|Closure|null $interval

Return Value

HasNotifications

bool hasDatabaseNotifications()

No description

Return Value

bool

bool hasLazyLoadedDatabaseNotifications()

No description

Return Value

bool

string|null getDatabaseNotificationsPollingInterval()

No description

Return Value

string|null

HasPlugins plugin(Plugin $plugin)

No description

Parameters

Plugin $plugin

Return Value

HasPlugins

HasPlugins plugins(array $plugins)

No description

Parameters

array $plugins

Return Value

HasPlugins

array getPlugins()

No description

Return Value

array

Plugin getPlugin(string $id)

No description

Parameters

string $id

Return Value

Plugin

bool hasPlugin(string $id)

No description

Parameters

string $id

Return Value

bool

HasRenderHooks renderHook(string $name, Closure $hook, string|array|null $scopes = null)

No description

Parameters

string $name
Closure $hook
string|array|null $scopes

Return Value

HasRenderHooks

protected void registerRenderHooks()

No description

Return Value

void

HasRoutes path(string $path)

No description

Parameters

string $path

Return Value

HasRoutes

HasRoutes domain(string|null $domain)

No description

Parameters

string|null $domain

Return Value

HasRoutes

HasRoutes domains(array $domains)

No description

Parameters

array $domains

Return Value

HasRoutes

HasRoutes homeUrl(string|Closure|null $url)

No description

Parameters

string|Closure|null $url

Return Value

HasRoutes

HasRoutes routes(Closure|null $routes)

No description

Parameters

Closure|null $routes

Return Value

HasRoutes

HasRoutes authenticatedRoutes(Closure|null $routes)

No description

Parameters

Closure|null $routes

Return Value

HasRoutes

HasRoutes tenantRoutes(Closure|null $routes)

No description

Parameters

Closure|null $routes

Return Value

HasRoutes

HasRoutes authenticatedTenantRoutes(Closure|null $routes)

No description

Parameters

Closure|null $routes

Return Value

HasRoutes

string route(string $name, mixed $parameters = [], bool $absolute = true)

No description

Parameters

string $name
mixed $parameters
bool $absolute

Return Value

string

string generateRouteName(string $name)

No description

Parameters

string $name

Return Value

string

array getRoutes()

No description

Return Value

array

array getAuthenticatedRoutes()

No description

Return Value

array

array getTenantRoutes()

No description

Return Value

array

array getAuthenticatedTenantRoutes()

No description

Return Value

array

string|null getHomeUrl()

No description

Return Value

string|null

array getDomains()

No description

Return Value

array

string getPath()

No description

Return Value

string

string|null getUrl(Model|null $tenant = null)

No description

Parameters

Model|null $tenant

Return Value

string|null

HasSidebar sidebarCollapsibleOnDesktop(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasSidebar

HasSidebar sidebarFullyCollapsibleOnDesktop(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasSidebar

HasSidebar collapsibleNavigationGroups(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasSidebar

HasSidebar sidebarWidth(string $width)

No description

Parameters

string $width

Return Value

HasSidebar

HasSidebar collapsedSidebarWidth(string $width)

No description

Parameters

string $width

Return Value

HasSidebar

string getSidebarWidth()

No description

Return Value

string

string getCollapsedSidebarWidth()

No description

Return Value

string

bool isSidebarCollapsibleOnDesktop()

No description

Return Value

bool

bool isSidebarFullyCollapsibleOnDesktop()

No description

Return Value

bool

bool hasCollapsibleNavigationGroups()

No description

Return Value

bool

HasSpaMode spa(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasSpaMode

HasSpaMode spaUrlExceptions(array|Closure $exceptions)

No description

Parameters

array|Closure $exceptions

Return Value

HasSpaMode

bool hasSpaMode()

No description

Return Value

bool

array getSpaUrlExceptions()

No description

Return Value

array

HasTenancy requiresTenantSubscription(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasTenancy

HasTenancy tenantMenuItems(array $items)

No description

Parameters

array $items

Return Value

HasTenancy

HasTenancy tenantMenu(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasTenancy

HasTenancy tenant(string|null $model, string|null $slugAttribute = null, string|null $ownershipRelationship = null)

No description

Parameters

string|null $model
string|null $slugAttribute
string|null $ownershipRelationship

Return Value

HasTenancy

HasTenancy tenantRoutePrefix(string|null $prefix)

No description

Parameters

string|null $prefix

Return Value

HasTenancy

HasTenancy tenantDomain(string|null $domain)

No description

Parameters

string|null $domain

Return Value

HasTenancy

HasTenancy tenantBillingProvider(Provider|null $provider)

No description

Parameters

Provider|null $provider

Return Value

HasTenancy

HasTenancy tenantBillingRouteSlug(string $slug)

No description

Parameters

string $slug

Return Value

HasTenancy

HasTenancy tenantProfile(string|null $page)

No description

Parameters

string|null $page

Return Value

HasTenancy

HasTenancy tenantRegistration(string|null $page)

No description

Parameters

string|null $page

Return Value

HasTenancy

bool hasTenancy()

No description

Return Value

bool

bool isTenantSubscriptionRequired()

No description

Return Value

bool

bool hasTenantBilling()

No description

Return Value

bool

bool hasTenantProfile()

No description

Return Value

bool

bool hasTenantRegistration()

No description

Return Value

bool

bool hasTenantRoutePrefix()

No description

Return Value

bool

string|null getTenantRoutePrefix()

No description

Return Value

string|null

bool hasTenantDomain()

No description

Return Value

bool

string|null getTenantDomain()

No description

Return Value

string|null

Provider|null getTenantBillingProvider()

No description

Return Value

Provider|null

string getTenantBillingRouteSlug()

No description

Return Value

string

string|null getTenantProfilePage()

No description

Return Value

string|null

string|null getTenantRegistrationPage()

No description

Return Value

string|null

Model getTenant(string $key)

No description

Parameters

string $key

Return Value

Model

string|null getTenantModel()

No description

Return Value

string|null

string|null getTenantSlugAttribute()

No description

Return Value

string|null

string|null getTenantBillingUrl(Model $tenant, array $parameters = [])

No description

Parameters

Model $tenant
array $parameters

Return Value

string|null

string|null getTenantProfileUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

string|null getTenantRegistrationUrl(array $parameters = [])

No description

Parameters

array $parameters

Return Value

string|null

bool hasTenantMenu()

No description

Return Value

bool

array getTenantMenuItems()

No description

Return Value

array

string getTenantOwnershipRelationshipName()

No description

Return Value

string

HasTheme viteTheme(string|array $theme, string|null $buildDirectory = null)

No description

Parameters

string|array $theme
string|null $buildDirectory

Return Value

HasTheme

HasTheme theme(Theme $theme)

No description

Parameters

Theme $theme

Return Value

HasTheme

Theme getTheme()

No description

Return Value

Theme

Theme getDefaultTheme()

No description

Return Value

Theme

HasTheme defaultThemeMode(ThemeMode $mode)

No description

Parameters

ThemeMode $mode

Return Value

HasTheme

ThemeMode getDefaultThemeMode()

No description

Return Value

ThemeMode

HasTopbar topbar(bool $condition = true)

No description

Parameters

bool $condition

Return Value

HasTopbar

bool hasTopbar()

No description

Return Value

bool

HasTopNavigation topNavigation(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasTopNavigation

bool hasTopNavigation()

No description

Return Value

bool

HasUnsavedChangesAlerts unsavedChangesAlerts(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasUnsavedChangesAlerts

bool hasUnsavedChangesAlerts()

No description

Return Value

bool

HasUserMenu userMenuItems(array $items)

No description

Parameters

array $items

Return Value

HasUserMenu

array getUserMenuItems()

No description

Return Value

array

static Panel make()

No description

Return Value

Panel

Panel default(bool $condition = true)

No description

Parameters

bool $condition

Return Value

Panel

void register()

No description

Return Value

void

void boot()

No description

Return Value

void

Panel bootUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

Panel

bool isDefault()

No description

Return Value

bool