Skip to content

Choose a service or composable ​

Service tokens are injected during setup or a provider factory. Composables usually capture those services or create state owned by the current Vue scope.

TaskAPIBehavior guide
Start applicationcreateAbpApp, provideAbpCore, withOptionsStartup
Create or replace a servicedefineService, defineToken, inject, provideAbpDI
Read framework stateuseConfigState, ConfigStateServiceState
Read useruseCurrentUserCurrent user
Login or logoutAuthService, provideAbpOAuthAuthentication
TranslateuseLocalization, $t, LocalizationServiceLocalization
Check policiesusePermission, PermissionServicePermissions
Read settings/featuresuseSetting, useFeatureSettings and features
Select tenantuseMultiTenancy, SessionStateServiceMulti-tenancy
Call backenduseRest, RestServiceHTTP
Register navigationRoutesService, lazyRoutesRouting
Query listsuseListService, useListPreferencesLists
Validate fieldsuseAbpForm, Validators, useValidationMessages, useServerValidationForms
Control asynchronous workuseLatest, useDebounceFn, useSubscriptionsRequests
Show feedbackuseToaster, useConfirmation, usePageAlertNotifications
Replace UIReplaceableComponentsService, provideThemeComponentsReplacement
Extend module pagesuseExtensions, EntityProp, FormProp, EntityAction, ToolbarActionExtensions

Providers and tokens ​

Provider functions belong in the providers array passed to createAbpApp. Tokens identify a service or a configurable value; replacing a token affects consumers resolving from that injector. EnvironmentProviders groups registrations.

Types and imports ​

Use IDE completion and go-to-definition for export names, generics, parameters and return types. This page helps choose a tool; the linked guides explain registration, composition and error handling.

Use public package entries rather than internal files. Mark types with import type or an inline type modifier. The application preset can automatically import common runtime tools; reusable libraries should use explicit imports.

The site follows main. Compare your installed version with the release notes before using an example. Your business DTOs come from your own backend; their fields may differ from the examples.

Unofficial community project. MIT licensed. Not affiliated with Volosoft.