From f89c983da52dff360016c972784a01ef518ea4c6 Mon Sep 17 00:00:00 2001 From: Kevin Heis Date: Thu, 3 Dec 2020 08:39:21 -0800 Subject: [PATCH] Update README.md --- react/README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/react/README.md b/react/README.md index b67639f70e5f..deeeaf686ca9 100644 --- a/react/README.md +++ b/react/README.md @@ -1,6 +1,6 @@ # React (Experimental) -The files in this directory are react components that can be then be used within markdown files by adding `interactive: true` frontmatter to a markdown file and then using the following syntax to embed the component: +The files in this directory are React components. We can use these components within Markdown files by adding `interactive: true` frontmatter to a Markdown file. Then, using the following syntax to embed the component: ``` @@ -12,13 +12,12 @@ Theoretically React can be embedded anywhere on the site with a little bit of cr ## Defining new components - -Start by adding frontmatter `interactive:true` to any markdown file that you want to support react (this prevents react render time from slowing down any other page and keeping the impact on performance very low) +Start by adding frontmatter `interactive:true` to any Markdown file that you want to support React. This prevents React render time from slowing down any other page and keeping the impact on performance very low. 1. Create the component in the `./react` directory 2. Register the component for webpack in `./javascripts/index.js` so the component works with client side rendering 3. Register the component in `./lib/react-engine.js` so the component works with server side rendering -4. If the component needs to be evaluated client side, see [this example](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/react/CodeEditor.js) for how to ensure the client side component rendered by the server gets [Hyrdated](https://reactjs.org/docs/react-dom.html#hydrate). +4. If the component needs to be evaluated client side, see [this example](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/react/CodeEditor.js) for how to ensure the client side component rendered by the server gets [Hydrated](https://reactjs.org/docs/react-dom.html#hydrate). ## A Complete Example @@ -31,10 +30,9 @@ The following example demonstrates the addition of an interactive CodeEditor on - [Enabling React components on a page](https://github.com/github/docs/blame/a48998c7890b71c8f58eda1fa31b50df348a0042/content/github/getting-started-with-github/access-permissions-on-github.md#L12) - [Adding the CodeEditor to a page](https://github.com/github/docs/blame/a48998c7890b71c8f58eda1fa31b50df348a0042/content/github/getting-started-with-github/access-permissions-on-github.md#L47) - ## Gotchas -- When requiring react components from npm you will often need to explicitly call require('component').default to make sure you get the component +- When requiring React components from npm you will often need to explicitly call `require('component').default` to make sure you get the component - Some code examples you get from external React packages won't work out of the box, you often need to dig into the module and determine whether it's exporting to default or not which will in many cases cause you to need to `require('package').default` - `import` doesn't always work. Use `require` for a more consistent experience with React in this codebase. - If components require you to load CSS, you need to load that CSS in the `javascripts/index.js` file as shown [here](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/javascripts/index.js#L22)