Commit Graph

65 Commits

Author SHA1 Message Date
Dan Abramov
bcf8a08a0f Add missing tutorial sidebar links 2017-04-18 18:00:54 +01:00
Andrew Clark
023710a13b Blog post and changelog for 15.5.0 (#9368) 2017-04-07 14:41:16 -07:00
Flarnie Marchan
803e5da950 All doc updates forv15.5 (#9359)
* `react-addons-test-utils` -> `react-dom/test-utils`

Updating all references and docs on the `React.addons.TestUtils` and the
shallow renderer to refer to the correct targets.

Instead of:
```
const React = require('react');

// ...
React.addons.Testutils
// or

const ReactTestUtils = require('react-addons-test-utils');
```
we now show:
```
const ReactTestUtils = require('react-dom/test-utils');
```

And for shallow renderer, instead of:
```
const shallowRenderer = TestUtils.createRenderer();
```

we now show:
```
const shallowRenderer = require('react-test-renderer/shallow');
```

* Update the 'prev' and 'next' attributes of 'add-ons' docs

These flags are used to set arrow links to easily navigate through the
documents. They were wrong or missing in some of the 'add-ons' pages and
this bothered me when manually testing the updates from the previous
commit.

* Update syntax for instantiating shallow renderer

Missed this when updating the docs for the changes to shallow-renderer
in React 15.5.

* Fix pointers in addons docs

Thanks @bvaughn for catching this

* Make example of shallow renderer more consistent

We should show using the same variable names between code samples.

* Make names in example even more consistent

We should use the same variable name for the same thing across examples.
`renderer` -> `shallowRenderer`.

* Update docs to deprecate React<CSS>TransitionGroup

 - removes link to the docs about `ReactCSSTransitionGroup` and
   `ReactTransitionGroup` from the main navigation
 - updates 'prev' and 'next' pointers to skip this page
 - adds deprecation warning to the top of the page
 - remove references to these modules from the packages README
 - updates 'add-ons' main page to list this as a deprecated add-on

* Update `React.createClass` to `createReactClass` in the docs

The `React.createClass` method is being deprecated in favor of
`createReactClass`.

* Remove 'React.createClass' from top level API docs

It no longer makes sense to have a section for the 'createClass' method
in this page, since it won't be available as a top level method on
'React'.

I initially was going to pull the section about 'createClass' into a
separate page to add under 'addons' but it was short and duplicative of
the 'react-without-es6' docs. So I just linked to those.

* Remove *most* `React.PropTypes` from the docs

I am doing the docs for `context` in a separate commit because that case
was a bit less clear-cut.

We will no longer support `React.PropTypes` as a built-in feature of
React, and instead should direct folks to use the `PropTypes` project
that stands alone.

Rather than retaining the `React.PropTypes` examples and just revamping
them to show the use of the stand-alone `PropTypes` library with React,
it makes more sense to direct people to that project and reduce the
perceived API area and complexity of React core. The proper place to
document `PropTypes` is in the README or docs of that project, not in
React docs.

* Update `context` docs to not use `React.PropTypes`

We use `React.PropTypes` to define the `contextType` for the `context`
feature of React. It's unclear how this will work once `React.PropTypes`
is replaced by the external `PropTypes` library. Some options;

a) Deprecate `context`, either in v16 or shortly after. Seems reasonable
based on the intense warnings against using context that we have in the
docs -
https://facebook.github.io/react/docs/context.html#why-not-to-use-context
**Except** that probably some widely used libraries depend on it, like
`React-Router`.

b) Expect users will use external `PropTypes` library when defining
`contextTypes` and just don't do our `checkReactTypeSpec` against them
any more in v16.

c) Stop masking context and pass the whole context
unmasked everywhere. Worst option, do not recommend.

I went with `b` and assume that, for now, we will get users to use the
external `PropTypes` when defining context. I will update this PR if we
want a different approach.

* Remove 'addons' items from left nav, and deprecate 'addons' doc page

The plan:
[X] Remove links to 'addons' items from main navigation
[X] Add deprecation notices where appropriate, and update syntax to show
using the separate modules.
[ ] Update other references to 'React.addons' in docs. Coming in next
commit.
--- blocked but coming in future PRs
[ ] Link to a blog post describing the new locations of add-ons in the
deprecation notice on the '/docs/addons.html' page. Blocked until we
actually publish that blog post.
[ ] Move the docs for each add-on to the actual github repo where it now
lives.
[ ] Redirect the old add-ons doc permalinks to the docs in the separate
github repos for those modules.
[ ] Remove the old add-ons doc markdown files from React core docs.

* Remove references to `React.addons` from docs

Just misc. places where we referenced the 'addons' feature. All gone!
2017-04-06 17:20:54 -07:00
Andrew Clark
e3d37fdb90 Add a document on higher-order components (#7869) 2016-11-29 10:47:54 -08:00
Kevin Lacker
809e28223e forms breakup 2016-11-08 21:38:03 +00:00
Kevin Lacker
aa9544bfac New Documentation 2016-10-21 20:59:08 +01:00
Dan Abramov
ec9d728f3d Add Implementation Notes and amend Codebase Overview (#7830)
* Add more to Codebase Overview

* WIP

* Start a reconciler overview

* Add a few more sections

* todo

* WIP

* Finish it

* Whitespace

* Minor tweaks

* Minor tweaks
2016-10-10 17:29:48 +01:00
Dan Abramov
e8f4842e87 Add Codebase Overview (#7828)
* Add Codebase Overview

* Update codebase-overview.md

* Update codebase-overview.md
2016-09-29 11:33:57 +01:00
Dan Abramov
b6ba117b7e Move How to Contribute to documentation and update it (#7817)
* Move How to Contribute to documentation and update it

* Consistent formatting
2016-09-27 23:20:49 +01:00
Dan Abramov
9176c0d597 Add Design Principles to the docs (#7282) 2016-07-14 20:37:28 +01:00
Keyan Zhang
12333ddd6f Blog post for error codes 2016-07-11 17:39:12 -07:00
Ben Alpert
649e295296 Remove Flux from docs nav (#6945)
Most people don't use the official Flux implementation or docs so I think this is likely to be more confusing than helpful. Maybe later we can add a better comparison of data management solutions.
2016-06-01 11:41:35 -07:00
Jim
eb56cc7a4a Added docs for environment integration. 2016-04-14 12:25:17 -07:00
Jim
cc287674d7 Merge pull request #6148 from jimfb/node-package-manager
Create section on using React with package managers.
2016-04-12 22:33:47 -07:00
Jim
40380fbafd Create section on using React with package managers. 2016-04-12 12:39:49 -07:00
Paul O’Shannessy
17b15ece13 [docs] Update acknowledgements for v15
(cherry picked from commit 40c0867f6319f57ebc2b810aa8caac328db14b66)
2016-04-07 15:15:44 -07:00
Joe Critchley
f67a478cd3 Added icon for external links in Docs nav and unlinked Complementary Tools and Examples in favor of this icon 2016-02-23 02:18:20 +00:00
Dan Abramov
1873b269e4 Added post about components, elements, and instances 2015-12-18 20:22:24 +00:00
Zach Ramaekers
6f8388f703 adding documentation pages for shallowCompare addon 2015-12-04 08:53:33 -06:00
Jim
029b4ad70e Added info (example+doc) about react with webcomponents 2015-11-13 20:22:24 -08:00
Christopher Chedeau
d7bbc10387 Reactiflux is moving to Discord blog post 2015-10-19 07:35:46 -07:00
Jim
46068c9fb9 Fix blog post authors 2015-10-14 18:01:33 -07:00
Ben Alpert
4dec050f5d Document context
Fixes #580.
2015-10-09 14:44:24 -07:00
Paul O’Shannessy
14785643e8 [docs] Update acknowledgements for 0.14 2015-10-07 11:25:44 -07:00
Jim
ecb1ab40a7 Merge pull request #5019 from jimfb/renderer-blog-post
Blog post for react render and top level API
2015-10-02 10:42:48 -07:00
Jim
686a4c6777 Blog post for react render and top level API 2015-10-01 14:12:01 -07:00
Jim
c426902fca Added documentation for stateless components, condensed the two pages about refs into a single page. 2015-09-30 18:54:19 -07:00
Jared Forsyth
f19060b2ea Add blog post about the new devtools beta 2015-08-03 14:55:05 -07:00
Paul O’Shannessy
9b06b8838f [docs] Give authors links. 2015-05-21 11:32:38 -07:00
mheiber
b801d5856c Update cloneWithProps documentation
Updated documentation to reflect that using React.cloneElement is the new way to copy an element and preserve `key` and `ref`.

Fixes #3432, closes #3447.
2015-04-22 17:05:59 -07:00
Reed Loden
dd010b34e2 SSL/TLSize all the things! (convert http:// to https:// where appropriate)
Update links to use https:// where it is supported. There's probably a lot
more that could be fixed, but these are the core ones I found (especially
the download links in order to prevent MITM attacks). Note that there are
some fb.me links that will redirect to http:// even while accessed over
https://, but this seemed like the best way to fix those for now.

NOTE: Only non-third-party files were modified. There are references to
http:// URLs in vendored/third-party files, but seems appropriate to fix
upstream for those rather than editing the files.

Also, copy one image locally to the blog, as it was hotlinking to a site
that did not support https://.

Last, use youtube-nocookie.com instead of youtube.com for video embeds,
as the former doesn't try to set a cookie on load (privacy enhancement).
2015-04-18 16:49:32 -07:00
Cheng Lou
db33842478 Remove mention from docs 2015-03-23 20:13:24 -04:00
Paul O’Shannessy
ccd52562eb [docs] Update acknowledgements
Missed updating this in #3283 before merging.
2015-03-10 13:57:44 -07:00
Paul O’Shannessy
07e4efd1b5 Update AUTHORS for 0.13 2015-03-10 13:55:55 -07:00
Ben Alpert
3d6af36002 Add docs for createFragment 2015-03-10 09:17:34 -07:00
Christopher Chedeau
97e8607897 Advanced Performance Doc 2015-02-11 10:53:57 -08:00
Rick Beerendonk
2e4f81f4ab Add Conferences section to the Community Resources on the website 2015-01-31 22:46:03 +01:00
Jim
7c20ccbc73 Document justification for dangerouslySetInnerHTML, fixes #2256
Conflicts:
	docs/_data/nav_tips.yml
	docs/tips/17-children-undefined.md
2015-01-21 12:47:36 -08:00
Cheng Lou
b8fafd1991 [Docs] Tip on integration with other libraries
Chose this title because it's more eye-catchy than "third-party integration".
2015-01-01 16:09:45 -05:00
Paul O’Shannessy
fce779e9a6 Update Authors & Acknowledgements for 0.12 2014-10-28 11:06:32 -07:00
Sebastian Markbage
fcaa90c5cf Update Docs Navigation 2014-10-28 11:06:31 -07:00
Paul O’Shannessy
a0a4b58af4 [docs] Glossary
Pulled in https://gist.github.com/sebmarkbage/fcb1b6ab493b0c77d589
mostly verbatim
2014-10-23 20:51:11 -07:00
Paul O’Shannessy
3a0babddc9 Point to Flux site for Flux docs
This doesn't actually remove the pages, just the main content. Sidebar
items now link offsite. The pages doesn't automatically redirect, but we
could do that if we really wanted.

Fixes #2229
2014-09-25 12:34:22 -07:00
Paul O’Shannessy
5706d4c4f1 Autogenerate acknowledgements 2014-08-13 12:38:09 -07:00
Jed Watson
dcb1b1de11 Updating "Tutorial" label as per suggestion 2014-07-29 12:20:15 +10:00
Jed Watson
854133c240 Adding "Tutorial" label to Flux Todo List nav item 2014-07-29 10:54:22 +10:00
Cheng Lou
5e161764ca [Docs] Perf tools
Fixes #1814.
@petehunt @joshduck
The images look blurry (taken on retina then shrank down to 50%...)
2014-07-15 11:17:21 -07:00
Cheng Lou
581877e346 [Docs] Document PureRenderMixin addon
Fixes #1816
2014-07-12 14:56:43 -07:00
Vjeux
35db119584 Flux blog post and tutorial 2014-05-09 01:22:47 +02:00
Cheng Lou
5bc8b15d63 [Docs][Tips] Entry on this.props.children and tweak component ref entry
Component ref entry wasn't registered in nav_tips.
2014-03-31 19:13:16 -07:00