@egjs/list-differ

What is @egjs/list-differ?

@egjs/list-differ is a lightweight JavaScript library designed to efficiently compute the differences between two lists. It is particularly useful for applications that need to update the DOM or other data structures based on changes in a list, such as in virtual DOM implementations or state management libraries.

What are @egjs/list-differ's main functionalities?

Compute Differences Between Lists

This feature allows you to compute the differences between two lists. The `update` method returns an object that describes the changes needed to transform the old list into the new list.

const { ListDiffer } = require('@egjs/list-differ');

const oldList = ['a', 'b', 'c'];
const newList = ['b', 'c', 'd'];

const differ = new ListDiffer();
const result = differ.update(oldList, newList);

console.log(result);

Track Insertions and Deletions

This feature allows you to track which items have been added or removed from the list. The `added` and `removed` properties of the result object provide the indices of the added and removed items, respectively.

const { ListDiffer } = require('@egjs/list-differ');

const oldList = ['a', 'b', 'c'];
const newList = ['b', 'c', 'd'];

const differ = new ListDiffer();
const result = differ.update(oldList, newList);

console.log(result.added); // [2]
console.log(result.removed); // [0]

Track Moved Items

This feature allows you to track items that have been moved within the list. The `maintained` property of the result object provides the indices of the items that have been moved.

const { ListDiffer } = require('@egjs/list-differ');

const oldList = ['a', 'b', 'c'];
const newList = ['c', 'a', 'b'];

const differ = new ListDiffer();
const result = differ.update(oldList, newList);

console.log(result.maintained); // [2, 0, 1]

Other packages similar to @egjs/list-differ

diff

The 'diff' package provides a way to compute the differences between two sequences, including lists and strings. It offers a more general-purpose diffing algorithm compared to @egjs/list-differ, which is specifically optimized for list diffing.

fast-diff

The 'fast-diff' package is a lightweight library for computing the differences between two strings. While it is optimized for string diffing, it can also be adapted for list diffing, though it may not be as efficient as @egjs/list-differ for that specific use case.

deep-diff

The 'deep-diff' package allows you to compute the differences between two JavaScript objects, including nested structures. It is more versatile than @egjs/list-differ but may be overkill if you only need to diff flat lists.

README

list-differ

A module that detects when values are added, removed, or changed in an array or object.

Installation

$ npm i @egjs/list-differ

Components

• @egjs/children-differ
• @egjs/react-children-differ
• @egjs/ng-children-differ
• @egjs/vue-children-differ

How to use

Detect a change in array

import ListDiffer from "@egjs/list-differ";

// script => eg.ListDiffer
// Value is key
const differ = new ListDiffer([0, 1, 2, 3, 4, 5], e => e);
const result = differ.update([7, 8, 0, 4, 3, 6, 2, 1]);
// List before update
// [1, 2, 3, 4, 5]
console.log(result.prevList);
// Updated list
// [4, 3, 6, 2, 1]
console.log(result.data);
// Index array of values added to `list`
// [0, 1, 5]
console.log(result.added);
// Index array of values removed in `prevList`
// [5]
console.log(result.removed);
// Tuple arrays of index of `prevList` and `list` with different indexes from `prevList` and `list`
// [[0, 2], [4, 3], [3, 4], [2, 6], [1, 7]]
console.log(result.changed);
// Tuple arrays of index of `prevList` and `list` with different indexes from `prevList` and `list` before data is added
// [[4, 3], [3, 4], [2, 6]]
console.log(result.changedBeforeAdded);
// Tuple arrays of index of `prevList` and `list` with different indexes from `prevList` and `list` after data is added
// [[4, 3], [3, 4], [2, 6], [1, 7]]
console.log(result.changedAfterAdded);
// Tuple arrays of `prevIndex` and `nextIndex` to change the order of `prevList` to `list` before data is added.
// [[4, 1], [4, 2], [4, 3]]
console.log(result.orderedBeforeAdded);
// Tuple arrays of `prevIndex` and `nextIndex` to change the order of `prevList` to `list` after data is added
// [[7, 3], [7, 4], [6, 7], [5, 7]]
console.log(result.orderedAfterAdded);
// Tuple arrays of index of `prevList` and `list` that have not been added/removed so data is preserved
// [[0, 2], [4, 3], [3, 4], [2, 6], [1, 7]]
console.log(result.maintained);

Detect a change in children

<div id="container">
    <div>0</div>
    <div>1</div>
    <div>2</div>
    <div>3</div>
    <div>4</div>
    <div>5</div>
    <div>6</div>
</div>
<script>

import ListDiffer from "@egjs/list-differ";

// Value is key
const differ = new ListDiffer(conatiner.children);


container.removeChild(container.children[5]);
container.removeChild(container.children[2]);


const result = differ.update(container.children);
// [4, 2]
console.log(result.removed);
</script>

Bug Report

If you find a bug, please report to us opening a new Issues on GitHub.

License

egjs-list-differ is released under the MIT license.

Copyright (c) 2019-present NAVER Corp.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.