Nanometer Process Machine

    @saleor/app-bridge
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.10 • Public • Published

    Saleor App Bridge

    Installation

    npm i @saleor/app-bridge

    Usage

    First initialize the package by running createApp():

    import { createApp } from "@saleor/app-bridge";
    
    const app = createApp();

    Access app state:

    const { token, domain, ready, id } = app.getState();

    Events

    Events are messages that originate in Saleor Dashboard.

    Available methods

    subscribe(eventType, callback) - can be used to listen to particular event type. It returns an unsubscribe function, which unregisters the callback.

    Example:

    const unsubscribe = app.subscribe("handshake", (payload) => {
      setToken(payload.token); // do something with event payload
      const { token } = app.getState(); // you can also get app's current state here
    });
    
    // unsubscribe when callback is no longer needed
    unsubscribe();

    unsubscribeAll(eventType?) - unregisters all callbacks of provided type. If no type was provided, it will remove all event callbacks.

    Example:

    app.unsubscribeAll("handshake"); // unsubscribe from all handshake events
    
    app.unsubscribeAll(); // unsubscribe from all events

    Available event types

    Event type Description
    handshake Fired when iFrame containing the App is initialized or new token is assigned
    response Fired when Dashboard responds to an Action
    redirect Fired when Dashboard change a subpath within the app path
    theme Fired when Dashboard change the theme

    Actions

    Actions expose a high-level API to communicate with Saleor Dashboard. They're exported under an actions namespace.

    Available methods

    dispatch(action) - dispatches an Action. Returns a promise which resolves when action is successfully completed.

    Example:

    import { actions } from "@saleor/app-bridge";
    
    const handleRedirect = async () => {
      await app.dispatch(actions.Redirect({ to: "/orders" }));
      console.log("Redirect complete!");
    };
    
    handleRedirect();

    Available actions

    Action Arguments Description
    Redirect to (string) - relative (inside Dashboard) or absolute URL path
    newContext (boolean) - should open in a new browsing context

    Install

    npm i @saleor/app-bridge

    Homepage

    saleor.io/

    DownloadsWeekly Downloads

    883

    Version

    0.1.10

    License

    MIT

    Unpacked Size

    77.4 kB

    Total Files

    24

    Last publish

    Collaborators

    • magul
    • 2can
    • mmiszy
    • lkostrowski
    • zaiste
    • taniotanio7
    • dominik-zeglen
    • maarcingebala
    • krzyh
    • patrys