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 React.addons.batchedUpdates #3570

Closed
glenjamin opened this issue Apr 2, 2015 · 13 comments
Closed

Document React.addons.batchedUpdates #3570

glenjamin opened this issue Apr 2, 2015 · 13 comments

Comments

@glenjamin
Copy link
Contributor

I didn't realise this was in the addons bundle, would be good to get it added to the docs.

http://facebook.github.io/react/docs/addons.html
https://github.com/facebook/react/blob/master/src/browser/ReactWithAddons.js#L40

Would be good to also include an example of using https://github.com/facebook/react/blob/master/src/addons/ReactRAFBatchingStrategy.js or something similar.

@sophiebits
Copy link
Collaborator

rAF batching isn't supported and won't go in the docs, but batchedUpdates should.

@glenjamin
Copy link
Contributor Author

is rAF batching discouraged, or just not suitable for shipping with core?

Would it be reasonable to link to an up-to-date npm project on the batchedUpdates page?

@sophiebits
Copy link
Collaborator

We don't use it at Facebook and it's not clear that it solves real problems, so we don't want to maintain it or have to fix bugs related to it. React.addons.batchedUpdates should give enough control over batching.

@zpao
Copy link
Member

zpao commented Apr 2, 2015

There are also known issues with rAF batching (mostly around controlled components).

@kassens
Copy link
Member

kassens commented Apr 8, 2015

Should we deprecate and eventually remove the RAF batching?

@sophiebits
Copy link
Collaborator

It's never been supported in any fashion.

@sophiebits
Copy link
Collaborator

(i.e., it's already deprecated?)

@chicoxyzzy
Copy link
Contributor

shouldn't this file be deleted in that case?
https://github.com/facebook/react/blob/master/src/addons/ReactRAFBatchingStrategy.js

@sophiebits
Copy link
Collaborator

That's not exposed as a public API in any of our builds, but sure, we can delete it – PR incoming.

@jimfb
Copy link
Contributor

jimfb commented Feb 10, 2016

Killed in #6016

@jimfb jimfb closed this as completed Feb 10, 2016
@sophiebits
Copy link
Collaborator

We should document ReactDOM.unstable_batchedUpdates.

@sophiebits sophiebits reopened this Feb 10, 2016
@jimfb
Copy link
Contributor

jimfb commented Feb 11, 2016

@spicyj Since when did we start documenting unstable_ features? Haven't we always left them intentionally undocumented? We also have unstable_renderSubtree and unstable_handleError and others, but I thought the decision was to not document them until they become stable. We document them as part of the release process.

It was a different situation when it was an addon, the issue made sense at that time.

@sophiebits
Copy link
Collaborator

Sure.

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

No branches or pull requests

6 participants