Using FireBreath

Once you've decided to start using FireBreath and you need to start adding features, these pages will help you understand what is going on.

Note that this site is a wiki -- please add pages and update documentation when you find something that isn't entirely clear!

Interacting with Javascript

Overview - Overview of what JSAPI is and how it works
JSAPI Methods - How to add methods to your JSAPI class
JSAPI Properties - How to add properties to your JSAPI class
JSAPI Attributes - How to add attributes to your JSAPI class
Firing Events from JSAPI - Events originating in your plugin and handled by JavaScript
Supported JSAPI Types - Types supported by JSAPIAuto
- FB::variant overview - FB::variant is the class used by FireBreath to handle dynamic typing for interacting with JavaScript
- FB::VariantList - Using lists of variants for passing parameters to JSAPI methods or callbacks
JSAPIAuto base class - Overview of the class which most JSAPI classes derive from
Support JS Object Construction - An example of how to create new objects through JSAPI

Overview - Why does FireBreath use CMake? What is the general structure?
Using Libraries - Linking external libraries to your FireBreath project using CMake

PluginCore base class - Overview of the base class which all plugin objects derive from
Mac Plugins - Special considerations for developing plugins for Mac OS X
Plugin Lifecycle - Overview of the lifecycle of a FireBreath plugin

General FAQ
Best Practices - Suggestions from the developers of FireBreath
Tips and Tricks - Useful tricks and code snippets for FireBreath that haven't found a home elsewhere

Deploying and updating your plugin - Tips and suggestions on various ways to handle deploying and managing your plugin
Handling downloads using FireBreath - Using the FireBreath to perform downloads through the browser
WiX Installer Help - Suggestions on how to best use WiX with FireBreath to create MSI installers