嵌入

嵌入是一种简单的方式，可以在您的网站中包含应用程序。 添加以下代码到您的网站：

<iframe
  id="butterfly"
  src="https://web.butterfly.linwood.dev/embed"
  width="100%"
  height="500px"
  allowtransparency="true"
></iframe>

备选方案

选项	类型	默认设置	描述
保存	布尔值(true，false)	true	启用保存。 如果禁用，只显示退出按钮
可编辑	布尔值(true，false)	true	启用编辑。 如果禁用，文档将只读
语言	字符串 (…, 系统, 用户)	user	文件所用语文。 如果系统从浏览器中检测到该语言。 如果用户，语言将设置为用户首选项

Messaging

The embed uses browser postMessage events. Send messages to the iframe with iframe.contentWindow.postMessage({ type, message }, origin). Butterfly sends messages back to the parent window with the same shape: { type: string, message?: unknown }.

See the embedding example for a live page that sends messages to the iframe and listens for messages from it.

<iframe
  id="butterfly"
  src="https://web.butterfly.linwood.dev/embed?save=true&editable=true"
  width="100%"
  height="500"
></iframe>

<script>
  const butterflyOrigin = 'https://web.butterfly.linwood.dev';
  const butterfly = document.querySelector('#butterfly');

  function sendToButterfly(type, message) {
    butterfly.contentWindow.postMessage({ type, message }, butterflyOrigin);
  }

  window.addEventListener('message', (event) => {
    if (
      event.origin !== butterflyOrigin ||
      event.source !== butterfly.contentWindow
    ) {
      return;
    }

    const { type, message } = event.data ?? {};

    if (type === 'save') {
      const documentBytes = Array.from(message);
      console.log('Save requested by the embed', documentBytes);
    }

    if (type === 'change') {
      console.log('Document changed', message);
    }

    if (type === 'getData') {
      console.log('Current document bytes', message);
    }

    if (type === 'render') {
      const image = new Image();
      image.src = `data:image/png;base64,${message}`;
      document.body.append(image);
    }
  });

  butterfly.addEventListener('load', () => {
    sendToButterfly('getData');

    sendToButterfly('render', {
      x: 0,
      y: 0,
      width: 600,
      height: 400,
      scale: 1,
      renderBackground: true,
    });
  });
</script>

To load document bytes into the embed, send an array of byte values:

sendToButterfly('setData', documentBytes);

事件

Listen for events with window.addEventListener('message', ...).

保存

The save event is emitted when the user clicks the save button.

参数：

• message (Type List<int>): The data of the document.

退出

The exit event is emitted when the user clicks the exit button.

参数：

• message (Type List<int>): The data of the document.

change

The change event is emitted when the user changes the document.

参数：

• message (Type List<int>): The data of the document.

方法

Call methods with iframe.contentWindow.postMessage(...). Methods that return data send another message back with the same type.

getData

The getData method returns the data of the document.

没有参数。 Returns: List<int>

setData

The setData method sets the data of the document.

参数：

• data (Type List<int>): The data of the document.

render

The render method renders the document to a png image.

参数：

• x (Type Number): The x position of the exported area.
• y (Type Number): The y position of the exported area.
• width (Type Number): The width of the image.
• height (Type Number): The height of the image.
• scale (Type Number): The scale of the image.
• renderBackground (Type Boolean): If true, the background will be rendered.

Returns: String (Base64 encoded image)

renderSVG

The renderSVG method renders the document to a svg image.

参数：

• x (Type Number): The x position of the exported area.
• y (Type Number): The y position of the exported area.
• width (Type Number): The width of the image.
• height (Type Number): The height of the image.
• renderBackground (Type Boolean): If true, the background will be rendered.

Returns: String (SVG)