Customizing the Intercom Launcher
We've been using Intercom in CAPP Agile Learning for well over a year now, and like we said back then, it has really improved our support and in-app communication with users.
A few weeks ago Intercom introduced their new messenger, where they've added some new features and did an impressive redesign.
Before the update we applied a bit of styling to change the size of the launcher (the default is too big for our taste). But after the update this doesn't work anymore due to the fact that Intercom renders everything inside an iframe. I was hoping for a little bit more control over the size through the App settings, but this is limited to selecting a custom color.
This blog post shows you two ways how to customize the Intercom Launcher, but I will limit the examples to changing its size. The two options are:
- Inject a stylesheet into the iframe
- Create a custom launcher
Inject a stylesheet into the iframe
I think Intercom started using iframes to isolate/sandbox their widgets, e.g. to prevent style leakage or even discourage custom styling all together. This is for a reason, so you might consider this a hack/quick fix.
We poll for the iframe to become ready, and append the intercom.css
stylesheet to its head. Forgive me for the not so elegant polling, but this is because the Intercom Javascript API lacks a ready callback :(
The stylesheet that is injected by the script:
This stylesheet should also be included in your app or website (or at least the first part). The first parts targets the launcher iframe itself, the second part targets the iframe content (SCSS version here).
Create a custom launcher
A custom launcher gives you more control over its appearance and behaviour. This is the "official" way to customize the launcher, and probably more future proof compared to injecting a stylesheet into the iframe. The example below is a smaller recreation of the original launcher.
First create a link with a mailto address, which serves as a fallback in case Intercom is not (yet) booted. Don't forget to replace YOUR_APP_ID
.
The trick is to initialize Intercom with the custom_launcher_selector
option. This selector should match the mailto link we've just created. By creating onShow
, onHide
and onUnreadCountChange
callbacks we are able to deal with events. And finally we start polling for the Intercom.boot
flag, which indicated if Intercom is booted. The intercom-booted
class is added to make the launcher visible.
The styling is copied from the original launcher (for the most part):
Note: The styling is in SCSS format. You can compile it to CSS online or via command line: sass --watch . --no-cache
.
Also, I didn't include vendor prefixes so you might want to add those. Or even better, use Autoprefixer.
Last but not least, turn off the Intercom Messenger launcher. Your newly created launcher is ready to take its place! For more information read the docs.
Intercom's missing ready callback
The Intercom JavaScript API is lacking a ready
callback, something I've missed from the beginning. There is an Intercom.boot
flag to test if it's booted, but you still have to watch/poll it (like the example above). I've been talking to Sean, a really helpful Customer Support Engineer at Intercom, about this and he said:
I'll tag this as a feature request, maybe we can look at getting it added at some point.
I hope this helps someone! If you have questions or improvements, please contact us on Twitter or Intercom :)