|
 |
Gigya's Developer Documentation > Wildfire Sharing Tool > API Reference > Configuration Parameters > UI Parameters
UI ParametersFrom $1Table of contents
UIConfigAn XML string that provide detailed control over the look and feel of Wildfire by overriding the default UI configuration. Wildfire uses a hierarchical xml to allow a flexible and highly configurable design.
An Example UIConfig: UIConfig: '<config><display showEmail="true" useTransitions="true" showBookmark="true" codeBoxHeight="auto"
showCodeBox="true" showCloseButton="false" networksWithCodeBox=""></display>
<body><background frame-color="#BFBFBF" background-color="#FFFFFF" gradient-color-begin="#ffffff"
gradient-color-end="#F4F4F4" corner-roundness="4;4;4;4"></background><controls color="#202020"
corner-roundness="4;4;4;4" gradient-color-begin="#EAEAEA" gradient-color-end="#F4F4F4" bold="false">
<snbuttons type="textUnder" frame-color="#D5D5D5" over-frame-color="#60BFFF" color="#808080"
gradient-color-begin="#FFFFFF" gradient-color-end="d4d6d7" size="10" bold="false" down-frame-color="#60BFFF"
down-gradient-color-begin="#6DDADA" over-gradient-color-end="#6DDADA" down-gradient-color-end="#F4F4F4"
over-color="#52A4DA" down-color="#52A4DA" over-bold="false">
<more frame-color="#A4DBFF" over-frame-color="#A4DBFF"
gradient-color-begin="#F4F4F4" gradient-color-end="#BBE4FF" over-gradient-color-begin="#A4DBFF"
over-gradient-color-end="#F4F4F4"></more><previous frame-color="#BBE4FF" over-frame-color="#A4DBFF"
gradient-color-begin="#FFFFFF" gradient-color-end="#A4DBFF" over-gradient-color-begin="#A4DBFF"
over-gradient-color-end="#F4F4F4"></previous></snbuttons><textboxes frame-color="#CACACA" color="#757575"
gradient-color-begin="#ffffff" bold="false"><codeboxes color="#757575" frame-color="#DFDFDF"
background-color="#FFFFFF" gradient-color-begin="#ffffff" gradient-color-end="#FFFFFF" size="10"></codeboxes>
<inputs frame-color="#CACACA" color="#757575" gradient-color-begin="#F4F4F4" gradient-color-end="#ffffff">
</inputs><dropdowns list-item-over-color="#52A4DA" frame-color="#CACACA"></dropdowns></textboxes>
<buttons frame-color="#CACACA" gradient-color-begin="#F4F4F4" gradient-color-end="#CACACA" color="#000000"
bold="false" over-frame-color="#60BFFF" over-gradient-color-begin="#BBE4FF" down-gradient-color-begin="#BBE4FF"
over-gradient-color-end="#FFFFFF" down-gradient-color-end="#ffffff">
<post-buttons frame-color="#CACACA" gradient-color-end="#CACACA"></post-buttons></buttons>
<listboxes frame-color="#CACACA" corner-roundness="4;4;4;4" gradient-color-begin="#F4F4F4"
gradient-color-end="#FFFFFF"></listboxes>
<checkboxes checkmark-color="#00B600" frame-color="#D5D5D5" corner-roundness="3;3;3;3"
gradient-color-begin="#F4F4F4" gradient-color-end="#FFFFFF"></checkboxes>
<servicemarker gradient-color-begin="#ffffff" gradient-color-end="#D5D5D5"></servicemarker>
<tooltips color="#6D5128" gradient-color-begin="#FFFFFF" gradient-color-end="#FFE4BB" size="10"
frame-color="#FFDBA4"></tooltips></controls>
<texts color="#202020"><headers color="#202020"></headers><messages color="#202020"></messages>
<links color="#52A4DA" underline="false" over-color="#353535" down-color="#353535" down-bold="false"></links>
</texts></body></config>'
Most UIConfig attributes may be configured using the Advanced Setup Wizards. You may export and import the UIConfig from and to the Advanced Wizard using the the following buttons (located in the middle of the Wizard):
Some of the UIConfig attributes may not be configured using the Wizards: mixNetworksBoolean attribute, part of the "display" element of the UIConfig. When mixNetworks is set to "true" Wildfire will display all the icons of "Post", "Bookmark", "email" and "Desktop" networks mixed on a single frame. The single frame would have a "Quick post" title. By default, wildfire presents the network icons in four different tabs: "Post", "Bookmark", "email" and "Desktop". Setting mixNetworks:UIConfig: '<config><display mixNetworks="true" ... ></display></config>' The outcome:
enableMyEmailFieldBoolean attribute, part of the "display" element of the UIConfig. When enableMyEmailField is set to "true" Wildfire will display a "My email" field for the user to enter his email address (in the Email tab). Setting enableMyEmailField:UIConfig: '<config><display showEmail="true" enableMyEmailField="true" ... ></display></config>' The outcome:
showPostA boolean parameter. The value of this parameter determines whether the "Post" tab is available on Wildfire UI. By default, the "Post" tab is available (the default value is "true").
showBookmarkA boolean parameter. The value of this parameter determines whether the "Bookmark" tab is available on Wildfire UI. By default, the "Bookmark" tab is available (the default value is "true").
showEmailA boolean parameter. The value of this parameter determines whether the "Email " tab is available on Wildfire UI. By default, the "Email" tab is available (the default value is "true").
showDesktopA boolean parameter. The value of this parameter determines whether the "Desktop" tab is available on Wildfire UI. By default, the "Desktp" tab is not available (the default value is "false"). Assigning "true" to this parameter, results in having the "Desktop" tab available on Wildfire UI, as shown in the screen shot below:
langBy assigning a two character language code to this parameter Wildfire can render in that language. Currently Supported Languages:
Note:
If you are using AS2 you have to manually load the language specific version of wildfire.swf file. To do that append _ and the language code to the wildfire swf name. For example, to load the Mexican Spanish version of wildfire in AS2 change the line: mcWF.loadMovie('http://cdn.gigya.com/WildFire/swf/wildfire.swf','get');
to: mcWF.loadMovie('http://cdn.gigya.com/WildFire/swf/wildfire_es-mx.swf','get');
localConfigAn XML string for setting UI configuration, which overrides the configuration set by the UIConfig parameter. This can be helpful when building a complex UI configuration that has to be slightly different in different situations. The localConfig parameter allows setting only the differences while the main configuration remains unchanged.
networksToShow, networksToHideThis pair of parameters allow you to set which social-network buttons are displayed on Wildfire "Post" tab, and also determine the order. Each parameter is set with a comma separated string of network names. Note - If the current user has already posted to a certain social-network, this social-network will be displayed first (the position of this destination site will precede the list, which is predefined in networksToShow), so as to provide an improved user experience.
bookmarksToShow, bookmarksToHideThis pair of parameters allow you to set which social-bookmarking-sites buttons are displayed on Wildfire "Bookmark" tab, and also determine the order. Each parameter is set with a comma separated string of network names. These pair of parameters have similar logic to the networksToShow and networksToHide pair of parameters. Note - If the current user have already bookmarked using certain social-bookmarking-sites, this social-bookmarking-sites will be shown first (prior to the list defined in bookmarksToShow) for better user experience.
customNetworksThis parameter allows you to add new custom network buttons to Wildfire. When the user presses your custom button the regular NetworkButtonClicked Event will be fired. Defining Custom Network Button:The custom network buttons are defined using an XML string, in the following format: customNetworks: '<nets><net id="customnet1" name="Network 1 Display Name" iconURL="http://www.quarktet.com/Icon-small.jpg" service="POST" /><net id="customnet2" name="Network 2 Display Name" iconURL="http://www.quarktet.com/Icon-small.jpg" service="BOOKMARK" /></nets>' Where: <net /> defines a single network button. Each button is defined using the following properties:
nowmodeA boolean parameter. Assigning "true" to this parameter, forces wildfire not to use the wmode parameter. A bug in FireFox leads to a situation where when using wmode (which Wildfire uses by default for transparency) input from non English US keyboards is interpreted as if it came from an English US keyboard. This means that for example a German keyboard that has the @ sign on the Alt-Gr+Q key combination will produce the @ sign only when shift+2 is pressed. The downside of using this setting is that you can not use transparent background. If you don’t need a transparent background you should set nowmode to "true". When setting nowmode to "true" you can and probably should also use the outsideColor described next.
Tags:
Files (0) |
||||||||||||||||||||||||||||||||||||||||||||||
|
