Element: <oj-list-item-layout>

Oracle® JavaScript Extension Toolkit (JET)
9.1.0
F30737-01

Signature:

class ojListItemLayout

QuickNav

Slots

Attributes

Methods

JET Custom Elements

JET components are implemented as custom HTML elements. In addition to the component attributes documented in this page, JET components also support standard HTML global attributes like id and aria-label.

The JET data binding syntax can be used to define both component and global attributes through the use of dynamically evaluated expressions. All attributes (component and global) support attribute-level binding by prefixing the attribute name with ":" (e.g. :id="[...]"). When using attribute-level binding, all expression values are treated as strings. Additionally, component attributes support property-level binding by using the attribute name directly with no ":" prefix. When using property-level binding, the expressions should evaluate to the types documented by the corresponding attributes. Property-level binding is strongly recommended over attribute-level binding for component attributes.

A detailed description of working with custom HTML elements can be found in: JET Custom Element Usage.


Version:
  • 9.1.0
Since:
  • 9.0.0
Module:
  • ojlistitemlayout

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To typecheck the element APIs, import as below.
import {ListItemLayoutElement} from "ojs/ojlistitemlayout";

//For the transpiled javascript to load the element's module, import as below
import "ojs/ojlistitemlayout";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.


JET ListItem Layout

Description: A JET ListItemLayout component helps application teams to easily layout their content into different slots.

//ListItemLayout with text
<oj-list-view id="listview1" aria-label="list layout within list view" data="[[dataProvider]]" style="width: 450px;"
                 selected="{{selectorSelectedItems}}" selection-mode="multiple">
   <template slot="itemTemplate" data-oj-as="item">
      <li>
         <oj-list-item-layout>
            <oj-selector slot='selector' selected-keys='{{selectorSelectedItems}}' key='[[item.data.id]]'>
            </oj-selector>
            <div>
               <oj-bind-text value="default">
            </div>
         </oj-list-item-layout>
      </li>
   </template>
</oj-list-view>

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.

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

The default slot accepts a default text.

Example
<oj-list-item-layout>
   <div>
      <oj-bind-text value="default">
   </div>
</oj-list-item-layout>

action

The action slot for adding either one primary action or one or more secondary actions.

Example
<oj-list-item-layout>
   <div slot="action">
      <oj-button>Edit
   </div>
</oj-list-item-layout>

leading

The leading slot is used for adding a leading visual next to the selector. Start slot can be an image, avatar or initials.

Example
<oj-list-item-layout>
   <oj-avatar slot='leading' role="img" size="xs" initials='[[item.data.initials]]'
                 src="[[item.data.image]]" :aria-label="[['Avatar of ' + item.data.name]]"
                 :title="[['Avatar of ' + item.data.name]]">
   </oj-avatar>
</oj-list-item-layout>

metadata

The metadata for adding extra trailing information. Examples of metadata are author, date etc.

Example
<oj-list-item-layout>
   <div slot="metadata">
      <oj-bind-text value="metadata">
   </div>
</oj-list-item-layout>

overline

The overline slot is for adding a overline text above the default text.

Example
<oj-list-item-layout>
   <div slot="overline">
      <oj-bind-text value="overline">
   </div>
</oj-list-item-layout>

secondary

The secondary slot is for adding a secondary text below the default text.

Example
<oj-list-item-layout>
   <div slot="secondary">
      <oj-bind-text value="secondary">
   </div>
</oj-list-item-layout>

selector

The selector slot can accept a oj-selector component and is optional.

Example
<oj-list-item-layout>
   <oj-selector slot='selector' selected-keys='{{selectorSelectedItems}}' key='[[item.data.id]]'>
   </oj-selector>
</oj-list-item-layout>

tertiary

The tertiary slot is for adding a tertiary text below the secondary text.

Example
<oj-list-item-layout>
   <div slot="tertiary">
      <oj-bind-text value="tertiary">
   </div>
</oj-list-item-layout>

trailing

The trailing slot is used for adding a trailing visual.

Example
<oj-list-item-layout>
   <oj-avatar slot='trailing' role="img" size="xs" initials='[[item.data.initials]]'
                 src="[[item.data.image]]" :aria-label="[['Avatar of ' + item.data.name]]"
                 :title="[['Avatar of ' + item.data.name]]">
   </oj-avatar>
</oj-list-item-layout>

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.
Returns:
Type
any

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.
Returns:
Type
void

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.
Returns:
Type
void