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

Flesh out reference documentation, more API info #351

Merged
merged 1 commit into from
Sep 17, 2013

Conversation

sophiebits
Copy link
Collaborator

I created a new "Reference" section on the left with more API docs including a list of all supported tags, attributes, and events. This goes some of the way towards #171 but doesn't really explain how all the delegation works so there's still more work to be done.

image

See it in action at http://benalpert.com/react/docs/core-api.html.


* We've included [a step-by-step comment box tutorial](./tutorial.html).
* [The React starter kit](/react/downloads.html) includes several examples which you can [view online in our GitHub repository](https://github.com/facebook/react/tree/master/examples/).
* [reactapp](https://github.com/jordwalke/reactapp) is a simple app template to get you up-and-running quickly with React.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. I seem to remember this getting changed somewhere but this is what master says right now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@petehunt
Copy link
Contributor

I wonder if we should put parens after method names in the headings.

Core API

I don't really like the word "core", would "top-level" be more descriptive?

In renderComponentToString() could you mention search engine optimization?

Component API

On the docs for transferPropsTo() can you mention:

  1. It's really useful if you have a component that basically represents an HTML-like component (i.e. more oriented towards pure display). Usually this is indicated by calling it on the return value of render()
  2. It's really dangerous since it can introduce implicit dependencies between components and you should try not to use it that often.

nextState could use backticks

Component Specs and Lifecycle

When I hear "spec" in JS land I think Jasmine test. I don't have a better alternative for you though, so not a huge deal.

setTimeout could use backticks

Tags and Attributes

"to match the DOM" => "to match the DOM API specification"

Event System

nativeEvent needs backticks

DOM differences

"We intentionally break with the spec here" has a comma splice

Other than that lgtm

petehunt added a commit that referenced this pull request Sep 17, 2013
Flesh out reference documentation, more API info
@petehunt petehunt merged commit a9d53da into facebook:master Sep 17, 2013
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

Successfully merging this pull request may close these issues.

3 participants