Documentation Index
Fetch the complete documentation index at: https://mintlify.com/SaulMoro/ngrx-rtk-query/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Get started with ngrx-rtk-query by installing it in your Angular project. The library requires@reduxjs/toolkit as a peer dependency.
Install the Package
Choose your preferred package manager to install ngrx-rtk-query:Peer Dependencies
The library requires the following peer dependencies:| Package | Version | Optional |
|---|---|---|
@angular/core | >=21.0.0 | No |
@reduxjs/toolkit | ~2.11.2 | No |
@ngrx/store | >=21.0.0 | Yes |
@ngrx/store is optional: You can use ngrx-rtk-query with or without NgRx Store. See Store Variants below.
Version Compatibility
The library versions align with Angular major versions. Always use the version that matches your Angular version:| Angular / NgRx | ngrx-rtk-query | @reduxjs/toolkit | Support |
|---|---|---|---|
| >=21.x | >=21.0.0 (signals) | ~2.11.2 | Bugs / New Features |
| >=20.x | >=20.0.0 (signals) | ~2.9.0 | Bugs |
| >=18.x | >=18.2.0 (signals) | ~2.6.0 | Bugs |
| >=18.x | >=18.1.0 (signals) | ~2.5.0 | Bugs |
| 18.x | >=18.0.0 (signals) | ~2.2.5 | Critical bugs |
| 17.x | >=17.1.x (signals) | ~2.2.1 | Critical bugs |
| 16.x | >=4.2.x (rxjs) | ~1.9.3 | Critical bugs |
| 15.x | 4.1.x (rxjs) | 1.9.3 | None |
Store Variants
ngrx-rtk-query offers two integration modes depending on whether you use NgRx Store in your application.With NgRx Store
If your application uses NgRx Store, install it alongside ngrx-rtk-query:Without NgRx Store (Noop Store)
For lightweight applications that don’t need NgRx Store, use the noop store variant:Import Paths
Depending on your setup, import from the appropriate paths:| Setup | Import Path |
|---|---|
| With NgRx Store | 'ngrx-rtk-query' |
| Core (no store) | 'ngrx-rtk-query/core' |
| Noop Store | 'ngrx-rtk-query/noop-store' |
Next Steps
Now that you have ngrx-rtk-query installed, continue to the Quick Start guide to build your first API integration:Quick Start Guide
Learn how to create your first API and use it in a component