Extension: Content Dock

This article was last updated on the December 30, 2016.

Extensions are X specific plugins available for download for all customers with a validated purchase of X. You can easily download and manage all of your Extensions directly from the WordPress admin area under Addons > Extensions. This article covers documentation for the Content Dock Extension and goes into detail on certain features where needed.

Enabling the Extension

After installing and activate Content Dock, you’ll find its settings page underneath the Addons menu.

Content Dock Settings

From the main Content Dock settings screen you can choose to disable or enable the plugin as needed:

Content Dock Enable Or Disable?

Disabling the plugin will effectively turn off all output from the plugin (e.g. HTML, CSS, JavaScript etc). This is useful as a quick way to toggle activity if you ever need without having to go through the Plugins menu and worry about activating/deactivating it completely. This way you can work with and manage all of your X specific functionality from one centralized place under the Addons section.

Selecting the enable checkbox will bring up the Settings meta box below. This is where you will adjust any options for the plugin and input your data as needed.

Content Dock main settings

What Content Dock does

Content dock allows you to show a widget on scroll or after a set period of time. You can see some examples of Content Dock in action over on our demo site for the plugin.

As Content Dock is a widget it means you can use any widget from any WordPress plugin or theme! And of course the default WordPress widgets giving you limitless possibilities.

Setting Up Content Dock

The batch of settings for Content Dock are:

  • Position – Left or Right. This simply allows you to select wether you want Content Dock to display on the left hand side or right hand side of your website.
  • Width – Pixels. This allows you to set how many pixels the Content Dock should take up. The default value is 350 pixels wide.
  • Display – Percentage. This option allows you to set when the Content Dock should display. Default value is 50, if you keep the default value, the Content Dock will display after the user has scrolled down 50% of your page.
  • Auto Trigger Timeout – Percentage. This allows you to automatically set the Content Dock to display after a period of time (seconds) if a user hasn’t already reached the display percentage set in the previous option. Setting 0 for this option disables it completely.
  • Do Not Show Again – Cookie timeout percentage. This options allows you to disable the output of the Content Dock if someone has already seen it by setting a cookie. Do note though if the user has cleared their cookies the Content Dock will once again show.

The next settings all pertain to where Content Dock will show.

  • Active for all pages – checking this will make Content Dock display on all your pages across your website. Keep this un-checked if you only wish to display Content Dock on specific pages.
  • Include Pages – This option lists all the pages on your website for you to select which ones you want Content Dock to display on.
  • Active for all posts – checking this will make Content Dock display on all your posts across your website. Keep this un-checked if you only wish to display Content Dock on specific posts.
  • Include Posts – This option lists all the posts on your website for you to select which ones you want Content Dock to display on.

The next option is for overriding the Content Dock with an image and URL:

Content Dock override

Checking that will display the override image and override URL options like this:

Override Content Dock options

The image will override what is set to show in the Content Dock. Only set this if you just want an image that links out to a different page/website. Otherwise leave this unset.

The remaining options all pertain to colors, including the button and headings color and all are color selectors.

Color Settings for Content Dock

Once you’re happy with everything scroll back to the top of the page and click on Update to save your Content Dock Settings.

Configuring what displays in your Content Dock

In your WordPress admin navigate to Appearance > Widgets and you should see your main widgets screen like this:

Widgets Content Dock

On the left hand side you have all available Widgets and on the right hand side all available Widget areas including Content Dock. Drag any widget you’d like to the Content Dock widget area on the right hand side.

Once you’ve done the above, you have successfully configured Content Dock, congrats!

Content Dock Display

The Content Dock is visible on displays larger than 767px and will be hidden on any displays smaller than this. This is for numerous usability reasons, which mostly have to do with ensuring that your site’s primary content is always accessible and not completely hidden by the Extension and that the close button is not inaccessible.