React components: Difference between revisions

From wikinotes
 
(19 intermediate revisions by the same user not shown)
Line 102: Line 102:


<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
this.setState()
this.setState({ collapsed: false }) // good: update state
this.state = { collapsed: false }  // bad:
</syntaxhighlight>
</syntaxhighlight>
</blockquote><!-- Element Variables -->
</blockquote><!-- Element Variables -->
</blockquote><!-- Attributes -->
</blockquote><!-- Attributes -->


= Return Types =
= Render Types =
<blockquote>
<blockquote>
== Elements ==
== Elements ==
Line 114: Line 115:


<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
function Person extends React.Component {
class Person extends React.Component {
     render() {
     render() {
         return (
         return (
Line 129: Line 130:
== Lists ==
== Lists ==
<blockquote>
<blockquote>
You may return a list of elements to some compound types, like lists.<br>
You may render() a list of elements to some compound types, like lists.<br>
Each item requires a <code>key</code>.
Each item requires a unique <code>key</code> so react can keep track of CRUD operations with list items.


<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">


class ListItems extends React.Component {
    render() {
        var items = [
          {key: "a", text: "aaa"},
          {key: "b", text: "bbb"},
          {key: "c", text: "ccc"},
        ]
        return items.map((x) =>
          <li key={x.key}> // key={foo} lets react update changes
            {x.text}
          </li>
        );
    }
}
class MyList extends React.Component {
    render() {
        return (
            <ul>
            <ListItems />
            </ul>
    }
}
</syntaxhighlight>
</syntaxhighlight>
</blockquote><!-- Lists -->
</blockquote><!-- Lists -->
Line 139: Line 163:
== Fragments ==
== Fragments ==
<blockquote>
<blockquote>
Fragments are a special wrapper type that allows you to return multiple top-level html-elements in one clump.
Fragments are a special wrapper type that allows you to return multiple top-level html-elements in one clump.<br>
They do not need to be a homogenous collection of top-level elements.


You can use either of the following tags:
You can use either of the following tags:
Line 167: Line 192:
</syntaxhighlight>
</syntaxhighlight>
</blockquote><!-- Fragments -->
</blockquote><!-- Fragments -->
</blockquote><!-- Return Types -->


= Lifecycle Methods =
== Null (force no render) ==
<blockquote>
<blockquote>
React components have methods to ''mount/unmount'' behaviours when the object is first created or destroyed.<br>
If a component's <code>render()</code> returns <code>null</code>,<br>
These can set/unset timers to auto-update the object.
then it won't render anything, even if it is included in a page.


Check out the [https://reactjs.org/docs/state-and-lifecycle.html tutorial].
The official-docs use a debug-info as an example (you'd only want to render if in development environment).


{{ TODO |
<syntaxhighlight lang="javascript">
Why can't the constructor/destructor be used? }}
class DebugInfo extends React.Component {
    constructor(props) {
        super(props);
        this.state = {debugEnabled: true};
    }


<source lang="javascript">
    render() {
class Foo extends React.Component {
        this.debugEnabled
  componentDidMount() { ... }
          ? <p>debug info...</p>
  componentWillUnmount() { ... }
          : null;
    }
}
}
</source>
</syntaxhighlight>
</blockquote><!-- Lifecycle Methods -->
</blockquote><!-- Null (force no render) -->
</blockquote><!-- Return Types -->


= DOM Events =
= Lifecycle Methods =
<blockquote>
<blockquote>
You can subscribe to DOM events with callbacks similarly to [[javascript]].<br>
{{ NOTE |
except that events are in camelcase <br>
An alternative to lifecycle methods is [[react hooks]]. }}
and callbacks are defined as methods rather than strings.


See https://reactjs.org/docs/handling-events.html
React components have methods to ''mount/unmount'' behaviours when the object is first created or destroyed.<br>
These can set/unset timers to auto-update the object.<br>
These behave similarly to constructor/destructor as hooks, except their events correspond with adding/removing them from the DOM.
 
Check out the [https://reactjs.org/docs/state-and-lifecycle.html tutorial] (might need to scroll to methods).


<source lang="javascript">
<source lang="javascript">
class HelloWorld extends React.Component {
class Foo extends React.Component {
   sayHello() {
   componentDidMount() { ... }      // runs after first 'render()'
    console.log('hello')
   componentWillUnmount() { ... }   // runs if object is removed from the DOM
   }
 
  render() {
    return (
      <button onClick={() => this.sayHello()}>
        Say Hello
      </button>
    );
  }
}
}
</source>
</source>
</blockquote><!-- DOM Events -->
</blockquote><!-- Lifecycle Methods -->

Latest revision as of 01:57, 11 December 2022

Documentation

component docs https://reactjs.org/docs/react-component.html
fragment docs https://reactjs.org/docs/fragments.html
list docs
portal docs https://reactjs.org/docs/portals.html

Components

Component Functions

function Description() {
    return (
        <h1>Description</h1>
        <p>{this.props.paragraph}</p>
    )
}
<Description paragraph="a very long..." />

Component Classes

class Employee extends React.Component {
  constructor(props) {
    super(props);
    this.state = {name: props.name, id: props.id}
  }

  render() {
    return (
      <div>
        <h1>Name: {this.state.name}</h1>
        <h2>ID: {this.state.id}</h2>
      </div>
    );
  }
}
<Employee name="vaderd" id="101" />

Attributes

this.props

Parameters are passed parameters using xml tag attributes.
Within the component, they are axposed as attributes on the this.props variable.

ReactDOM.render(
    <Description name="Alex" />,         // <-- use component
    document.getElementById('root')
);
function Description() {
    return <p>hello, {this.props.name}</p>;  // <-- access props in component
}

this.state

this.state is a special object property to store UI related info.
The component will be re-rendered every time the this.setState() is called.

class Thing extends React.Component {
    constructor(props) {
        super(props);
        this.state = { collapsed: false };
    }

    render() {
        if (this.state.collapsed) {
            <p>collapsed</p>
        } else {
            <p>expanded</p>
        }
    }
}
this.setState({ collapsed: false }) // good: update state
this.state = { collapsed: false }   // bad:

Render Types

Elements

Generally, React requires that a single top-level html-element is returned by each component.

class Person extends React.Component {
    render() {
        return (
            <table>
                <tr><th>...</th></tr>
                <tr><th>...</th></tr>
            </table>
        );
    }
}

Lists

You may render() a list of elements to some compound types, like lists.
Each item requires a unique key so react can keep track of CRUD operations with list items.

class ListItems extends React.Component {
    render() {
        var items = [
          {key: "a", text: "aaa"},
          {key: "b", text: "bbb"},
          {key: "c", text: "ccc"},
        ]
        return items.map((x) =>
          <li key={x.key}> // key={foo} lets react update changes
            {x.text}
          </li>
        );
    }
}

class MyList extends React.Component {
    render() {
        return (
            <ul>
            <ListItems />
            </ul>
    }
}

Fragments

Fragments are a special wrapper type that allows you to return multiple top-level html-elements in one clump.
They do not need to be a homogenous collection of top-level elements.

You can use either of the following tags:

  • <React.Fragment>...</React.Fragment>
  • <>...</>
<table>
  <tr>
    <Columns />  // <-- fragment with several items
  </tr>
</table>
import React from 'react';

function Columns(props) {
    return (
        <React.Fragment>
          <td>foo</td>
          <td>bar</td>
          <td>baz</td>
        </React.Fragment>
    );
}

Null (force no render)

If a component's render() returns null,
then it won't render anything, even if it is included in a page.

The official-docs use a debug-info as an example (you'd only want to render if in development environment).

class DebugInfo extends React.Component {
    constructor(props) {
        super(props);
        this.state = {debugEnabled: true};
    }

    render() {
        this.debugEnabled
          ? <p>debug info...</p>
          : null;
    }
}

Lifecycle Methods

NOTE:

An alternative to lifecycle methods is react hooks.

React components have methods to mount/unmount behaviours when the object is first created or destroyed.
These can set/unset timers to auto-update the object.
These behave similarly to constructor/destructor as hooks, except their events correspond with adding/removing them from the DOM.

Check out the tutorial (might need to scroll to methods).

class Foo extends React.Component {
  componentDidMount() { ... }      // runs after first 'render()'
  componentWillUnmount() { ... }   // runs if object is removed from the DOM
}