• Public
  • Public/Protected
  • All

The configuration for the Draggable widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.




Optional addClasses

addClasses?: boolean

Optional appendTo

appendTo?: any

Optional axis

axis?: string


behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

Optional cancel

cancel?: string

Optional classes

Optional connectToSortable

connectToSortable?: string | Element | JQuery<HTMLElement> | Element[]

Optional containment

containment?: any

Optional create

Optional cursor

cursor?: string

Optional cursorAt

cursorAt?: any

Optional delay

delay?: number

Optional disabled

disabled?: boolean

Optional distance

distance?: number

Optional drag

Optional formId

formId?: string

ID of the form to use for AJAX requests.

Optional grid

grid?: number[]

Optional handle

handle?: any

Optional helper

helper?: any


id: string | string[]

The client-side ID of the widget, with all parent naming containers, such as myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs multiple container elements (such as Paginator), this may also be an array if IDs.

Optional iframeFix

iframeFix?: any


Callback for when dragging starts.


Callback for when dragging ends.

Optional opacity

opacity?: number


postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).


postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.


preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g. when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

Optional refreshPositions

refreshPositions?: boolean

Optional revert

revert?: any

Optional revertDuration

revertDuration?: number

Optional scope

scope?: string

Optional scroll

scroll?: boolean

Optional scrollSensitivity

scrollSensitivity?: number

Optional scrollSpeed

scrollSpeed?: number

Optional snap

snap?: any

Optional snapMode

snapMode?: string

Optional snapTolerance

snapTolerance?: number

Optional stack

stack?: string

Optional start

Optional stop


target: string

ID of the target of this draggable.


widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Optional zIndex

zIndex?: number

Generated using TypeDoc