Share

Open the native share sheet using the unified MiniKit API.

Use MiniKit.share() to open the native share sheet with text, links, or files.

Basic Usage

Example

import { MiniKit } from "@worldcoin/minikit-js";
import type {
  CommandResultByVia,
  MiniAppShareSuccessPayload,
  MiniKitShareOptions,
} from "@worldcoin/minikit-js/commands";

export async function shareLink() {
  const input = {
    title: "Invite Link",
    text: "Use this invite code to join my mini app",
    url: "https://world.org",
  } satisfies MiniKitShareOptions;

  const result: CommandResultByVia<
    MiniAppShareSuccessPayload,
    MiniAppShareSuccessPayload,
    "minikit"
  > = await MiniKit.share(input);

  console.log(result.data.shared_files_count);
}

Result

Type

type ShareResponse =
  | {
      executedWith: "minikit";
      data: {
        status: "success";
        version: number;
        shared_files_count: number;
        timestamp: string;
      };
    }
  | {
      executedWith: "fallback";
      data: unknown;
    };

Fallback Behavior

Define a custom fallback in the command payload for support outside mini apps.

Error Codes

Code	Meaning
user_rejected	The user rejected the share flow
generic_error	Unexpected failure
invalid_file_name	One or more file names are invalid

Preview