Documentation

Client-Side JavaScript

In order to enable the managing of content directly on your website, you have to place the client-side script reference to KitGUI just before the closing </body> tag like so:

<script type="text/javascript">
   // declare the global configuration variable "kitgui" and set it with your CMS Account key
   var kitgui = { key : '00000000000000000000000000000000' };
</script>
<script type="text/javascript" src="https://d34ic8my8k87as.cloudfront.net/js/kitgui.js"></script>

You can find your CMS Account key within the "My KitGUI" -> "CMS Accounts" section of kitgui.com or request this from the customer owning the CMS Account.

Here are all the options you can place on the kitgui JavaScript variable:

<script type="text/javascript">
   var kitgui = {
       
// the CMS Account key
        key : '00000000000000000000000000000000',
        // boolean value to show or hide the KitGUI CMS Tab that allows for direct login on the web page
        tabVisible : false,
       
// this is the URL to override the KitGUI Tab image
        tabImage : URL,
       
// add new buttons that will open up URLs within the KitGUI frame overlay
        buttons : [
             { label: 'administration', url: 'https://www.mysite.com/admin' }
        ]

  };
</script>
<script type="text/javascript" src="https://d34ic8my8k87as.cloudfront.net/js/kitgui.js"></script>


After the code above has been declared, to show the tab image on the client-side, you can later call the kitgui.showTab() JavaScript method which will show the tab to allow login to occur through KitGUI.

To find out more information on setting the tab image, see How to White-Label KitGUI.

For JavaScripters and jQuery enthusiasts

The only global variable we use is kitgui within our JavaScript and the rest of our code runs within closures. We do load our own version of jQuery but it will not interfere with your existing jQuery version and our jQuery version will never live on the window object directly if only for a millisecond. If you want to use jQuery through KitGUI, you can access it like so: kitgui.$ although we encourage you to place KitGUI JavaScript at the bottom of your page and the jQuery variable won't be available until after the script loads.