Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/stores / useAppStore

Function: useAppStore() ​

useAppStore(pinia?, hot?): Store<"appStore", Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, "navbarOpen" | "sidebarOpen" | "notificationsDrawerOpen" | "fullScreen" | "hydrated" | "hydrating" | "error" | "authenticated" | "accessTokenExpiry" | "basemap">, Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, never>, Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, never>>

Defined in: packages/stores/src/app.ts:8

Global application state

Parameters ​

pinia? ​

Pinia instance to retrieve the store

null | Pinia

hot? ​

StoreGeneric

dev only hot module replacement

Returns ​

Store<"appStore", Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, "navbarOpen" | "sidebarOpen" | "notificationsDrawerOpen" | "fullScreen" | "hydrated" | "hydrating" | "error" | "authenticated" | "accessTokenExpiry" | "basemap">, Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, never>, Pick<{ accessTokenExpiry: Ref<number, number>; authenticated: Ref<boolean, boolean>; basemap: Ref<string, string>; error: Ref<null, null>; fullScreen: Ref<boolean, boolean>; hydrated: Ref<boolean, boolean>; hydrating: Ref<boolean, boolean>; navbarOpen: RemovableRef<boolean>; notificationsDrawerOpen: Ref<boolean, boolean>; sidebarOpen: RemovableRef<boolean>; }, never>>