@flare-engine/share

中文文档
0.4.12发布于 2026/11/13Apache-2.0TypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 2322

Screenshot capture + cross-platform share sheet

原始使用文档
文档目录4 节
  1. Install
  2. Usage
  3. Android screenshots
  4. License

@flare-engine/share

Cross-platform screenshot capture (Skia makeImageSnapshot) + share-sheet orchestration with pluggable transports. captureScreenshot(source, opts?) returns { bytes, base64, format, width, height }. ShareManager cascades through registered transports — first one whose canShare(payload) returns true wins. Built-in transports cover Web Share API, Web Clipboard fallback, native RN Share, and expo-sharing (image files, for Android screenshots). createScreenshotScene wires a one-shot capture scene for store-asset workflows.

Install

bun add @flare-engine/share

Usage

import { Share } from 'react-native';
import { captureScreenshot, ShareManager, createNativeShareTransport,
         createWebShareTransport, createWebClipboardTransport } from '@flare-engine/share';
import type { CaptureSource } from '@flare-engine/share';

declare const source: CaptureSource;

const shot = captureScreenshot(source, { format: 'png' });

const share = new ShareManager()
  .register(createNativeShareTransport(Share))
  .register(createWebShareTransport(navigator, File))
  .register(createWebClipboardTransport(navigator));

if (shot) {
  await share.share({ message: 'New high score! https://example.com', screenshot: shot });
}

Platform notes:

  • createWebShareTransport attaches the screenshot as a File when the browser's navigator.canShare({ files }) accepts it.
  • createNativeShareTransport attaches it on iOS as a data:image/<format>;base64,… URL, only when url is unset — an explicit url wins and no image is attached then. Android's RN Share forwards only title and message, so put a link in message; the image is not attached there, and a payload with a screenshot but no message opens an empty sheet that still reports dispatched: true.
  • createWebClipboardTransport copies message and url text only.
  • createExpoShareTransport shares the screenshot as an image file; see below.

Android screenshots

RN's Share cannot attach an image on Android. createExpoShareTransport(sharing, files) writes the screenshot to a file and hands its URI to expo-sharing. Register it before the RN transport: its canShare is true only when the payload has a screenshot, so screenshot payloads reach expo-sharing and text-only payloads fall through to RN Share.

import { Share } from 'react-native';
import * as Sharing from 'expo-sharing';
import { File, Paths } from 'expo-file-system';
import { createExpoShareTransport, createNativeShareTransport, ShareManager } from '@flare-engine/share';
import type { ShareFileWriterLike } from '@flare-engine/share';

const files: ShareFileWriterLike = {
  async writeBase64File(name, base64) {
    const f = new File(Paths.cache, name);
    await f.write(base64, { encoding: 'base64' });
    return f.uri;
  },
};

const share = new ShareManager()
  .register(createExpoShareTransport(Sharing, files))
  .register(createNativeShareTransport(Share));

files is one callback that writes base64 data to a file and resolves to its URI. The adapter above uses the File API of expo-file-system 58, where write creates the file or overwrites it. With the expo-file-system/legacy entry, write it this way instead:

import { cacheDirectory, writeAsStringAsync } from 'expo-file-system/legacy';
import type { ShareFileWriterLike } from '@flare-engine/share';

const files: ShareFileWriterLike = {
  async writeBase64File(name, base64) {
    const uri = `${cacheDirectory}${name}`;
    await writeAsStringAsync(uri, base64, { encoding: 'base64' });
    return uri;
  },
};

Limits:

  • expo-sharing shares one file and no text. The screenshot goes out alone: message and url are dropped, and title becomes the chooser's dialogTitle.
  • The file is always named screenshot.<format>, so each share overwrites the previous one.
  • The result is { dispatched: true, via: 'native' } once the sheet has opened; expo-sharing does not say whether the user finished the share. When isAvailableAsync() resolves false, nothing is written and the result is { dispatched: false, via: 'native' }. A failed write or a rejected shareAsync rejects the share() promise.

See API spec.

License

Apache-2.0

版本与发布记录

@flare-engine/share 共发布 17 个版本,首次发布于 2026/06/10;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.4.12latest2026/11/133 天前
0.4.112026/11/123 天前
0.4.102026/11/087 天前
0.4.82026/11/0610 天前
0.4.72026/11/0411 天前
0.4.62026/10/3115 天前

关于 @flare-engine/share 的常见问题

@flare-engine/share 是什么?

Screenshot capture + cross-platform share sheet

如何安装 @flare-engine/share?

在项目目录运行 npm install @flare-engine/share,或使用 pnpm add / yarn add / bun add。

@flare-engine/share 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@flare-engine/share 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@flare-engine/share 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=20。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@flare-engine/share 可以商用吗?

@flare-engine/share 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@flare-engine/share 的下载量有多少?

根据 npm 官方下载统计,@flare-engine/share 在 2026/10/15 – 2026/11/13 这 30 天内被下载 2,322 次,日均约 77 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flare-engine/share 还在维护吗?

最新版本 0.4.12 发布于 2026/11/13(3 天前);至今共发布 17 个版本,其中过去 12 个月发布了 17 个;首次发布于 2026/06/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。