Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document actionType exports #2459

Closed
griffinmichl opened this issue Jan 15, 2017 · 4 comments
Closed

Document actionType exports #2459

griffinmichl opened this issue Jan 15, 2017 · 4 comments
Labels

Comments

@griffinmichl
Copy link
Contributor

I find myself using the exported action types somewhat regularly when I combine redux-form with redux-observable or redux-saga. For example, if I want to hook into onChange actions to run async validation through a saga / epic as the user types. Sharing actions b/w reducers is also a powerful aspect of the redux architecture.

I think adding the exported actionTypes to the docs would expose people to all the possibilities this library offers.

I'd be happy to contribute this addition if it sounds worthwhile.

@gustavohenke
Copy link
Collaborator

Sure, go ahead!

What are your ideas on how to document this?

@griffinmichl
Copy link
Contributor Author

griffinmichl commented Jan 15, 2017

I was thinking a sidebar section that looks pretty similar to the action creators section and briefly explains why the actions are exported at the top.

I'd also add an example to the FAQ of using exported actions types to do something fancy that isn't supported natively by redux-form. I found the 'submitting a form with websockets' FAQ example super helpful as I figured out how to make redux-observable play well with redux-form, and I think more examples of just how much you can do w/ this library would be very cool.

Examples might be onChange async validation or providing feedback to the user as inputs come in (one project I'm working on requests and displays estimates of an advertiser's audience size via an epic as they input their targeting parameters into the form).

@gustavohenke
Copy link
Collaborator

Because this issue saw almost no activity for a few months, I'm closing it.

@lock
Copy link

lock bot commented Dec 7, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@lock lock bot locked as resolved and limited conversation to collaborators Dec 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants