Skip to content

Commit 15c39a6

Browse files
authored
Merge pull request #3 from madmax983/Rewrite
Rewrite
2 parents 2f5fb77 + ea3f361 commit 15c39a6

File tree

5 files changed

+12
-114
lines changed

5 files changed

+12
-114
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The new version of Lightning-Redux simplifies the previous iteration down to a s
55

66
### Component Methods
77
####
8-
##### createStore(name, reducer, initialState, middleware): create the Redux store.
8+
**createStore(name, reducer, initialState, middleware):** create the Redux store.
99

1010
name: The name of the slice of state for the reducer creating the store.
1111

@@ -15,28 +15,33 @@ initialState: You can specify an initial shape to your store's shape.
1515

1616
middleware: You can include redux middleware like redux-thunk here. Lightning-Redux automatically wraps this with Redux compose.
1717

18-
##### dispatch(action): Works like you would expect. Dispatches the action to the Redux store. Fun fact: connect also sets a dispatch expando on the connected component for convenience.
18+
**dispatch(action):** Works like you would expect. Dispatches the action to the Redux store. Fun fact: connect also sets a dispatch expando on the connected component for convenience.
1919

20-
##### subscribe(listener): This shouldn't be needed to be implemented, but is provided in case you want to write a custom connect method. The listener callback will be called on store updates.
20+
**subscribe(listener):** This shouldn't be needed to be implemented, but is provided in case you want to write a custom connect method. The listener callback will be called on store updates.
2121

22-
##### replaceReducer(nextReducer): Wraps Redux's replaceReducer function. Replaces the reducer function in the redux store.
22+
**replaceReducer(nextReducer):** Wraps Redux's replaceReducer function. Replaces the reducer function in the redux store.
2323

24-
##### registerReducer(name, reducer): Adds the specified reducer function to the redux store with the specificed name as it's slice of state.
24+
**registerReducer(name, reducer):** Adds the specified reducer function to the redux store with the specificed name as it's slice of state.
2525

26-
##### connect(mapStateToAttributes, target): mapStateToAttributes is a key pair object where the key is the attribute on the component you want set, and the value is either the value in the redux state graph, or a callback function. This function receives the component and state to compute the value. You can pass the component you want connected, but if it isn't populated, it will get populated by event.getSource(). It also sets a dispatch expando for convenience in the component's controller methods.
26+
**connect(mapStateToAttributes, target):** mapStateToAttributes is a key pair object where the key is the attribute on the component you want set, and the value is either the value in the redux state graph, or a callback function. This function receives the component and state to compute the value. You can pass the component you want connected, but if it isn't populated, it will get populated by event.getSource(). It also sets a dispatch expando for convenience in the component's controller methods.
2727

28-
##### getState: Technically not a component method, this is a convenience expando that allows access to the Redux state.
28+
**getState():** Technically not a component method, this is a convenience expando that allows access to the Redux state.
2929

3030
## Installation
3131
Lightning-Redux Unmanaged Packaged (Redux Component, redux and redux-thunk static resource): https://login.salesforce.com/packaging/installPackage.apexp?p0=04t50000000M7PT
32+
3233
Lightning-Redux-Examples (Counter and Todo Examples unmanaged package): https://login.salesforce.com/packaging/installPackage.apexp?p0=04t50000000M7Pi
3334

3435
Otherwise, you can use the SFDX CLI to convert the source and do a metadata deploy.
3536

3637
## Resources
3738
Redux Documentation: http://redux.js.org/
39+
3840
Awesome Redux: https://github.com/xgrommx/awesome-redux
41+
3942
Lightning Components Developer Guide: https://developer.salesforce.com/docs/atlas.en-us.lightning.meta/lightning/intro_framework.htm
43+
4044
Awesome Lightning: https://github.com/mailtoharshit/awesome-lighting
45+
4146
Awesome Salesforce: https://github.com/mailtoharshit/awesome-salesforce
4247

gulpfile.js

Lines changed: 0 additions & 90 deletions
This file was deleted.

jsforce.config.editme.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

package.xml

Lines changed: 0 additions & 12 deletions
This file was deleted.

rbDF16_Mark_Masterson_R3.pptx

-6.8 MB
Binary file not shown.

0 commit comments

Comments
 (0)