Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/reduxjs/angular-redux

Official Angular bindings for Redux
https://github.com/reduxjs/angular-redux

angular redux

Last synced: about 2 months ago
JSON representation

Official Angular bindings for Redux

Host: GitHub
URL: https://github.com/reduxjs/angular-redux
Owner: reduxjs
License: mit
Created: 2024-09-02T09:27:17.000Z (2 months ago)
Default Branch: main
Last Pushed: 2024-09-16T18:23:54.000Z (about 2 months ago)
Last Synced: 2024-09-17T08:19:05.682Z (about 2 months ago)
Topics: angular, redux
Language: TypeScript
Homepage:
Size: 1.49 MB
Stars: 51
Watchers: 1
Forks: 6
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

awesome-angular - angular-redux - Unofficial Angular bindings for [Redux](https://redux.js.org/). (Table of contents / Third Party Components)
fucking-awesome-angular - angular-redux - Unofficial Angular bindings for 🌎 [Redux](redux.js.org/). (Table of contents / Third Party Components)
fucking-awesome-angular - angular-redux - Unofficial Angular bindings for 🌎 [Redux](redux.js.org/). (Table of contents / Third Party Components)
fucking-awesome-angular - angular-redux - Unofficial Angular bindings for 🌎 [Redux](redux.js.org/). (Table of contents / Third Party Components)

README

        # Angular Redux

Official Angular bindings for [Redux](https://github.com/reduxjs/redux).

Performant and flexible.

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/reduxjs/angular-redux/test.yml?style=flat-square) [![npm version](https://img.shields.io/npm/v/@reduxjs/angular-redux.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/angular-redux)

[![npm downloads](https://img.shields.io/npm/dm/@reduxjs/angular-redux.svg?style=flat-square)](https://www.npmjs.com/package/@reduxjs/angular-redux)

[![#redux channel on Discord](https://img.shields.io/badge/[email protected]?style=flat-square)](http://www.reactiflux.com)

## Installation

Angular Redux requires **Angular 17.3 or later**.

### Installing with `ng add`

You can install the Store to your project with the following `ng add` command (details here):

```sh

ng add @reduxjs/angular-redux@latest

```

#### Optional `ng add` flags

| flag          | description                                                                                                                                                                         | value type | default value |

| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------- |

| `--path`      | Path to the module that you wish to add the import for the StoreModule to.                                                                                                          | `string`   |

| `--project`   | Name of the project defined in your `angular.json` to help locating the module to add the `provideRedux` to.                                                                        | `string`   |

| `--module`    | Name of file containing the module that you wish to add the import for the `provideRedux` to. Can also include the relative path to the file. For example, `src/app/app.module.ts`. | `string`   | `app`         |

| `--storePath` | The file path to create the state in.                                                                                                                                               | `string`   | `store`       |

This command will automate the following steps:

1. Update `package.json` > `dependencies` with Redux, Redux Toolkit, and Angular Redux

2. Run `npm install` to install those dependencies.

3. Update your `src/app/app.module.ts` > `imports` array with `provideRedux({store})`

4. If the project is using a `standalone bootstrap`, it adds `provideRedux({store})` into the application config.

## Installing with `npm` or `yarn`

To use React Redux with your Angular app, install it as a dependency:

```bash

# If you use npm:

npm install @reduxjs/angular-redux

# Or if you use Yarn:

yarn add @reduxjs/angular-redux

```

You'll also need to [install Redux](https://redux.js.org/introduction/installation) and [set up a Redux store](https://redux.js.org/recipes/configuring-your-store/) in your app.

## Documentation

The React Redux docs are published at **https://angular-redux.js.org** .

## License

[MIT](LICENSE.md)