Element: <oj-swipe-actions>

Slots

JET elements can have up to two types of child content:

• Any child element with a slot attribute will be moved into that named slot, e.g. <span slot='startIcon'>...</span>. All supported named slots are documented below. Child elements with unsupported named slots will be removed from the DOM.
• Any child element lacking a slot attribute will be moved to the default slot, also known as a regular child. This is documented under the "Default" heading below.

Default

When using SwipeActions within ListView, any content for the item in ListView should be added as child element in SwipeActions.

Example

Initialize the SwipeActions to display some text inside the item of ListView:

<oj-list-view>
  <template slot='itemTemplate'>
    <oj-swipe-actions>
      <span>Item content</span>
    </oj-swipe-actions>
  </template>
</oj-list-view>

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 and demos 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.

Example

Initialize the component with a context menu:

<oj-some-element>
    <-- use the contextMenu slot to designate this as the context menu for this component -->
    <oj-menu slot="contextMenu" style="display:none" aria-label="Some element's context menu">
...
    </oj-menu>
</oj-some-element>

end

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

The end slot is used to specify the action bar that appears when user swipes from end to start on its container. The slot 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.

Example

Initialize the SwipeActions with a set of options that appears when user swipes from end to start:

<oj-swipe-actions>
  <template slot='end'>
    <oj-option value='action1'>Action 1</oj-option>
    <oj-option value='action2'>Action 2</oj-option>
  <template>
</oj-swipe-actions>

start

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

The start slot is used to specify the options to appears when user swipes from start to end on its container. The slot 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.

Example

Initialize the SwipeActions with a set of options that appears when user swipes from start to end:

<oj-swipe-actions>
  <template slot='start'>
    <oj-option value='action1'>Action 1</oj-option>
    <oj-option value='action2'>Action 2</oj-option>
  <template>
</oj-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)	on-translations-changed

Examples

Initialize the component, overriding some translated resources and leaving the others intact:

<!-- Using dot notation -->
<oj-some-element translations.some-key='some value' translations.some-other-key='some other value'></oj-some-element>

<!-- Using JSON notation -->
<oj-some-element translations='{"someKey":"some value", "someOtherKey":"some other value"}'></oj-some-element>

Get or set the translations property after initialization:

// Get one
var value = myComponent.translations.someKey;

// Set one, leaving the others intact. Always use the setProperty API for 
// subproperties rather than setting a subproperty directly.
myComponent.setProperty('translations.someKey', 'some value');

// Get all
var values = myComponent.translations;

// Set all.  Must list every resource key, as those not listed are lost.
myComponent.translations = {
    someKey: 'some value',
    someOtherKey: 'some other value'
};

(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.

Examples

Specify an ojAction listener via the DOM attribute:

<oj-swipe-actions on-oj-action='[[listener]]'></oj-swipe-actions>

Specify an ojAction listener via the JavaScript property:

mySwipeActions.onOjAction = listener;

Add an ojAction listener via the addEventListener API:

mySwipeActions.addEventListener('ojAction', listener);

Methods

getProperty(property) → {any}

Retrieves a value for a property or a single subproperty for complex properties.

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:

var 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

Example

Invoke the refresh method:

mySwipeActions.refresh();

setProperties(properties) → {void}

Performs a batch set of properties.

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 single subproperty for complex properties and notifies the component of the change, triggering a [property]Changed event.

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");