UNPKG

@shopify/app-bridge-host

Version:

App Bridge Host contains middleware and components that are meant to be consumed by the app's host. The middleware and `Frame` component are responsible for facilitating messages posted between the client and host, and used to act on actions sent from the

86 lines (85 loc) 3.64 kB
"use strict"; var __extends = (this && this.__extends) || (function () { var extendStatics = function (d, b) { extendStatics = Object.setPrototypeOf || ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) || function (d, b) { for (var p in b) if (b.hasOwnProperty(p)) d[p] = b[p]; }; return extendStatics(d, b); }; return function (d, b) { extendStatics(d, b); function __() { this.constructor = d; } d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __()); }; })(); var __assign = (this && this.__assign) || function () { __assign = Object.assign || function(t) { for (var s, i = 1, n = arguments.length; i < n; i++) { s = arguments[i]; for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p]; } return t; }; return __assign.apply(this, arguments); }; var __rest = (this && this.__rest) || function (s, e) { var t = {}; for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0) t[p] = s[p]; if (s != null && typeof Object.getOwnPropertySymbols === "function") for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) if (e.indexOf(p[i]) < 0) t[p[i]] = s[p[i]]; return t; }; var __importDefault = (this && this.__importDefault) || function (mod) { return (mod && mod.__esModule) ? mod : { "default": mod }; }; Object.defineProperty(exports, "__esModule", { value: true }); var react_1 = __importDefault(require("react")); var app_bridge_1 = require("@shopify/app-bridge"); /** * Renders an iframe and sets up a `MessageTransport` between * the iframe and the parent window * @public * @remarks The iframe is never updated to prevent duplicated browser history entries * When a new url is received the `onUrlChange` is called with the iframe and the new url * */ var Frame = /** @class */ (function (_super) { __extends(Frame, _super); function Frame() { return _super !== null && _super.apply(this, arguments) || this; } Frame.prototype.shouldComponentUpdate = function () { return false; }; Frame.prototype.componentDidMount = function () { var _a = this.props, context = _a.context, url = _a.url; var frameOrigin = new URL(url).origin; if (this.iframe) { var transport = app_bridge_1.fromFrame(this.iframe, frameOrigin, context); this.detach = this.props.app.attach(transport); } }; Frame.prototype.componentWillUnmount = function () { if (this.detach) { this.detach(); } }; Frame.prototype.UNSAFE_componentWillReceiveProps = function (nextProps) { var url = nextProps.url, onUrlChange = nextProps.onUrlChange; if (url !== this.props.url && onUrlChange && this.iframe) { onUrlChange(this.iframe, url); } }; Frame.prototype.render = function () { var _this = this; var _a = this.props, app = _a.app, title = _a.title, url = _a.url, style = _a.style, onUrlChange = _a.onUrlChange, props = __rest(_a, ["app", "title", "url", "style", "onUrlChange"]); return (react_1.default.createElement("iframe", __assign({ style: style, title: title, src: url }, props, { ref: function (element) { return (element ? (_this.iframe = element) : undefined); } }))); }; Frame.defaultProps = { context: app_bridge_1.Context.Main, }; return Frame; }(react_1.default.Component)); exports.default = Frame;