PHP Class WPDKUIPopover

Since: 1.5.0
Author: =undo= ([email protected])
Inheritance: extends WPDKHTMLTag
Show file Open project: wpxtreme/wpdk

Public Properties

Property Type Description
$animation boolean Apply a CSS fade transition to the popover
$container boolean This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
$content string Content
$delay integer | string Delay showing and hiding the popover (ms) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: delay: { show: 500, hide: 100 }
$html boolean Use text if you're worried about XSS attacks.
$id string ID attribute of main content
$placement string When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.
$selector string In practice, this is used to enable dynamic HTML content to have popovers added. See http://jsfiddle.net/fScua/
$static boolean Render as static. Default is FALSE
$title string Title
$trigger string How popover is triggered - click | hover | focus | manual

Public Methods

Method Description
__construct ( string $id, string $title = '', string $content = '', string $placement = WPDKUIPopoverPlacement::RIGHT ) : WPDKUIPopover Create an instance of WPDKUIPopover class
content ( ) : string Return the content of popover
html ( ) : string Return the HTML markup of Popover
title ( ) : string Title of popober

Method Details

__construct() public method

Create an instance of WPDKUIPopover class
public __construct ( string $id, string $title = '', string $content = '', string $placement = WPDKUIPopoverPlacement::RIGHT ) : WPDKUIPopover
$id string ID attribute
$title string Optional. Title of popover
$content string Optional. Content of popover
$placement string Optional. Default WPDKUIPopoverPlacement::RIGHT
return WPDKUIPopover

content() public method

Return the content of popover
public content ( ) : string
return string

html() public method

Return the HTML markup of Popover
public html ( ) : string
return string

title() public method

Title of popober
public title ( ) : string
return string

Property Details

$animation public property

Apply a CSS fade transition to the popover
public bool $animation
return boolean

$container public property

This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
public bool $container
return boolean

$content public property

Content
public string $content
return string

$delay public property

Delay showing and hiding the popover (ms) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: delay: { show: 500, hide: 100 }
public int|string $delay
return integer | string

$html public property

Use text if you're worried about XSS attacks.
public bool $html
return boolean

$id public property

ID attribute of main content
public string $id
return string

$placement public property

When "auto" is specified, it will dynamically reorient the popover. For example, if placement is "auto left", the popover will display to the left when possible, otherwise it will display right.
public string $placement
return string

$selector public property

In practice, this is used to enable dynamic HTML content to have popovers added. See http://jsfiddle.net/fScua/
public string $selector
return string

$static public property

Render as static. Default is FALSE
public bool $static
return boolean

$title public property

Title
public string $title
return string

$trigger public property

How popover is triggered - click | hover | focus | manual
public string $trigger
return string