iMessage message effects

iMessage supports bubble effects, which animate the sent message bubble, and screen effects, which play a full-screen animation on receive. Wrap any content with effect():

import { attachment } from "spectrum-ts";
import { effect, imessage } from "spectrum-ts/providers/imessage";

await space.send(effect("Happy birthday!", imessage.effect.message.celebration));
await space.send(
  effect(
    attachment("/path/to/photo.jpg"),
    imessage.effect.message.confetti
  )
);

The wrapped content can be a string, markdown(...), or any attachment(...). Effects only apply on iMessage. Other platforms see the inner content unchanged.

Sending effects requires the cloud @spectrum-ts/imessage package. The local package exports the helper for API consistency but rejects effect sends with an UnsupportedError.

Bubble effects

MessageEffect reference

Screen effects

MessageEffect reference

⌘I

Get started

Core concepts

Content

Providers

Advanced

Integrations

Best Practices

Troubleshooting

iMessage message effects