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

Incomplete documentation around FluxComponent #208

Open
chadly opened this issue May 28, 2015 · 3 comments
Open

Incomplete documentation around FluxComponent #208

chadly opened this issue May 28, 2015 · 3 comments

Comments

@chadly
Copy link

chadly commented May 28, 2015

I spent a good hour trying to figure this out until I found #61. flux it is not available on the react context unless you explicitly include it in contextTypes:

contextTypes: {
    flux: React.PropTypes.any
}

this.context.flux is undefined in a react component until you add the contextType. Just adding a note to that effect to the docs would be enormously helpful to beginners.

@acdlite
Copy link
Owner

acdlite commented May 28, 2015

That's a good point. Docs assume some knowledge of context already, which isn't nice for beginners.

@burabure
Copy link

burabure commented Jun 2, 2015

I explain context in my updated docs.#136 #169

@pburtchaell
Copy link

Yeah, I don't think it is good to assume knowledge of context since it is rather undocumented by the React team to begin with (which is reasonable considering it is "experimental"). 👍 to a PR to update the docs with that note.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants