Global

Members

(constant) DRAG_SPEED

Metal drag
Source:

(constant) DROP_TARGET_BORDERS

Positions where elements can be dragged to
Source:

(constant) DROP_TARGET_ITEM_TYPES

Possible drop target types
Source:

(constant) LAYOUT_COLUMN_ITEM_DROPDOWN_ITEMS

Copyright (c) 2000-present Liferay, Inc. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
Source:

Methods

appendItemToColumn(sourceItem, layoutColumns, targetColumnIndex) → {Array.<object>}

Append an item to a column and returns a new array of columns
Parameters:
Name Type Description
sourceItem object
layoutColumns Array.<object>
targetColumnIndex number
Source:
Returns:
Type
Array.<object>

clearFollowingColumns(layoutColumns, startColumnIndex) → {object}

Removes following columns starting at position indicated by startColumnIndex and returns a new array of columns
Parameters:
Name Type Description
layoutColumns object
startColumnIndex number
Source:
Returns:
Type
object

clearPath(layoutColumns, sourceItem, sourceItemColumnIndex, targetItemPlid) → {object}

Clears path if an active item is moved to another column
Parameters:
Name Type Description
layoutColumns object
sourceItem object
sourceItemColumnIndex number
targetItemPlid string
Source:
Returns:
Type
object

columnIsItemChild(columnIndex, item, itemColumnIndex) → {boolean}

Parameters:
Name Type Description
columnIndex number
item object
itemColumnIndex number
Source:
Returns:
Returns whether a column is child of an item or not
Type
boolean

dropIsValid(layoutColumns, sourceItem, sourceItemColumnIndex, targetId, targetType) → {boolean}

Parameters:
Name Type Description
layoutColumns object
sourceItem object
sourceItemColumnIndex string
targetId string
targetType string
Source:
Returns:
Returns whether a drop is valid or not
Type
boolean

dropItemInsideColumn(layoutColumns, sourceItem, targetColumnIndex) → {object}

Append an item to a column and calculates newParentPlid and priority
Parameters:
Name Type Description
layoutColumns object
sourceItem object
targetColumnIndex number
Source:
Returns:
Type
object

dropItemInsideItem(layoutColumns, sourceItem, sourceItemColumnIndex, pathUpdated, targetItem) → {object}

Inserts an item inside another item's children and calculates new parent plid and priority
Parameters:
Name Type Description
layoutColumns object
sourceItem object
sourceItemColumnIndex number
pathUpdated bollean
targetItem object
Source:
Returns:
Type
object

dropItemNextToItem(layoutColumns, sourceItem, dropPosition, targetItem) → {object}

Insert an item next to another item and calculates new parent plid and priority
Parameters:
Name Type Description
layoutColumns object
sourceItem object
dropPosition string
targetItem object
Source:
Returns:
Type
object

getColumnActiveItem(layoutColumns, columnIndex) → {string}

Return the active item of a given column
Parameters:
Name Type Description
layoutColumns object
columnIndex number
Source:
Returns:
Type
string

getColumnLastItem(layoutColumns, columnIndex) → {object|undefined}

Get last item of a column
Parameters:
Name Type Description
layoutColumns Array.<object>
columnIndex number
Source:
Returns:
Returns last item or undefined if the column is empty
Type
object | undefined

getItemColumn(layoutColumns, itemPlid) → {Array.<object>|null}

Get the container column of an item
Parameters:
Name Type Description
layoutColumns Array.<object>
itemPlid string
Source:
Returns:
Type
Array.<object> | null

getItemColumnIndex(layoutColumns, itemPlid) → {number}

Return the index of an item's column
Parameters:
Name Type Description
layoutColumns Array.<object>
itemPlid string
Source:
Returns:
Type
number

itemIsParent(layoutColumns, childItemPlid, parentItemPlid) → {boolean}

Parameters:
Name Type Description
layoutColumns Array.<object>
childItemPlid string
parentItemPlid string
Source:
Returns:
Returns wheter an item is child of a given item
Type
boolean

moveItemInside(layoutColumns, pathUpdated, sourceItem, sourceItemColumnIndex, targetItem) → {object}

Insert an item inside another item's children and returns a new array of columns
Parameters:
Name Type Description
layoutColumns object
pathUpdated boolean
sourceItem object
sourceItemColumnIndex number
targetItem object
Source:
Returns:
Type
object

previewSeoFireChange()

Copyright (c) 2000-present Liferay, Inc. All rights reserved. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
Source:

removeItem(itemPlid, layoutColumns, targetItemPlid) → {Array.<object>}

Removes an item, if any, from a column and returns a new array of columns
Parameters:
Name Type Description
itemPlid string
layoutColumns Array.<object>
targetItemPlid string
Source:
Returns:
new column array
Type
Array.<object>

SelectLayout()

SelectLayout This component shows a list of available layouts to select in expanded tree and allows to filter them by searching.
Source:

setActiveItem(layoutColumns, itemPlid) → {object}

Set the item with the given plid as the active item of its column and returns a new layoutColumns
Parameters:
Name Type Description
layoutColumns object
itemPlid string
Source:
Returns:
Type
object

setIn(Original, Arraynon-null, value) → {Array|Object}

Recursively inserts a value inside an object creating a copy of the original target. It the object (or any in the path), it's an Array, it will generate new Arrays, preserving the same structure.
Parameters:
Name Type Description
Original Array | Object object that will be copied
Array Array.<string> of strings used for reaching the deep property
value * Value to be inserted
Source:
Returns:
Copy of the original object with the new value
Type
Array | Object