GitBook: [master] 10 pages modified

Author: nmay231

docs/examples/readme.md

@@ -0,0 +1,4 @@
+# Examples
+
+* [Undoing/redoing actions in batches](undo-redo-batch-actions.md)
+

docs/main/examples/README.md

@@ -1,13 +1,15 @@
-## Undo-redo batch actions with custom groupBy
+# Undoing/redoing batches of actions at a time
 
 This is an example of how to use custom groupBy to undo-redo a batch of actions at the same time.
 
 This method remains the ability to group by action types but also enables us to group a batch of actions.
-- [x] Group by action types by default
-- [x] Group batch actions on demand, with `start()` and `end()`
 
-For example, an `onClick` event handler may dispatch a batch of actions. My way is to surround the batch of actions with `start()` and `end()`. 
-```js
+* [x] Group by action types by default
+* [x] Group batch actions on demand, with `start()` and `end()`
+
+For example, an `onClick` event handler may dispatch a batch of actions. My way is to surround the batch of actions with `start()` and `end()`.
+
+```javascript
 import { batchGroupBy } from './batchGroupBy'
 
 const mapDispatchToProps = (dispatch, ownProps) => ({
@@ -17,15 +19,15 @@ const mapDispatchToProps = (dispatch, ownProps) => ({
     dispatch(action1)
     dispatch(action2)
     dispatch(action3)
-    
+
     batchGroupBy.end()
   }
 });
 ```
 
 The basic idea is that once `batch.start()`, all the subsequent actions will return the same group value until meet `batch.end()`. Then `redux-undo` will automatically save them in one group, without inserting a new state in the `past` array.
 
-```js
+```javascript
 // batchGroupBy.js
 
 import { groupByActionTypes } from 'redux-undo'
@@ -44,10 +46,12 @@ export const batchGroupBy = {
   }
 };
 ```
+
 Note that we create a unique id whenever we call `batch.start()`. In such case, if two batches are called back-to-back, they have different group values so that they will be stored in two states, rather than one state.
 
 Then we can config the reducer like below:
-```js
+
+```javascript
 import { batchGroupBy } from './batchGroupBy'
 
 const rootReducer = combineReducers({
@@ -57,4 +61,6 @@ const rootReducer = combineReducers({
   }),
 });
 ```
-An array of action types can be passed into `init()`, which keeps the ability of grouping by action types if they are not within the scope of `start()` and `end()`.
+
+An array of action types can be passed into `init()`, which keeps the ability of grouping by action types if they are not within the scope of `start()` and `end()`.
+

docs/examples/undo-redo-batch-actions.md renamed to docs/main/examples/undo-redo-batch-actions.md

@@ -2,20 +2,20 @@
 
 ### Table of Contents
 
-- [Where can I get help using `redux-undo`?](#where-can-I-get-help-using-redux-undo)
-- [Where can I find examples of how to use `redux-undo`?](#where-can-i-find-examples-of-how-to-use-redux-undo)
-- [How do I prevent cluttering up history with rapidly changing state?](#how-do-I-prevent-cluttering-up-history-with-rapidly-changing-state)
-- [Can I have multiple, separate undoable functions?](#can-i-have-multiple-separate-undoable-functions)
-- [Why are my actions not being filtered?](#why-are-my-actions-not-being-filtered)
-- [What is `_latestUnfiltered`? Can I remove it?](#what-is-_latestUnfiltered-can-i-remove-it)
-- [Why am I getting `Cannot find module 'redux-undo'`?](#why-am-i-getting-cannot-find-module-redux-undo)
-- [How do I set an initial state/history?](upgrading-to-1.0.md#initialstate)
-- [How do I upgrade from 0.X to 1.0?](upgrading-to-1.0.md)
-- [How can I Undo or Redo a batch of actions at the same time ?](examples/undo-redo-batch-actions.md)
+* [Where can I get help using `redux-undo`?](faq.md#where-can-I-get-help-using-redux-undo)
+* [Where can I find examples of how to use `redux-undo`?](faq.md#where-can-i-find-examples-of-how-to-use-redux-undo)
+* [How do I prevent cluttering up history with rapidly changing state?](faq.md#how-do-I-prevent-cluttering-up-history-with-rapidly-changing-state)
+* [Can I have multiple, separate undoable functions?](faq.md#can-i-have-multiple-separate-undoable-functions)
+* [Why are my actions not being filtered?](faq.md#why-are-my-actions-not-being-filtered)
+* [What is `_latestUnfiltered`? Can I remove it?](faq.md#what-is-_latestUnfiltered-can-i-remove-it)
+* [Why am I getting `Cannot find module 'redux-undo'`?](faq.md#why-am-i-getting-cannot-find-module-redux-undo)
+* [How do I set an initial state/history?](upgrading-to-1.0.md#initialstate)
+* [How do I upgrade from 0.X to 1.0?](upgrading-to-1.0.md)
+* [How can I Undo or Redo a batch of actions at the same time ?](examples/undo-redo-batch-actions.md)
 
 ## Where can I get help using `redux-undo`?
 
-To get an understanding of the basics, read through the [README](/README.md) and checkout some [examples](#where-can-i-find-examples-of-how-to-use-redux-undo).
+To get an understanding of the basics, read through the [README](https://github.com/omnidan/redux-undo/tree/9a05150d6bcd3f71e56c3d9cb5e8669ac3d5c1dd/README.md) and checkout some [examples](faq.md#where-can-i-find-examples-of-how-to-use-redux-undo).
 
 To get help with a specific use case, see if there is already an example in these docs or the examples. If not, ask for help in the [gitter chat](https://gitter.im/omnidan/redux-undo)!
 
@@ -25,18 +25,18 @@ If it seems you have found a bug or you are itching for a new feature, go ahead
 
 Look at the `examples/` directory of the project folder. The `todos-with-undo/` is a good project to start messing with.
 
-```sh
+```bash
 $ git clone https://github.com/omnidan/redux-undo.git
 $ cd redux-undo/examples/todos-with-undo
 $ npm install
 $ npm start
 ```
 
-Just open http://localhost:3000 and you are good to go!
+Just open [http://localhost:3000](http://localhost:3000) and you are good to go!
 
 ## How do I prevent cluttering up history with rapidly changing state?
 
-The `throttled-drag/` project found the `examples/` directory gives a good demonstration of how to debounce undos (the filter is in `util/undoFilter.js`).
+The `throttled-drag/` project found the `examples/` directory gives a good demonstration of how to debounce undos \(the filter is in `util/undoFilter.js`\).
 
 This general question has different solutions depending on your exact problem. Let's say you have one or more rapidly dispatched actions, for example `MOVE_CURSOR` and `UPDATE_OBJECT_POS`, that ends with a lone action `PLACE_OBJECT`, and you only want to record the end state after `PLACE_OBJECT`. Then you can simply use a filter `excludeAction(['MOVE_CURSOR', 'UPDATE_OBJECT_POS'])`
 
@@ -46,7 +46,7 @@ For more complex requirements, consider writing your own [custom filter](https:/
 
 Yes you can! Simply wrap each reducer with its own `undoable()`.
 
-```js
+```javascript
 const rootReducer = combineReducers({
   someData: undoable(dataReducer),
   otherData: undoable(otherDataReducer)
@@ -55,7 +55,7 @@ const rootReducer = combineReducers({
 
 Do not forget to setup different undo/redo types to undo/redo each slice separately.
 
-```js
+```javascript
 someData: undoable(dataReducer, {
   undoType: "DATA_UNDO",
   redoType: "DATA_REDO"
@@ -65,7 +65,7 @@ someData: undoable(dataReducer, {
 
 If you wish to have a single conglomerate history that a user can undo one action at a time, you can wrap the root reducer with `undoable()`.
 
-```js
+```javascript
 const rootReducer = undoable(
   combineReducers({
     someData: dataReducer,
@@ -83,7 +83,7 @@ If you are trying to prevent actions from changing state, **that is not what `fi
 
 On the other hand, here is how to use the helper functions:
 
-```js
+```javascript
 undoable(myReducer, {
   filter: combineFilters(
     // includeAction/excludeAction helpers take an array of action type strings
@@ -95,7 +95,7 @@ undoable(myReducer, {
 
 When writing a custom filter, return `true` for actions that you want to keep in history.
 
-```js
+```javascript
 function onlyEveryThird(action, newState, history) {
   // Access the whole history object
   let { past, present, future, limit } = history;
@@ -108,9 +108,9 @@ function onlyEveryThird(action, newState, history) {
 
 ### What is it?
 
-State wrapped by `undoable()` contains the field `_latestUnfiltered` alongside `past`, `present`, etc. This field is used to keep track of state that should be put in the history but cannot yet because the previous action(s) were filtered. It is basically a temporary variable between filtered actions.
+State wrapped by `undoable()` contains the field `_latestUnfiltered` alongside `past`, `present`, etc. This field is used to keep track of state that should be put in the history but cannot yet because the previous action\(s\) were filtered. It is basically a temporary variable between filtered actions.
 
-```js
+```javascript
 // This action is filtered, so present cannot be pushed into past right away
 _latestUnfiltered = present;
 present = newState;
@@ -129,7 +129,7 @@ While there is a tad more overhead handling actions in the reducer, it is necess
 
 If you are using redux-undo in a CommonJS or UMD environment, you need to add `.default` to your imports.
 
-```js
+```javascript
 // CJS
 var undoable = require("redux-undo").default;
 
@@ -139,8 +139,9 @@ var undoable = window.ReduxUndo.default;
 
 ES6 imports should work without a hitch.
 
-```js
+```javascript
 import undoable from "redux-undo";
 ```
 
 If this fixed your issue, you might also want to checkout how to [upgrade from 0.6 to 1.0](upgrading-to-1.0.md).
+

docs/faq.md renamed to docs/main/faq.md

@@ -1,10 +1,10 @@
-# Upgrading redux-undo from 0.x to 1.0
+# Upgrading to 1.0
 
 ## Imports
 
 CommonJS and UMD bundles now need a `.default` added to your imports.
 
-```js
+```javascript
 // CJS
 var undoable = require("redux-undo").default;
 
@@ -14,19 +14,19 @@ var undoable = window.ReduxUndo.default;
 
 ES6 imports should work as expected.
 
-```js
+```javascript
 import undoable from "redux-undo";
 ```
 
 ## `distinctState()` filter applied by default
 
-In 1.0 and greater, state is only added to history if it is different than the previous state (checked by object reference equality `===`). The `distinctState()` filter is now deprecated and removed as there is no need for it.
+In 1.0 and greater, state is only added to history if it is different than the previous state \(checked by object reference equality `===`\). The `distinctState()` filter is now deprecated and removed as there is no need for it.
 
 ## History API change in versions `< 0.4`
 
 In versions 0.3 and earlier, the history state was stored in the form.
 
-```js
+```javascript
 {
   currentState: {...currentStateHere...},
   history: {
@@ -39,7 +39,7 @@ In versions 0.3 and earlier, the history state was stored in the form.
 
 In versions `0.4` and greater, the full history is exposed directly.
 
-```js
+```javascript
 {
   past: [...pastStatesHere...],
   present: {...currentStateHere...},
@@ -51,7 +51,7 @@ In versions `0.4` and greater, the full history is exposed directly.
 
 Before `1.0`, you would pass an `initialState` or `initialHistory` as a config option.
 
-```js
+```javascript
 undoable(myReducer, {
   initialState: {
     myState: "initial",
@@ -63,7 +63,7 @@ undoable(myReducer, {
 
 Now, these options are removed in favor of Redux's `preloadedState` parameter.
 
-```js
+```javascript
 const rootReducer = combineReducers({
   myReducer: undoable(myReducer)
 });
@@ -76,11 +76,11 @@ const store = createStore(rootReducer, {
 });
 ```
 
-When providing initial state, redux-undo will automatically detect whether or not it is a complete history (with `past`, `present`, `future`) or not. If it is not, it will automatically convert it to one.
+When providing initial state, redux-undo will automatically detect whether or not it is a complete history \(with `past`, `present`, `future`\) or not. If it is not, it will automatically convert it to one.
 
 If you wish to provide an initial history, e.g. you want to prefill `past` to recover a previous session, you **must** provide the three fields for redux-undo to recognize it as a history object.
 
-```js
+```javascript
 const store = createStore(rootReducer, {
   myReducer: {
     past: ["from", "previous", "session"],
@@ -92,3 +92,4 @@ const store = createStore(rootReducer, {
   }
 });
 ```
+

docs/upgrading-to-1.0.md renamed to docs/main/upgrading-to-1.0.md

@@ -1,4 +1,4 @@
-# Introduction
+# About
 
 [![NPM version \(>=0.4\)](https://img.shields.io/npm/v/redux-undo.svg?style=flat-square)](https://www.npmjs.com/package/redux-undo) [![NPM Downloads](https://img.shields.io/npm/dm/redux-undo.svg?style=flat-square)](https://www.npmjs.com/package/redux-undo) [![Coverage Status](https://img.shields.io/coveralls/omnidan/redux-undo.svg?style=flat-square)](https://coveralls.io/r/omnidan/redux-undo) [![Dependencies](https://img.shields.io/david/omnidan/redux-undo.svg?style=flat-square)](https://david-dm.org/omnidan/redux-undo) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](http://standardjs.com/) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/omnidan/redux-undo/master/LICENSE.md)
 
@@ -8,7 +8,7 @@ _simple undo/redo functionality for redux state containers_
 
 **Protip:** Check out the [todos-with-undo example](https://github.com/omnidan/redux-undo/tree/master/examples/todos-with-undo) or the [redux-undo-boilerplate](https://github.com/omnidan/redux-undo-boilerplate) to quickly get started with `redux-undo`.
 
-**Switching from 0.x to 1.0:** Make sure to update your programs to the [latest History API](./#history-api).
+**Switching from 0.x to 1.0:** Make sure to update your programs to the [latest History API](readme.md#history-api).
 
 **Help wanted:** We are looking for volunteers to maintain this project, if you are interested, feel free to contact me at [[email protected]](mailto:[email protected])
 
@@ -74,7 +74,7 @@ combineReducers({
 })
 ```
 
-A [configuration](./#configuration) can be passed like this:
+A [configuration](readme.md#configuration) can be passed like this:
 
 ```javascript
 combineReducers({

docs/readme.md

@@ -1,9 +1,11 @@
-# Table of Contents
+# Table of contents
+
+* [About](readme.md)
 
 ## Main
 
-- [About](./readme.md)
-- [FAQ](./faq.md)
-- [Examples](examples/readme.md)
-  - [Undoing/redoing batches of actions at a time](examples/undo-redo-batch-actions.md)
-- [Upgrading to 1.0](./upgrading-to-1.0.md)
+* [FAQ](main/faq.md)
+* [Examples](main/examples/README.md)
+  * [Undoing/redoing batches of actions at a time](main/examples/undo-redo-batch-actions.md)
+* [Upgrading to 1.0](main/upgrading-to-1.0.md)
+