Commit Graph

1417 Commits

Author SHA1 Message Date
Rich Harris
a0038f80df add docs for building with Rollup (#8799)
* add docs for building with Rollup

* Tiny unrelated fix
2017-01-17 05:55:49 -08:00
Superlaziness
b2f388cd91 fix HOC doc (#8802) 2017-01-16 06:49:01 -08:00
Vladimir Tikunov
f21d4f857c Remove error ref to the 'render' function (#8781)
What is the `render` function of a functional component?
2017-01-14 13:36:55 -06:00
Iurii Kucherov
85b5d37961 Update higher-order-components.md (#8780) 2017-01-13 13:17:48 -08:00
Whien
6f0e389108 move blog post [Profiling Components with Chrome Timeline] into docs article (#8680)
* move blog post into docs article

* move to second section and changed description

* Minor tweak
2017-01-12 07:06:15 -08:00
Snowmanzzz(Zhengzhong Zhao)
45000cb3a7 Update handling-events.md (#8762)
* Update handling-events.md

* Update handling-events.md
2017-01-12 06:30:43 -08:00
Tomáš Hromada
27acbb08f3 Added more info about refs in the documentation (#8707)
* Update refs-and-the-dom.md

I want to propose some changes to the Refs and the DOM documentation page. 
- Make it clear that string refs are legacy. It seems that this information got lost during the transition to new docs and only some part stayed the same, which was confusing when first reading the docs.
- Clarify and explain that during render, if the ref callback is provided, it will get called twice, first with `null` and then with the rendered DOM element. Discussed in https://github.com/facebook/react/issues/4533 and first proposed docs change in PR #8333.

I've also planned on adding an example for passing the refs up the component chain based on something I've needed to solve myself (e.g. you want to connect two dynamic components by line in React, so you need to both use refs and propagate them up the chain), and while it would be great to read up on this in the docs, it may be too specific for this section; I'd be happy to hear any recommendations.

* Adds more specific information about the callback

* Moved the ref callback description to the Caveats section

* Fixed suggested nits

* Replace 'each render pass' with 'updates'

* Tweak the wording
2017-01-10 12:18:23 -08:00
Dmitry Zhuravlev-Nevsky
4599dc5dcd Fix single vs plural (#8738)
Maybe it's not very important, just misprint fix
2017-01-10 08:00:16 -08:00
Spen Taylor
201cce9207 [Docs] Replace 'mix in' in PureComponent notes (#8730)
* [Docs] Replace 'mix in' in PureComponent notes

* Style nit
2017-01-10 06:02:22 -08:00
Dmitry Zhuravlev-Nevsky
2911b89396 Swap components (#8735)
It's better to delare component before using.
2017-01-10 02:48:53 -08:00
Nik Nyby
e079ba4d10 docs: add missing period in shouldComponentUpdate doc (#8720) 2017-01-09 08:22:04 -08:00
Bruno Heridet
ca173ef961 docs(hoc): fix typo Rambda → Ramda (#8712) 2017-01-08 10:26:46 -06:00
Brandon Dail
55568c8c57 Point all Webpack links to 1.x documentation (#8697)
* Point all Webpack links to 1.x documentation

* Add back webpack production guide, add warning
2017-01-06 12:51:26 -06:00
Murtaza Haveliwala
290cfc1afc Update rendering-elements.md
Updating text to be in sync with sample html
2017-01-06 23:32:26 +05:30
Murtaza Haveliwala
081ba8edbc Updated hello world explanation message (#8703)
Output text in explanation now in sync with code sample
2017-01-06 11:59:14 -06:00
Piotr Czajkowski
095b1ec6f7 "Don't Mutate the Original Component" example and description mismatch (#8695) 2017-01-05 05:12:51 -08:00
Piotr Czajkowski
76a149320b Higher-Order Components docs withSubscription() example fix (#8694) 2017-01-05 04:56:13 -08:00
Mateusz Burzyński
54f955de26 [Docs] Fixed anchor links in Animations section (#8453) 2017-01-04 09:24:21 -08:00
Van der Auwermeulen Grégoire
3b671d1d1b Update state-and-lifecycle.md (#8424)
* Update state-and-lifecycle.md

Isn't  clock state and props the same in this example?

* Clarify
2017-01-04 09:18:52 -08:00
Mojtaba Dashtinejad
62ea0290ed [docs] Add a note about componentWillReceiveProps (#8234)
* Component Lifecycle In Depth documentation

* first steps to improve react component reference

* improved react component reference

- remove the component-lifecycle-in-depth

* add a note for usage of ReactDOM.findDOMNode

* one note on componentWillReceiveProps

* remove old useless images for lifecycle docs

* Tweak wording
2017-01-04 08:26:33 -08:00
Dan Abramov
a1f22dd855 Nitpick: use FB style in doc 2017-01-04 15:59:32 +00:00
gitanupam
a53d2acaf9 Changed webpack's hyperlink (#8650)
..to point to 2.x documentation instead of 1.x (and to be consistent with other links on the page)
2016-12-28 11:34:00 -06:00
gitanupam
864a2c76b8 'npm init' needed before installing react via npm. (#8649)
* 'npm init' needed before installing react via npm.

I was trying to install react in my django project directory and was getting warnings about package.json not being present. Started this SO post (http://stackoverflow.com/questions/41340909/npm-cant-find-package-json-when-installing-react/41340975#41340975) to figure it out. I think it'll be useful to others too if we add it in the documentation itself.

* Tweak instructions
2016-12-28 04:04:21 -08:00
Eric Pitcher
9f3ae7247e Update conditional-rendering.md (#8636)
Stating the fact that component lifecycle methods will still fire as normal even though you return null from the render method.
2016-12-24 09:18:30 -08:00
comerc
e875fa0967 Fix casing typo in jsx-in-depth.md (#8542) 2016-12-11 07:43:40 -06:00
Chris
dd5a665d42 update example to use this.state (#8425)
- In the previous example, the code works even without using bind(this) in the constructor.
- the reason being handleClick doesn't even use `this` and its just calling the global function alert.
- this change make use of this via access this.state.
2016-12-11 07:41:48 -06:00
Liz
081c20f66f 👏 designers are friends, not fodder for jokes (#8523) 2016-12-07 15:09:37 -08:00
Brandon Dail
0ed6236931 Merge pull request #8476 from AlanBreck/patch-1
Update reference-react.md
2016-12-02 09:16:39 -06:00
lucas
ab12949031 Add return to render 2016-12-01 19:21:40 -03:00
Jacob Lamont
68b9b2037c Update reference-react.md 2016-12-01 14:35:48 -05:00
Andrew Clark
e3d37fdb90 Add a document on higher-order components (#7869) 2016-11-29 10:47:54 -08:00
Richard Maisano
4851bd7cec Add a couple missing SVG tags to DOM Elements docs (#8383)
My first contribution to React!

While upgrading a React project, I found some suspect SVG that needed updating, so I dug in after checking the docs. I knew that support for some SVG properties had been added (namely `xmlns` and `xmlnsXlink`), but I noticed them missing from the reference's attribute list. This pull request updates `reference-dom-elements.md` by adding said properties.
2016-11-22 18:50:11 +00:00
Simen Bekkhus
5df573a518 Fix link to PureComponent in docs (#8375) 2016-11-22 11:09:07 +00:00
Michael Sinov
d00d8c81cd update react-without-es6.md (#8351) 2016-11-19 18:19:16 +00:00
Dan Abramov
95f34e9bf3 Merge pull request #8346 from shubheksha/docs/improve-state-and-lifecycle
Improved sections of state and lifecycle docs
2016-11-18 18:24:27 +00:00
Dan Abramov
9c9ecee640 Minor changes, make it more verbose 2016-11-18 18:24:15 +00:00
Shubheksha Jalan
a409b4df32 Improved sections of state and lifecycle docs 2016-11-18 22:14:27 +05:30
Dan Abramov
48ef385cb0 Merge pull request #8345 from shubheksha/docs/improve-introducing-jsx
Improved some sections of the introducing JSX docs
2016-11-18 16:20:48 +00:00
Dan Abramov
5c995eebba Small nit: add a sentence about readability back 2016-11-18 16:20:17 +00:00
Shubheksha Jalan
448aa90482 Improved some sections of the introducing JSX docs 2016-11-18 21:09:34 +05:30
Dan Abramov
5aea26b4b3 Merge pull request #8332 from gaearon/prod-dev
[Docs] Expand Installation and clarify why use bundlers
2016-11-18 12:26:22 +00:00
Dan Abramov
36564ab0fa Nits 2016-11-18 12:26:06 +00:00
Kevin Lacker
ba8004f607 add link to useful doc 2016-11-17 10:49:02 -08:00
Dan Abramov
d7e37c6dfb Explain Installation in more detail 2016-11-17 15:55:56 +00:00
Dan Abramov
aad104265a Tweak examples 2016-11-17 14:23:20 +00:00
Marcy Sutton
017a36c6f9 fix(a11y): add missing labels to forms doc
Showing how to create a form without labeling inputs is an accessibility anti-pattern. This change adds labels to the examples to address that. Codepen may still need to be updated depending on how that example is created.
2016-11-16 14:32:42 -08:00
Brandon Dail
9621017ec2 Merge pull request #8277 from qiuyuntao/master
docs: delete unnecessary brackets
2016-11-14 17:37:02 -06:00
Anastasia A
125153c109 Update reference-react-dom.md
Add missing closing bracket
2016-11-14 10:33:07 +03:00
yuntao.qyt
c96979bd75 docs: delete unnecessary brackets 2016-11-13 16:29:18 +08:00
Michele Bertoli
82802a0da9 Make the Shallow Rendering example clearer (#8269)
* Make the Shallow Rendering example clearer

I was reading through the documentation, and I found that the `render` call on the `renderer` was missing.

* Use a regular function to define MyComponent
2016-11-11 15:34:11 +00:00