Back to Nocobase

Register FlowModel

docs/docs/en/flow-engine/register-flow-model.md

2.1.01.0 KB
Original Source

Register FlowModel

Start with a custom FlowModel

tsx
class HelloModel extends FlowModel {
  render() {
    return (
      <div>
        <h1>Hello, NocoBase!</h1>
        <p>This is a simple block rendered by HelloModel.</p>
      </div>
    );
  }
}
tsx

Available FlowModel base classes

Base Class NameDescription
BlockModelBase class for all blocks
CollectionBlockModelCollection block, inherits from BlockModel
ActionModelBase class for all actions

Register FlowModel

ts
export class PluginHelloClient extends Plugin {
  async load() {
    this.engine.registerModelLoaders({
      HelloModel: {
        // Dynamic import: the model module loads only when this model is first needed
        loader: () => import('./HelloModel'),
      },
    });
  }
}