Element: <oj-swipe-actions>

Oracle® JavaScript Extension Toolkit (JET)
17.1.0
G12196-01

Since:
  • 5.1.0
Module:
  • ojswipeactions

QuickNav

Slots

Attributes

Events

Methods

Other Topics


JET SwipeActions Component

Description: SwipeActions can be added to an item in ListView to add swipe-to-reveal functionality when user swipes an item. The SwipeActions contains a start and/or an end slot, each represent the action bar to display when user swipes in a particular direction. The oj-option element is used to represent each item in the action bar. 


<oj-list-view>
  <template slot='itemTemplate'>
    <li class='oj-swipeactions-container'>
      <oj-swipe-actions on-oj-action='[[listener]]'>
        <-- Content of item goes to the default slot -->
        <span>Item content</span>
        <-- Display when user swipes from end to start of the item -->
        <template slot='end'>
          <oj-option>Action 1</oj-option>
          <oj-option class='oj-swipeactions-default'>Action 2</oj-option>
        </template>
      </oj-swipe-actions>
    </li>
  </template>
</oj-list-view>

Icon

SwipeActions currently supports the rendering of icon for each options. To render the icon, the startIcon slot of the oj-option should be specified. See the oj-option doc for details about accepted children and slots.

Accessibility

SwipeActions will display skip links that allow users to access swipe actions when the element has focus. This implies that when SwipeActions is a child of ListView, the skip links will become accessible when user hits the F2 key.

Although the swipe actions are accessible with the keyboard using skip links, it is recommended that applications provide an alternative way for the users to perform all the swipe actions.

Touch End User Information

Target Gesture Action
oj-swipeactions-container element Swipe Reveals the swipe actions. Depending on the distance relative to the target is swiped, the oj-swipe-actions will either be closed (swipe distance too short), opened, or the default action is performed (swipe distance passed a certain threshold).
oj-swipeactions-container element Pan Reveals the swipe actions. If a default action is specified, the default action will take over all the space of other action items after the user panned past a certain distance.
oj-swipe-action element Tap Triggers the action associated with the swipe action.

Keyboard End User Information

Target Key Action
ListView Item F2 If SwipeActions is a child of ListView, then pressing F2 key on the ListView item will focus on the SwipeActions, which cause it to display the show actions links for the start and end swipe actions.
Show actions link Enter Reveals the start/end swipe actions.
Hide actions link Enter Hides the start/end swipe actions.
Swipe action Enter Trigger the action associated with the swipe action.
Esc Hide the swipe actions.
Tab Navigate to the next swipe action. If it is the last swipe action, navigate to the hide actions link.


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

Get a single subproperty of a complex property:

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

Set a batch of properties:

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

Set a single subproperty of a complex property:

myComponent.setProperty('complexProperty.subProperty1.subProperty2', "someValue");