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.
| Task | API | Behavior guide |
|---|---|---|
| Start application | createAbpApp, provideAbpCore, withOptions | Startup |
| Create or replace a service | defineService, defineToken, inject, provideAbp | DI |
| Read framework state | useConfigState, ConfigStateService | State |
| Read user | useCurrentUser | Current user |
| Login or logout | AuthService, provideAbpOAuth | Authentication |
| Translate | useLocalization, $t, LocalizationService | Localization |
| Check policies | usePermission, PermissionService | Permissions |
| Read settings/features | useSetting, useFeature | Settings and features |
| Select tenant | useMultiTenancy, SessionStateService | Multi-tenancy |
| Call backend | useRest, RestService | HTTP |
| Register navigation | RoutesService, lazyRoutes | Routing |
| Query lists | useListService, useListPreferences | Lists |
| Validate fields | useAbpForm, Validators, useValidationMessages, useServerValidation | Forms |
| Control asynchronous work | useLatest, useDebounceFn, useSubscriptions | Requests |
| Show feedback | useToaster, useConfirmation, usePageAlert | Notifications |
| Replace UI | ReplaceableComponentsService, provideThemeComponents | Replacement |
| Extend module pages | useExtensions, EntityProp, FormProp, EntityAction, ToolbarAction | Extensions |
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.