Commit Graph

1552 Commits

Author SHA1 Message Date
Dominic Gannaway
76b625ba80 Fixes example in Web Components docs (#11039)
* fixes docs on webcomponent

* Update web-components.md
2017-10-04 17:12:36 +01:00
Ricky Reusser
11bd6395e1 Remove bundle-collapser browserify recommendation (#11051)
* Move bundle-collapser browserify plugin recommendation to a note.

* Remove bundle-collapser note entirely
2017-10-03 00:17:49 +01:00
Brian Vaughn
d2b10ee4e8 Refactored Installation page to no longer use tabs (#11050) 2017-10-02 15:45:48 -07:00
Vicky Chijwani
f8dceef015 Docs: add link to DOM Level 3 spec for possible values of key prop (#11042) 2017-10-02 23:13:23 +01:00
Cole Turner
d9415384b2 Clarify implementation of tick() in Lifecycle docs (#11002)
This documentation change clarifies how the method `tick()` relates to the example given in the State and Lifecycle documentation. Why this change is necessary is because it may be confusing for beginners who may mistake `tick()` to be a lifecycle API hook.  To clarify, the verbiage is changed so that it becomes more clear that the method is specific to the component and not the API.
2017-10-02 09:37:05 -07:00
John Darryl Pelingo
9b22e92677 Combine rendered Note section (#11026) 2017-10-02 13:47:40 +01:00
Goffert van Gool
358674714c Update web-component docs to current standard (#11020)
The documentation example for Web Components uses deprecated Custom Element and Shadow DOM APIs [0]. This change updates the example to the v1 APIs, which are the current standard.

[0] https://developers.google.com/web/fundamentals/web-components/customelements#historysupport
2017-10-02 11:44:57 +01:00
Josh Hawkins
f39926bcb8 Improve docs for select multiple (#9539)
* Readd original select multiple note

* Update forms.md
2017-10-02 00:18:08 +01:00
Greg Myers
7379be383d Update Reference-readme to remove React.DOM (#10999)
`React.DOM` is now Undefined in React 16 so `React.DOM.div` or `React.DOM.button` are no longer possible.
2017-10-01 11:53:00 +01:00
Jason O'Neil
6fdc75b3fe Fix createPortal link in API docs (#11000)
The anchor name is lower case
2017-10-01 11:52:22 +01:00
Dan Abramov
794dc48b14 Fix HTML file download link 2017-09-30 21:10:01 +01:00
Dave Garwacke
21c7bf533f chore(docs) Remove extra style tag curly braces (#10973)
Removed an extra quoted set of curly braces..
2017-09-30 08:11:55 -07:00
Joe Critchley
bb00e4d72e [Gatsby] Installation tabs design (#10989) 2017-09-30 07:53:08 -07:00
Eugene Zhlobo
7cd84f6825 Fix anchor links in reference-react documentation (#10975) 2017-09-29 18:44:45 -07:00
skratchdot
9e27f704d7 [Gatsby] "https://facebook.github.io/react/" -> "https://reactjs.org/" (#10970) 2017-09-29 18:43:22 -07:00
Dan Abramov
0911de6a31 Fix note formatting (#10966) 2017-09-29 18:37:35 +01:00
Joshua
e464c07e7f Use ES6 module instead of commonJS (#10953)
* Use ES6 module instead of commonJS

As far as I know, we're using ES6 modules throughout the docs. For the sake of consistency :)

* Convert all CommonJS requires to ES6 module
2017-09-29 12:24:10 +01:00
Dan Abramov
1459bf4e11 Tweaks to "Introducing JSX" (#10944)
* Tweaks to "Introducing JSX"

* Update introducing-jsx.md

* Update introducing-jsx.md

* Update introducing-jsx.md
2017-09-29 00:32:25 +01:00
Flarnie Marchan
fb2f44e86f [website] a11y fixes (#10927)
* [Gatsby docs a11y] Add `aria-label` to search input

**what is the change?:**
See title.

**why make this change?:**
There was no label on this input, and screen readers might not have been
able to identify it's purpose.
[The `placeholder` doesn't count as a label.](http://a11yproject.com/posts/placeholder-input-elements/)

**test plan:**
Manually inspected the HTML in the devtools, and ran the aXe a11y audit
tool, and the warning generated by aXe was gone.

**issue:**
Checklist item on list of docs a11y issues -
https://github.com/bvaughn/react/wiki/Gatsby-A11y-Fixes

* [Gatsby Docs a11y] Increase contrast of 'installation' page tabs

**what is the change?:**
Change the dark blue used for the text/background of the tabs on the
'installation' page to a slightly darker blue, which we were already
using for the 'focus' style of the tabs. It looked a bit weird before,
imo, when the 'focus' was darker.

Now the 'focus' style just lightens the border to the new signature
blue.

**why make this change?:**

To add enough contrast that folks who see colors differently can still
decipher the writing on the tabs on this page.

We plan to refactor this page and remove the tabs soon, so not too
worried about making this fix perfect.

**test plan:**
Manual testing - loaded the page and it looks ok, and ran aXe a11y
audit, no more warnings about contrast. :)

(Flarnie will insert a screenshot)

**issue:**
checklist item on https://github.com/bvaughn/react/wiki/Gatsby-A11y-Fixes
2017-09-28 13:57:34 -07:00
Brian Vaughn
52b694eaae Add new docs website (#10896)
Adds a new docs website, built with Gatsby JS, to replace the old Jekyll site. Source code for the new site lives in /www (although markdown and YML data still comes from the legacy /docs folder).

Changes to either markdown or website source code can be previewed on Netlify. The react-js bot should automatically add comments to each PR with preview links. (This preview is generated by running the newly-added yarn build:docs command in the root package.json.)

The majority of the changes in this PR are contained within the new /www directory. However some minor modifications have been made to existing content in the /docs directory:

* Modified frontmatter author block to always be an array
* Small markdown formatting tweaks
2017-09-28 10:18:04 -07:00
Spencer Miskoviak
6b9d05de8d Remove apostrophe (#10807)
* Remove apostrophe

* Update printInclusive default documentation
2017-09-27 23:05:52 +01:00
Ivan Babak
7f2cd20190 Fix fragments docs example JSX typo (#10885)
Fixes https://github.com/facebook/react/issues/10883
2017-09-27 19:28:04 +01:00
Cody Wall
75dda2768a Minor update to portals docs "child" language (#10870)
* Update portals docs "child" language

This commit changes the portals docs so that the language of the Parent
no longer feels like it is missing a word with "is not a child the div
with onClick handler" and replaces that with "is not a direct child of
the div with the onClick handler".

closes #10868

* Update portals.md
2017-09-27 17:04:11 +01:00
Toru Kobayashi
7fe2d448a6 Add a note about deprecating react-addons-perf (#10743)
* Add a note about deprecating react-addons-perf

* Update addons-perf.md
2017-09-27 11:12:39 +01:00
Dan Abramov
5e782cd6f9 Minor doc edit 2017-09-26 22:23:20 +01:00
Dan Abramov
79e27af02b Update docs for React 16 (#10846) 2017-09-26 22:12:40 +01:00
Andrew Clark
078f8d15e5 Fix portal link (#10845) 2017-09-26 21:26:38 +01:00
Karl Horky
308d16bf55 Update name of property initializer proposal (#10812)
The proposal for property initializers is called [Public Class Fields](https://tc39.github.io/proposal-class-public-fields/) now (part of the combined [Class Fields](https://github.com/tc39/proposal-class-fields) proposal).
2017-09-26 19:48:23 +01:00
Samuel
0c3e4d00ff Update Portals Documentation (#10840)
* Update Portals Documentation

Correct some grammar to be more explicit and clear. Update example CodePen to better match code found in documentation. Update code example styles to match other code examples (ie. 'State and Lifecycle', 'Handling Events').

* Clean up comment to be accurate to example

There was a small comment overlooked when reviewing the documentation. This fixes it to be accurate to the example as well as grammatically correct.

* Update portals.md

* More fixes
2017-09-26 19:45:48 +01:00
Kaylee Knowles
9bb67835da React.createPortal is not a function (#10843) 2017-09-26 19:41:30 +01:00
Dan Abramov
60ba86b31a Fix note formatting 2017-09-26 19:01:38 +01:00
Samuel Reed
ffa102d71a Doc change for prevContext removal in CDU (#10836)
* Doc change for prevContext removal in CDU

Ref: https://github.com/facebook/react/issues/8631

* Minor rewording
2017-09-26 18:29:35 +01:00
Dan Abramov
0e87a042a8 Fix React links on the website (#10837)
* Fix React links on the website

* Fix code editor

* Fix code editor, attempt 2
2017-09-26 18:20:41 +01:00
Andrew Clark
0e43ef2682 Doc updates for React 16 + blog post (#10824)
* Doc updates for React 16 + blog post

* Add link to Sophie's post
2017-09-26 09:04:14 -07:00
Toru Kobayashi
55b1848c3e Add ReactTestRenderer documentations (#10692)
* Add ReactTestRenderer documentations

* Add TestRenderer documentations

* TestRenderer is not experiment

* Add a link for jsdom

* Use ES Modules syntax

* Twaek

* Add a Link component

* Use Jest assertions

* Move a documentation for createNodeMock to Idea section

* Renamed

* Tweak

* Rename

* More explicit

* Add a usecase for createNodeMock
2017-09-26 00:30:56 -07:00
Anuja Ware
037ae1b2cc Small typo fixed (#10701) 2017-09-14 14:39:17 -07:00
Brian Emil Hartz
888a12b85d More explicit class method for ref doc (#10228)
After realizing this was the second time I've visited this exact page within a year and second guessing myself that the `textInput` ref isn't actually the `<input />` element. I decided to attempt to make this a little more explicit; you are actually accessing the method on the child class and not the `focus` method on the dom input element. Having them named the same caused some confusion.
2017-09-10 14:48:39 -07:00
zhangs
ef2547a4cb the order of withRouter and connect is reset (#10658)
per [this link](https://github.com/ReactTraining/react-router/blob/master/packages/react-router/docs/api/withRouter.md) becasue ` If you are using withRouter to prevent updates from being blocked by shouldComponentUpdate, it is important that withRouter wraps the component that implements shouldComponentUpdate. `
2017-09-10 12:56:22 -07:00
Héliton Nordt
2fc474ef46 Improve displayName documentation (#10451)
* Improve displayName documentation

* displayName docs: higher-order component lowercased to stay consistent with the rest of the docs

* Rephrase displayName reference docs
2017-09-08 16:45:25 -07:00
David Beitey
a029d91c68 Fix minor typo in Firefox name (#10605) 2017-09-05 10:28:54 -07:00
Tyler Deitz
5b83555b6c Update reference-events.md (#10554) 2017-08-29 08:11:45 -07:00
Brian Vaughn
fdcbf35abf Added "Advanced Guides" page about cross-origin Errros (#10457) 2017-08-14 13:43:24 -07:00
Sasha Aickin
87f1cec913 Fix for #10388. Renames renderToStream to renderToNodeStream. (#10425) 2017-08-10 12:23:00 -07:00
Ben Alpert
f50dbe8d96 Update installation.md 2017-08-04 17:10:50 -07:00
Dan Abramov
427f4961a8 Add documentation about <script crossorigin> for React CDN usage (#10368) 2017-08-03 16:13:13 +01:00
Dan Abramov
839d701840 Tweak deprecation messages to be less scary (#10145) 2017-07-11 14:05:27 +01:00
Nick Kasten
eaab6aff60 Updated Immutable Data Stuctures Docs (#9845)
* updated immutable data structures section

* improved immutable clarifications

* changes to example immutable code
2017-07-05 19:08:43 -05:00
Guilherme Ruiz
1b4a714e0f Fix the data-height of Step 5 CodePen embed (#10083) 2017-07-03 21:05:35 -04:00
Almero Steyn
e5180717e8 docs(a11y): Small fixes (#10079) 2017-06-30 07:39:46 -04:00
Almero Steyn
e95b65d685 [Docs: A11y] Add accessibility docs (#9519)
* [Docs: A11y] Add accessibility docs

* Fix the link

* Replace link image

* Tweak style
2017-06-26 18:17:05 +01:00