Overview
The composables a custom frontend module's Vue calls to work with the DMS, and the page that covers each.
When your frontend layer ships its own Vue (Frontend layer), it calls these composables to work with the DMS. Extending the dashboard covers registering new capabilities. This section covers the composables and components your own components use.
The base layers auto-import all of them. Call them from <script setup> or from a composable, with no import.
The toolkit
| Page | Composables |
|---|---|
| Auth requests and permissions | useApiData, useAuthFetch ($authFetch), usePermissions, useMultiAccount, useCurrentUser, useLogout, useSessionRecovery |
| Realtime and notifications | useRealtimeTopic, usePageRealtime, usePageLive, usePageLiveRefresh, useUserRealtime, useNotifications |
| Page context | useSiteLayout, useCurrentModule, useIsOwner, usePageRecordLabel, usePageToolbarSize, useDevReload, usePreferences, useFavoritePages, page setup functions, and more |
| UI toolkit | useModal, useDrawer, useConfirm, useConfirmFrom, useExportJob, usePageHeaderActions |
| Error feedback | useApiErrorPresenter |
| Utilities | useTranslation, useComposedText, useUnsavedChanges, usePageLeaveGuard, useOnboarding, isDmsHydrating |
Read the backend data a component renders with useApiData. Make every other backend call, such as a write or a read a click starts, with $authFetch from useAuthFetch, never with a bare $fetch. Only these two recover from an expired session, and only useApiData renders the data on the server and hands it to the browser. See Auth requests and permissions.