Usage
Signature:
interface SwipeActionsElement
Typescript Import Format
//To typecheck the element APIs, import as below.
import { SwipeActionsElement } from "ojs/ojswipeactions";
//For the transpiled javascript to load the element's module, import as below
import "ojs/ojswipeactions";
For additional information visit:
Note: Application logic should not interact with the component's properties or invoke its methods until the BusyContext indicates that the component is ready for interaction.
Styling Classes
-
.oj-swipeactions-container
-
Designed for use with item in oj-list-view that contains the oj-swipe-actions element, specifically this will remove the padding around the content of the item so that the swipe actions can take the full height.
Is applied to the root of each item in oj-list-view containing the oj-swipe-actions element. -
Category: Swipe Action Items
-
Designed to tag swipe action items within an oj-list-view.
Class template:
-
.oj-swipeactions-
[swipe-option]
Note: Square brackets signify required token substitutions whereas parentheses signify optional token substitutions.
-
Values for
[swipe-option]
Value (required) Name Description neutral
Show more available actions Designed for use with an action item that shows more available actions that users can perform. attention
Tag the associated item Designed for use with an action item that tags the associated item in oj-list-view danger
Perform an explicit action Designed for use with an action item that performs an explicit action like deleting the associated item in oj-list-view. default
Default action Designed for use with an action item that should get all the space when user swipes pass the threshold distance. This is usually the last item within the template
-
Slots
JET components that allow child content support slots. Please see the slots section of the JET component overview doc for more information on allowed slot content and slot types.
-
Default
-
When using SwipeActions within ListView, any content for the item in ListView should be added as child element in SwipeActions.
-
contextMenu
-
The contextMenu slot is set on the
oj-menu
within this element. This is used to designate the JET Menu that this component should launch as a context menu on right-click, Shift-F10, Press & Hold, or component-specific gesture. If specified, the browser's native context menu will be replaced by the JET Menu specified in this slot.The application can register a listener for the Menu's ojBeforeOpen event. The listener can cancel the launch via event.preventDefault(), or it can customize the menu contents by editing the menu DOM directly, and then calling refresh() on the Menu.
To help determine whether it's appropriate to cancel the launch or customize the menu, the ojBeforeOpen listener can use component API's to determine which table cell, chart item, etc., is the target of the context menu. See the JSDoc of the individual components for details.
Keep in mind that any such logic must work whether the context menu was launched via right-click, Shift-F10, Press & Hold, or component-specific touch gesture.
- Deprecated:
-
Since Description 13.0.0
This web component no longer supports launching a context menu.
-
end
-
The
end
slot is used to specify the action bar options that appear when user swipes from end to start on its container. The slot content must be a <template> element.When the template is executed, it will have access to the parent binding context. For example, in the case of ListView, $current should return the data of the row containing the swipe actions.
-
start
-
The
start
slot is used to specify the action bar options that appear when user swipes from start to end on its container. The slot content must be a <template> element.When the template is executed, it will have access to the parent binding context. For example, in the case of ListView, $current should return the data of the row containing the swipe actions.
Attributes
-
translations :object|null
-
A collection of translated resources from the translation bundle, or
null
if this component has no resources. Resources may be accessed and overridden individually or collectively, as seen in the examples.If the component does not contain any translatable resource, the default value of this attribute will be
null
. If not, an object containing all resources relevant to the component.If this component has translations, their documentation immediately follows this doc entry.
Names
Item Name Property translations
Property change event translationsChanged
Property change listener attribute (must be of type function, see Events and Listeners for additional information.) on-translations-changed
-
(nullable) translations.aria-hide-actions-description :string
-
Label assigned to an anchor tag used for hidding start/end swipe actions using keyboard or accessibility agents such as VoiceOver.
- Default Value:
"Hide actions"
- Since:
- 5.1.0
Names
Item Name Property translations.ariaHideActionsDescription
-
(nullable) translations.aria-show-end-actions-description :string
-
Label assigned to an anchor tag used for showing end swipe actions using keyboard or accessibility agents such as VoiceOver.
- Default Value:
"Show end actions"
- Since:
- 5.1.0
Names
Item Name Property translations.ariaShowEndActionsDescription
-
(nullable) translations.aria-show-start-actions-description :string
-
Label assigned to an anchor tag used for showing start swipe actions using keyboard or accessibility agents such as VoiceOver.
- Default Value:
"Show start actions"
- Since:
- 5.1.0
Names
Item Name Property translations.ariaShowStartActionsDescription
Events
-
ojAction
-
Triggered when an action item is selected or when the default action is triggered.
See Events and Listeners for additional information.
Methods
-
getProperty(property) : {any}
-
Retrieves the value of a property or a subproperty. The return type will be the same as the type of the property as specified in this API document. If the method is invoked with an incorrect property/subproperty name, it returns undefined.
Parameters:
Name Type Description property
string The property name to get. Supports dot notation for subproperty access. - Since:
- 4.0.0
Returns:
- Type
- any
Example
let subpropValue = myComponent.getProperty('complexProperty.subProperty1.subProperty2');
-
refresh : {void}
-
Re-initialize the swipe actions after having made some external modifications.
This method does not accept any arguments.
Returns:
- Type
- void
-
setProperties(properties) : {void}
-
Performs a batch set of properties. The type of value for each property being set must match the type of the property as specified in this API document.
Parameters:
Name Type Description properties
Object An object containing the property and value pairs to set. - Since:
- 4.0.0
Returns:
- Type
- void
Example
myComponent.setProperties({"prop1": "value1", "prop2.subprop": "value2", "prop3": "value3"});
-
setProperty(property, value) : {void}
-
Sets a property or a subproperty (of a complex property) and notifies the component of the change, triggering a [property]Changed event. The value should be of the same type as the type of the attribute mentioned in this API document.
Parameters:
Name Type Description property
string The property name to set. Supports dot notation for subproperty access. value
any The new value to set the property to. - Since:
- 4.0.0
Returns:
- Type
- void
Example
myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");