Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/yasser-g/react-native-redux

React Native Redux
https://github.com/yasser-g/react-native-redux

react react-hooks react-native react-redux reactjs redux redux-actions redux-persist redux-store redux-thunk

Last synced: 2 months ago
JSON representation

React Native Redux

Awesome Lists containing this project

README 

        
# React Native Redux 

![npm][npmDownloads] ![PRsBadge] ![npm][npmLicense] ![npm][npmVersion]



### Implement react redux into your app in just One Step!



- No Store configuration needed!

- No MiddleWares needed, no more dispatch complications.

- No Reducers or *ACTIONS* required.

- No Persistance configuration needed, All data are persisted!

- Very simple way to change store state, just like Component setState !

- Simply connect your components with simpler connect function

- Easily use hooks for your functional component, Dive deep in state up to 5 levels!.

- Built on redux, react-redux and redux-persist, No previous experience needed.

###### Note that this lib was known before as [Step React Redux][StepReactRedux].



## Instalation 



- Install & Link [React Native Async Storage][asyncstorage]   **// SKIP this step if already using react-native async storage**



	



- Then install React Native Redux



	`npm i react-native-redux`  **- OR -**  `yarn add react-native-redux`



## Usage



### **Provider**

###### Props

```ts

initialState: object?

loading: JSX.Element?

```

###### Usage

```ts

import React from "react"

import { Provider } from "react-native-redux"

import AppContainer from "../navigation" // Path to Root Navigation



const myInitialState = { /* your initial state */ }

/*

 Important Note: state will initialize for first time only,

 then you have to use xSetState or setStateForKey to change it,

 If you want to reinitialize state, you have to call xResetState once.

 See xResetState below

*/



export default ()=> (

  

    

  

)

```



---



### **connect**

###### Arguments

```ts

WrappedComponent: Component

requiredKeys: string[]?

```

###### Usage

 

```ts

import React from "react"

import { connect } from "react-native-redux"



class UserPage extend React.Component {

  // Your Component goes here

}



// this will connect all your store to UserPage component props

export default connect(UserPage) 



/*

 OR you can choose what keys this component using by providing requiredKeys argument

 NOTE: Make sure that your requiredKeys values are already initiated.

*/ 



export default connect(UserPage, ["user", "someKey", "anotherKey"])



// You can also connect to deep state ( Up to 5 levels ) using dotted key. 

export default connect(UserPage, ["user.name"])

// a prop with key "user_name" will be connected



// You can change deepKeyReplacer as a third optional argument

export default connect(UserPage, ["user.name"], "-")

// a prop with key "user-name" will be connected



```



---



### **xSetState**

###### Arguments

```ts

state: object

```

###### Usage



```ts

import { xSetState } from "react-native-redux"



// Anywhere in your code



xSetState({ user: { id: 1, name: "Some Name" } })

// console logs => ReactNativeRedux.user, { id: 1, name: "Some Name" }

// Now all your connected components will have "user" prop



// Usage with API



async getMyData(){



    xSetState({ isFetching: true })



    try {



      const response = await fetch("http://www.myServer.com/api/myData")

      const responseJson = await response.json()

      xSetState({ isFetching: false, myData: responseJson  })



    } catch (error) {



      alert(error.message)



      // Remeber that You can use xSetState ANYWHERE! as much as you want !

      xSetState({ isFetching: false })

    }



}

```



---



### **setStateForKey**

###### Arguments

```ts

key: string

state: object

```

###### Usage



```ts

import { setStateForKey } from "react-native-redux"



// Similar to xSetState

// plus it can be used to set deep state up to 3 levels



setStateForKey("user", { id: 1, name: "Some Name" })



// console logs => ReactNativeRedux.user, { id: 1, name: "Some Name" }

// Now all your connected components will have "user" prop



// Usage to set deep state



setStateForKey("user.name", "New Name" )



// console logs => ReactNativeRedux.user.name, "New Name"

// Remeber that You can use setStateForKey ANYWHERE!

```



---



### **getStateForKey**

###### Arguments

```ts

key: string

```

###### Usage



```ts

import { getStateForKey } from "react-native-redux"



// Similar to setStateForKey

// but it can be used to get state and deep state



const userData = getStateForKey("user") 

console.log(userData) // => { id: 1, name: "Some Name" }



const userName = getStateForKey("user.name") 

console.log(userName) // => "Some Name"



// getting state for unknown key will return null

const someValue = getStateForKey("someKey") 

console.log(someValue) // => null



const anotherValue = getStateForKey("anotherKey.subKey") 

console.log(anotherValue) // => null



// You may add fallback value as second optional argument

/// default fallback is null

const undefinedValue = getStateForKey("somekey.subKey.subsubkey","Hello World") 

console.log(anotherValue) // =>  Hello World



// Remeber that You can use getStateForKey ANYWHERE!

```



### **useStateX** (Hook)



##### You may like to try our new set of hooks [React Stateful Function][ReactStatefulFunction].

###### Usage

 

```ts

import React from "react"

import { useStateX } from "react-native-redux"



// Hooks Are used inside functional components



const MyComponent = (props) => {



	// Depth: 2 levels

	const isLoggedIn = useStateX("user.loggedIn")

	

	// Depth: 3 levels

	const userName = isLoggedIn ? useStateX("user.data.name") : "Guest"

	

  // NOTE THAT DEPTH TREE SHOULD BE INITIALIZED BEFORE HOOKING IT

  

  // You may add fallback value as second optional argument

  // default fallback is null

  const undefinedValue = getStateForKey("somekey.subKey.subsubkey","Hello World") 

  console.log(anotherValue) // =>  Hello World

	

	return (

		<>

		// Your Component goes here

		Name: {userName}

		>

	)

	

  

}



export default MyComponent



```



---



### **xResetState** (Dev Only)



###### Usage

 

```ts

import React from "react"

import { xResetState } from "react-native-redux"



/*

Top level index in your code, call this method once during your develeopment process

to allow you to reinitialize your state again from Provider initialState prop

*/



// Call this Once, Then Don't forget to remove it.



xResetState()



```



[asyncstorage]: https://github.com/react-native-community/async-storage#install

[StepReactRedux]: https://github.com/Yasser-G/step-react-redux

[ReactStatefulFunction]: https://github.com/Yasser-G/React-Stateful-Function

[npmDownloads]: 

[npmLicense]: 

[npmVersion]: 

[PRsBadge]: