|
| 1 | +# React (Experimental) |
| 2 | + |
| 3 | +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: |
| 4 | + |
| 5 | +``` |
| 6 | +<!--react--> |
| 7 | +<ReactComponentHere some='prop' other={`prop`} /> |
| 8 | +<!--end-react--> |
| 9 | +``` |
| 10 | + |
| 11 | +Theoretically React can be embedded anywhere on the site with a little bit of creativity but that is yet to be tested. |
| 12 | + |
| 13 | +## Defining new components |
| 14 | + |
| 15 | + |
| 16 | +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) |
| 17 | + |
| 18 | +1. Create the component in the `./react` directory |
| 19 | +2. Register the component for webpack in `./javascripts/index.js` so the component works with client side rendering |
| 20 | +3. Register the component in `./lib/react-engine.js` so the component works with server side rendering |
| 21 | +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). |
| 22 | + |
| 23 | +## A Complete Example |
| 24 | + |
| 25 | +The following example demonstrates the addition of an interactive CodeEditor on one of our pages: |
| 26 | + |
| 27 | +- [Defining the CodeEditor React Component](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/react/CodeEditor.js) |
| 28 | +- [Configuring the CodeEditor for client-side rendering](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/javascripts/index.js#L45) |
| 29 | +- [Configuring the CodeEditor for server-side rendering](https://github.com/github/docs/blob/a48998c7890b71c8f58eda1fa31b50df348a0042/lib/react/engine.js#L30) |
| 30 | +- CodeEditor added to a markdown file |
| 31 | + - [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) |
| 32 | + - [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) |
| 33 | + |
| 34 | + |
| 35 | +## Gotchas |
| 36 | + |
| 37 | +- When requiring react components from npm you will often need to explicitly call require('component').default to make sure you get the component |
| 38 | +- 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` |
| 39 | +- `import` doesn't always work. Use `require` for a more consistent experience with React in this codebase. |
| 40 | +- 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) |
0 commit comments