lifeycle.on_update_props()

Immediately after a component receives new props, if present, the on_update_props() method for the component will be called.

Example Usage

import joystick from '@joystick.js/ui';

const Index = joystick.component({
  lifecycle: {
    on_update_props: (existing_props = {}, new_props = {}, instance = {}) => {
      // Handle the on_update_props() event.
    },
  },
  render: ({ state, when }) => {
    return `
      <div>...</div>
    `;
  },
});

export default Index;

API

Definition

on_update_props(existing_props: object, new_props: object, component_instance: object) => undefined

Parameters

existing_props object required

The component's props before the update.

new_props object required

The component's props after the update.

component_instance object required

The current component instance.