0.0.61 • Published 12 months ago

openblocks-sdk-workmeet v0.0.61

Weekly downloads
-
License
MIT
Repository
-
Last release
12 months ago

openblocks-sdk-workmeet

Usage

yarn:

yarn add openblocks-sdk-workmeet

npm:

npm install openblocks-sdk-workmeet

Integrate Openblocks' app/module into existing app page

  1. Publish your app/module in Openblocks.
  2. Set the app/module's access privilege as public.
  3. Add code in your existing app as below.

Import style

import "openblocks-sdk-workmeet/dist/style.css";

For react app:

import { OpenblocksAppView } from "openblocks-sdk-workmeet";

<OpenblocksAppView appId="{YOUR_APPLICATION_ID}" />;

OpenblocksViewProps

NameTypeDescriptionDefault value
appIdstringThe app's id in Openblocks. Required!--
baseUrlstringOpenblocks' api base urlhttps://api.openblocks.dev
onModuleEventTriggered(eventName: string) => voidTriggered when module's custom event is triggered. Works only when the app is a module.--
onModuleOutputChange(output: any) => voidTriggered when module's outputs change. Works only when the app is a module.--

Invoke module methods

import { useRef } from "ref";
import { OpenblocksAppView } from "openblocks-sdk-workmeet";

function MyExistingAppPage() {
  const appRef = useRef();
  return (
    <div>
      <OpenblocksAppView appId={YOUR_APPLICATION_ID} ref={appRef} />;
      <button onClick={() => appRef.current?.invokeMethod("some-method-name")}>
        Invoke method
      </button>
    </div>
  );
}

For vanilla js:

import { bootstrapAppAt } from "openblocks-sdk-workmeet";

const node = document.querySelector("#my-app");

async function bootstrap() {
  const instance = await bootstrapAppAt(YOUR_APPLICATION_ID, node);

  // set module inputs
  instance.setModuleInputs({ input1: "xxx", input2: "xxx" });

  // invoke module methods
  instance.setModuleInputs({ input1: "xxx", input2: "xxx" });

  // listen module event trigger
  instance.on("moduleEventTriggered", (eventName) => {
    console.info("event triggered:", eventName);
  });

  // listen module output change
  instance.on("moduleOutputChange", (data) => {
    console.info("output data:", data);
  });
}
0.0.60

12 months ago

0.0.61

12 months ago

0.0.59

12 months ago

0.0.52

12 months ago

0.0.53

12 months ago

0.0.54

12 months ago

0.0.55

12 months ago

0.0.56

12 months ago

0.0.57

12 months ago

0.0.58

12 months ago

0.0.51

12 months ago

0.0.42

1 year ago

0.0.43

1 year ago

0.0.44

1 year ago

0.0.45

1 year ago

0.0.46

1 year ago

0.0.47

1 year ago

0.0.50

12 months ago

0.0.48

1 year ago

0.0.41

1 year ago

0.0.40-b

1 year ago

0.0.40-a

1 year ago

0.0.40

1 year ago

0.0.39-a

1 year ago

0.0.39

1 year ago

0.0.38

1 year ago

0.0.34

1 year ago

0.0.30

1 year ago