YiiFoundation
  • Namespace
  • Class
  • Tree

Namespaces

  • foundation
    • enum
    • exception
    • helpers
    • widgets
      • base
  • PHP

Classes

  • Alert
  • Breadcrumbs
  • Clearing
  • Dropdown
  • FlexVideo
  • Interchange
  • JoyRide
  • Magellan
  • Orbit
  • Pager
  • Reveal
  • Section
  • SwitchButton
  • Tooltip
  • TopBar

Class Reveal

Reveal renders the markup for the modal dialog plugin of Foundation

CWidget
Extended by foundation\widgets\base\Widget
Extended by foundation\widgets\Reveal
Namespace: foundation\widgets
Package: foundation\widgets
Author: Antonio Ramirez <amigo.cobos@gmail.com>
See: http://foundation.zurb.com/docs/components/reveal.html
Located at widgets/Reveal.php

Methods summary

public
# init( )

Initializes the widget

Initializes the widget

Overrides

foundation\widgets\base\Widget::init
public
# run( )

Renders the widget

Renders the widget

public string
# renderHeader( )

Returns

string
public null|string
# renderToggleButton( )

Renders the toggle button

Renders the toggle button

Returns

null|string
the rendering result
protected string
# renderCloseButton( )

Renders the close button.

Renders the close button.

Returns

string
the rendering result
public
# registerClientScript( )

Registers plugin options and events (if any)

Registers plugin options and events (if any)

Methods inherited from foundation\widgets\base\Widget

display(), registerAssets(), registerEvents(), registerPlugin()

Magic methods summary

Properties summary

public string $size
#

the size of the modal

the size of the modal

public string $header
#

header. The string will be wrapped on a H2 tag

header. The string will be wrapped on a H2 tag

public array $headerHtmlOptions
#

the header html options

the header html options

public string $body
#

the body of the modal

the body of the modal

public array $pluginOptions
#

the plugin options. The following is the list of supported options and their default values:

´´´php array(
'animation' => 'fadeAndPop',
'animationSpeed' => 250,
'closeOnBackgroundClick' => true,
'dismissModalClass' => 'close-reveal-modal',
'bgClass' => 'reveal-modal-bg',
'bg' => 'js:$("reveal-modal-bg")', // jquery element
'css' => array(
'open' => array(
'opacity' => 0,
'visibility' => 'visible',
'display' => 'block'
),
'close' => array(
'opacity': 1,
'visibility': 'hidden',
'display': 'none'
),
) ´´´

the plugin options. The following is the list of supported options and their default values:

´´´php array( 'animation' => 'fadeAndPop', 'animationSpeed' => 250, 'closeOnBackgroundClick' => true, 'dismissModalClass' => 'close-reveal-modal', 'bgClass' => 'reveal-modal-bg', 'bg' => 'js:$("reveal-modal-bg")', // jquery element 'css' => array( 'open' => array( 'opacity' => 0, 'visibility' => 'visible', 'display' => 'block' ), 'close' => array( 'opacity': 1, 'visibility': 'hidden', 'display': 'none' ), ) ´´´

public string[] $events
#

the events of the modal. The following list is the supported events:

  • open
  • opened
  • close
  • closed

the events of the modal. The following list is the supported events:

  • open
  • opened
  • close
  • closed
public array $toggleButton
#

the options for rendering the toggle button tag. The toggle button is used to toggle the visibility of the modal window. If this property is null, no toggle button will be rendered.

The following special options are supported:

  • tag: string, the tag name of the button. Defaults to 'button'.
  • label: string, the label of the button. Defaults to 'Show'.

The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the [Modal plugin help](http://foundation.zurb.com/docs/components/reveal.html) for the supported HTML attributes.

the options for rendering the toggle button tag. The toggle button is used to toggle the visibility of the modal window. If this property is null, no toggle button will be rendered.

The following special options are supported:

  • tag: string, the tag name of the button. Defaults to 'button'.
  • label: string, the label of the button. Defaults to 'Show'.

The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the [Modal plugin help](http://foundation.zurb.com/docs/components/reveal.html) for the supported HTML attributes.

public array $closeButton
#

the options for rendering the close button tag. The close button is displayed in the header of the modal window. Clicking on the button will hide the modal window. If this is null, no close button will be rendered.

The following special options are supported:

  • tag: string, the tag name of the button. Defaults to 'button'.
  • label: string, the label of the button. Defaults to '×'.
  • options: array, the html options fo the button. Forced attribute: array('class' => 'close-reveal-modal')

The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the [Modal plugin help](http://foundation.zurb.com/docs/components/reveal.html) for the supported HTML attributes.

the options for rendering the close button tag. The close button is displayed in the header of the modal window. Clicking on the button will hide the modal window. If this is null, no close button will be rendered.

The following special options are supported:

  • tag: string, the tag name of the button. Defaults to 'button'.
  • label: string, the label of the button. Defaults to '×'.
  • options: array, the html options fo the button. Forced attribute: array('class' => 'close-reveal-modal')

The rest of the options will be rendered as the HTML attributes of the button tag. Please refer to the [Modal plugin help](http://foundation.zurb.com/docs/components/reveal.html) for the supported HTML attributes.

Properties inherited from foundation\widgets\base\Widget

$assets, $htmlOptions, $links

YiiFoundation API documentation generated by ApiGen 2.8.0