You are here: Docs Clearspring Website Tools Getting Launchpad In-Widget APIs

Getting Launchpad In-Widget APIs

From within the Widget Console, you can get the Launchpad In-Widget API to include in your widget.  Just click Add Widget button at the top of the console.  Next you'll be asked "Where do you want to add Launchpad?". You have two choices: "My web page" or "My widget", choose "My widget", then click "API" to begin the process of getting the Launchpad In-Widget APIs 

You'll see the API-mode configuration tool, which will give you all the options you need to get ActionScript 3, ActionScript 2, or JavaScript code to include the Launchpad In-Widget APIs in your widget. All you really need to do is give your widget a name and click the Generate Code button.  The generated code can then be added to you widget.

When generating the API code, you have the option to define the type and style of the Lauchpad menu.  By default the code generate will be ActionScript 3, which uses the new Launchpad menu.  If you need ActionScript 2 or JavaScript code simply open Code Type and select the code environment.

As a developer you may choose to take our full code library or just what is needed for sharing.  The Share Menu option allow you to select which APIs you need.

The Default Menu option provides access to all aspects of the API.  While the Sharing API provides the core sharing and tracking services but not the menu.  This allow you to control to create your own menu using the Launchpad sharing platform.  Finally if tracking is all that is needed then select the Just Tracking option.  This gives you the power to add tracking capabilities to your widget.

If you select using the Default Menu the other options are available to customize the menu using the console.  Note that all these customization can be made and updated via the APIs, the console makes it easier to get started. 

The Color Theme option allows you to set the color theme of the menu.  We provide four common themes that you can select and use.  If theses themes do not fit your desired style the you can choose to customize the menu colors.

The menu size allow you to select the size of the menu that will be displayed when activated.

We provide a full setting for the menu which will automatically scale to the full size of your widget.  If you want full control over the menu size select Custom and set the menu size to your needs.  To help with sizing the menu a sample preview, below the selections, is available so you can better gage the size of the menu.

The services sections allows you to choose which services you want on your menu.  All services that are available from Clearspring are displayed in the list.

Use the Filter option to show groups of services; Post is all social networks and personal sites, Bookmarks are the list of all bookmarking sites, Send is available methods to send the content (email and mobile), Desktop is all support desktop widget platforms, Embed if you want someone to grab the embed code and subscribe for all RSS reader sites.  To add or remove any of these simply select the check box.  NOTE: some features require addtional configuration, such as Subscribe and Mobile

The Launchpad Menu has several optional capabilities which can be selected.  All of these options effect the look and feel of the menu for the user. 

The "Show the Embed Code" option will display the embed code on the menu, and available as a button, for your users.  If you disabled the Embed services then this option is not available.

When using the In-Widget APIs you need to define what will be shared.  The "What do you want to share" option allows you to add you content to be share. 

When sharing the widget we suggest you use a content template.  Learn more about templating contet in the Share API section.

Once you have completed setting your desired option click the Generate Code button to generate the In-Widget API code you will add to your widget.

After getting the code, check out the detailed API docs for more info on what you can do with Launchpad In-Widget APIs.