Show:

Q columns Class

Defined in: platform/plugins/Q/handlers/Q/columns/tool.php:7
Module: Q-tools

This tool contains functionality to show things in columns

Constructor

Q columns

(
  • [options]
)
String

Defined in platform/plugins/Q/handlers/Q/columns/tool.php:7

Parameters:

  • [options] Array optional

    Provide options for this tool

    • [title] String optional

      You can put a default title for all columns here (which is shown as they are loading)

    • [column] String optional

      You can put a default content for all columns here (which is shown as they are loading)

    • [controls] String optional

      You can put default controls HTML for all columns here (which is shown as they are loading)

    • [data] Array optional

      Any data you want to associate with the column, to be retrieved later by the tool.data() method

    • [attributes] Array optional

      Any attributes you want to add to the column element

    • [animation] Array optional

      For customizing animated transitions

      • [duration] Integer optional
        The duration of the transition in milliseconds, defaults to 500
      • [hide] Array optional
        The css properties in "hide" state of animation
      • [show] Array optional
        The css properties in "show" state of animation
    • [back] Array optional

      For customizing the back button on mobile

      • [src] String optional
        The src of the image to use for the back button
      • [triggerFromTitle] Boolean optional
        Whether the whole title would be a trigger for the back button. Defaults to true.
      • [hide] Boolean optional
        Whether to hide the back button. Defaults to false, but you can pass true on android, for example.
    • [close] Array optional

      For customizing the back button on desktop and tablet

      • [src] String optional
        The src of the image to use for the close button
      • [clickable] Object optional
        If not null, enables the Q/clickable tool with options from here. Defaults to null.
    • [scrollbarsAutoHide] Array optional

      If not null, enables Q/scrollbarsAutoHide functionality with options from here. Enabled by default.

    • [fullscreen] Boolean optional

      Whether to use fullscreen mode on mobile phones, using document to scroll instead of relying on possibly buggy "overflow" CSS implementation. Defaults to true on Android, false everywhere else.

    • [columns] Array optional

      In PHP only, an array of $name => $column pairs, where $column is in the form array('title' => $html, 'content' => $html, 'close' => true, 'controls' => $html, 'url' => $url), 'columnClass' => string, with "controls", "close", "columnClass" and "url" being optional

Returns:

String:

Item Index