File

projects/components/widgets/navigation/popover/src/popover.component.doc.ts

Description

The wmPopover component defines the popover widget.

Index

Methods
Inputs

Methods

onHide
onHide($event: Event, widget: any)

Callback function which will be triggered when the widget is clicked.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered

widget any No

Instance of the popover widget

Returns : void
onLoad
onLoad(widget: any)

This event handler is called when the widget is loaded.

Parameters :
Name Type Optional Description
widget any No

Instance of the popover widget

Returns : void
onShow
onShow($event: Event, widget: any)

Callback function which will be triggered when the widget is clicked.

Parameters :
Name Type Optional Description
$event Event No

DOM event on which call back is triggered

widget any No

Instance of the popover widget

Returns : void

Inputs

autoclose
Type : string
Default value : 'outsideClick'

This property controls the behaviour of popover when clicked outside.

Allowed Values: outsideClick, always, disabled

outsideClick: Closes when clicked outside the popover.

always: Closes when clicked on popover body.

disabled: Disabled auto-close.

badgevalue
Type : string

This property specifies the value to be displayed along with the label of the popover.

Bindable: true

caption
Type : string

This property specifies the label of the popover.

Bindable: true

class
Type : string

Class of the widget.

content
Type : string

Html for inline source or Partial page in case of partials.

Bindable: true

contentsource
Type : string
Default value : 'partial'

Sets content for the popover.

Allowed Values: inline or partial

inline: To drag and drop any widget.

partial: To select from available list of partials.

encodeurl
Type : boolean
Default value : true

This property when set to true will encode the provided URL at run time.

hint
Type : string

Hint text is shown for the popover widget on hover.

Bindable: true

iconclass
Type : string

CSS class of the icon.

iconheight
Type : string

height of the icon.

iconmargin
Type : string

margin of the icon.

iconposition
Type : string

Property to set the position of icon in the widget.

Allowed Values: left, top, right

left: Positions icon to the left.

top: Positions icon on the top.

right: Positions icon to the right.

iconurl
Type : string

url of the icon.

iconwidth
Type : string

width of the icon.

interaction
Type : string

This property defines which action should trigger popover to open or close.

Allowed Values: click, hover, click and hover

click: To open and close on click.

hover: To open and close on hover.

click and hover: To open and close on click/hover.

name
Type : string

Name of the popover widget.

popoverarrow
Type : boolean
Default value : false

This property will be used to display the arrow on the popover.

popoverheight
Type : number
Default value : 360

This property defines the height of the popover.

popoverplacement
Type : string
Default value : 'Bottom'

This property defines the placement of the popover.

Allowed Values: top, bottom, left and right

top: To place the popover on top.

bottom: To place the popover on bottom.

left: To place the popover on left.

right: To place the popover on right.

popoverwidth
Type : number
Default value : 240

This property defines the width of the popover.

shortcutkey
Type : string

The shortcut key property specifies a shortcut key to activate/focus an element.

show
Type : boolean
Default value : true

This property will be used to show/hide the popover widget on the web page.

Bindable: true

tabindex
Type : number
Default value : 0

This property specifies the tab order of the popover Widget.

title
Type : string

Title of the popover widget.

Bindable: true

result-matching ""

    No results matching ""