Methods

On this page

Method call

From internal components

To call a method of a component from a button or other object placed inside the component to be controlled, specify method name=component to be controlled.

vue

From external components

To call a method of a controlled component from a button or other object placed outside of the controlled component

Set the ID to the component to be controlled, and specify target=#{id} and method name=target component for buttons, etc.

vue

Scripts

To make method calls on the controlled component by Sciript, use the
ref.

vue

Components

Accordion Item

MethodDescription
toggle Switch manually
show Open manually
hide Manually hide

Alert

MethodDescription
toggle Manual switching
show Manually show
hide Manually hide

Carousel

MethodDescription
cycle Circulate items from left to right
pause Stop circulating items
prev Circulate to previous item
next Circulate to next item
to Circulate to specific items

Collapse

MethodDescription
toggle Toggles a collapsible element to shown or hidden. Returns to the caller before the collapsible element has actually been shown or hidden
show Shows a collapsible element. Returns to the caller before the collapsible element has actually been shown
hide Hides a collapsible element. Returns to the caller before the collapsible element has actually been hidden

Dropdowns

MethodDescription
toggle Toggles a collapsible element to shown or hidden. Returns to the caller before the collapsible element has actually been shown or hidden
show Shows a collapsible element. Returns to the caller before the collapsible element has actually been shown
hide Hides a collapsible element. Returns to the caller before the collapsible element has actually been hidden

Modal

MethodDescription
toggle Manually switch the modal
show Manually open the modal
hide Manually hide the modal

Offcanvas

MethodDescription
toggle Toggles a collapsible element to shown or hidden. Returns to the caller before the collapsible element has actually been shown or hidden
show Shows a collapsible element. Returns to the caller before the collapsible element has actually been shown
hide Hides a collapsible element. Returns to the caller before the collapsible element has actually been hidden
On this page