@wazapp/component

Search…

Introduction

Packages

@wazapp/core

@wazapp/component

Component package expose Wazapp Component which is built on top of React Component. It integrates tracking, app owner (allows to use services) and simplify component API.
Warning!
Hence the component extends from React Component, do not use any of its API. It may be removed in the future and using it may cause incompatibility with Wazapp components!
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  template({ name }) {
5
    return (
6
      <h1>Hello, {name}</h1>
7
    );
8
  }
9
}
Copied!
Class Component
props
props exactly like in React Component returns an Object of passed properties to the component. They are automatically tracked by Wazapp.
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  template({ name }) {
5
    return (
6
      <h1>My name is {name}</h1>
7
    );
8
  }
9
}
10
​
11
export default class MainComponent extends ClassComponent {
12
  template() {
13
    return (
14
      <MyComponent name="Wazapp" />
15
    );
16
  }
17
}
Copied!
isUnmounting
A boolean flag to tell if the component is in the process of unmounting. This is set to true before willUnmount is called.
isUnmounted
A boolean to tell if the component has been fully unmounted. This is set to true after willUnmount is called.
template(props: P, context: this): ReactNode | void
template(props) allows you to define your component template written in JSX. Remember that you are still working in React so things like className instead of class are still required.
The template can return ReactNode or nothing. By default if not defined it will yield() component's children.
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  template({ name }) {
5
    return (
6
      <h1>Hello {name}, this is Wazapp component</h1>
7
    );
8
  }
9
}
Copied!
yield(...args)
yield() allows you to return component's children or in case the children is a function, it will allow you to call it with custom arguments.
Arguments
...args: any[] - your custom arguments that will be used on children call (if children is a function)
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  template() {
5
    return (
6
      <h1>Hello, {this.yield('Wazapp')}</h1>
7
    );
8
  }
9
}
10
​
11
export default class MainComponent extends ClassComponent {
12
  template() {
13
    return (
14
      <MyComponent>
15
        {(name) => (
16
          <h1>{name}</h1>
17
        )}
18
      </MyComponent>
19
    );
20
  }
21
}
Copied!
didMount()
didMount is invoked immediately after a component is mounted (inserted into the tree). Initialization that requires DOM nodes should go here.
This method is a good place to set up any subscriptions. If you do that, don’t forget to unsubscribe in willUnmount().
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  didMount() {
5
    console.log('Component has been mounted')
6
  }
7
}
Copied!
didUpdate(prevProps)
didUpdate is invoked immediately after updating occurs. This method is not called for the initial render.
Use this as an opportunity to operate on the DOM when the component has been updated.
Arguments
prevProps: T<ComponentProps> - previous component properties
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  didUpdate(prevProps) {
5
    console.log(prevProps.name, this.props.name)
6
  }
7
}
Copied!
willUnmount()
willUnmount is invoked immediately before a component is unmounted and destroyed. Perform any necessary cleanup in this method, such as invalidating timers, canceling network requests, or cleaning up any subscriptions that were created in didMount().
Example of usage
1
import { ClassComponent } from "@wazapp/component";
2
​
3
export default class MyComponent extends ClassComponent {
4
  willUnmount() {
5
    console.log('Component has been unmounted`)
6
  }
7
}
Copied!