构造DOMTokenList/DOMSettableTokenList实例

Question

DOMTokenList和DOMSettableTokenList接口(MDN、WHATWG)提供了操作由空格分隔字符串表示的有序字符串标记集的方法。它们最常用的形式是Element.prototype.classList属性，这是一个反映关联元素的class属性的DOMTokenList。

​

var div = document.createElement('div');
div.setAttribute('class', 'hello world goodnight moon');

var list = div.classList;

console.assert(list.length           === 4);
console.assert(list[0]               === 'hello');
console.assert(list.item(1)          === 'world');
console.assert(list.contains('moon') === true);
console.assert(list.contains('mars') === false);

list.remove('world', 'earth', 'dirt', 'sand');
list.add('hello', 'mars');
list.toggle('goodnight');

console.assert(div.getAttribute('class') === 'hello moon mars');

​

我正在处理一个自定义元素(HTML5Rocks，W3C Draft)，它显示指定Stack Overflow用户的活动的实时提要。此用户列表在ids属性中指定，并且可以随时更新。

<so-users ids="1114 22656 106224"></so-users>

document.querySelector('so-users').setAttribute('ids', '23354 115866');

我不要求用户直接操作这个属性，而是希望有一个.ids属性来提供他们可以使用的DOMTokenList。理想情况下，这将直接与属性关联，但我必须手动绑定的未绑定DOMSettableTokenList实例也可以。

document.querySelector('so-users').ids.add('17174');

不幸的是，我一直无法找到创建DOMTokenList实例的任何方法。该定义不是构造函数，当我调用任何相关方法时，使用其原型直接创建对象会导致错误：

new DOMTokenList;         // TypeError: Illegal constructor
new DOMSettableTokenList; // TypeError: Illegal constructor

var list = Object.create(DOMSettableTokenList.prototype, {
  value: { value: 'hello world' }
});
console.assert(list instanceof DOMTokenList);
console.assert(list instanceof DOMSettableTokenList);
list.item(0); // TypeError: Illegal invocation

function TokenListConstructor() {
  this.value = 'hello world';
}
TokenListConstructor.prototype = DOMSettableTokenList.prototype;
var list = new TokenListConstructor;
console.assert(list instanceof DOMTokenList);
console.assert(list instanceof DOMSettableTokenList);
list.add('moon'); // TypeError: Illegal invocation

如何构造新的DOMTokenList或DOMSettableTokenList实例？

Answer 1

您不能直接创建DOMTokenList或DOMSettableTokenList。相反，您应该使用class属性来存储和检索数据，并可能将DOM元素的ids属性映射到classList属性。

    var element = document.querySelector('so-users');
    element.ids = element.classList;

你可以根据文档使用relList，但classList更受支持，唯一的缺点是如果你的一个ids与类名匹配，你可能会遇到问题，所以设置一个内联样式来隐藏元素，以防万一。

对于自定义组件，兼容性应该是一个问题( IE>=10、Firefox3.6、Chrome8、Opera11.5和Safari5.1中都有classList，请参阅http://caniuse.com/#feat=classlist)，所以如果兼容性符合您的要求，请使用下面发布的另一个解决方案。

如果您不能使用clases或classList，并且/或者必须使用ids属性，那么您应该根据规范实现一个自定义函数，并使用以下属性作为函数。

• item()
• contains()
• add()
• remove()
• toggle()

这是此类功能的一个示例实现。

var TokenList = function (ids) {
    'use strict';
    var idsArray = [],
        self = this,
        parse = function (id, functionName, cb) {
            var search = id.toString();
            if (search.split(' ').length > 1) {
                throw new Error("Failed to execute '" + functionName + "' on 'TokenList': The token provided ('" + search + "') contains HTML space characters, which are not valid in tokens.');");
            } else {
                cb(search);
            }
        };

    function triggerAttributeChange() {
        if (self.tokenChanged && typeof self.tokenChanged === 'function') {
            self.tokenChanged(idsArray.toString());
        }
    }

    if (ids && typeof ids === 'string') {
        idsArray = ids.split(' ');
    }
    self.item = function (index) {
        return idsArray[index];
    };

    self.contains = function (id) {
        parse(id, 'contains', function (search) {
            return idsArray.indexOf(search) !== -1;
        });
    };

    self.add = function (id) {
        parse(id, 'add', function (search) {
            if (idsArray.indexOf(search) === -1) {
                idsArray.push(search);
            }
            triggerAttributeChange();
        });
    };

    self.remove = function (id) {
        parse(id, 'remove', function (search) {
            idsArray = idsArray.filter(function (item) {
                return item !== id;
            });
            triggerAttributeChange();
        });
    };

    self.toggle = function (id) {
        parse(id, 'toggle', function (search) {
            if (!self.contains(search)) {
                self.add(search);
            } else {
                self.remove(search);
            }
        });
    };

    self.tokenChanged = null;

    self.toString = function () {
        var tokens = '',
            i;
        if (idsArray.length > 0) {
            for (i = 0; i < idsArray.length; i = i + 1) {
                tokens = tokens + idsArray[i] + ' ';
            }
            tokens = tokens.slice(0, tokens.length - 1);
        }
        return tokens;
    };
};

使用此函数的新实例在元素中设置“ids”属性，最后必须将目标属性绑定到该属性，侦听对元素的更改并更新属性。你可以用一个变异观察者来做到这一点。

请参阅firing event on DOM attribute change和https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver

var attachTokenList = function (element, prop, initialValues) {
    'use strict';
    var initValues = initialValues || element.getAttribute(prop),
        MutationObserver = window.MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver,
        observer,
        config,
        cancelMutation = false;

    function createTokenList(values) {
        var tList = new TokenList(values);
        tList.tokenChanged = function () {
            element.setAttribute(prop, element[prop].toString());
            cancelMutation = true;
        };
        element[prop] = tList;
    }

    createTokenList(initValues);

    observer = new MutationObserver(function (mutation) {
        var i,
            mutationrec,
            newAttr;
        if (mutation.length > 0 && !cancelMutation) {
            for (i = 0; i < mutation.length; i = i + 1) {
                mutationrec = mutation[i];
                if (mutationrec.attributeName === prop && element[prop]) {
                    newAttr = element.getAttribute(prop);
                    createTokenList(newAttr);
                }
            }
        }
        cancelMutation = false;
    });

    config = {
        attributes: true
    };
    observer.observe(element, config);
};

测试以查看它是否工作

<so-users ids="1234 5678"></so-users>
<button onclick="clickButton1()">Add 7890</button>
<button onclick="clickButton2()">Set to 3456</button>
<button onclick="clickButton3()">Add 9876</button>

在脚本标记内

var elem = document.querySelector('so-users');
attachTokenList(elem, 'ids')

function clickButton1 () {
    elem.ids.add('7890');
}

function clickButton2 () {
    elem.setAttribute('ids', '3456');
}

function clickButton3 () {
    elem.ids.add('9876');
}

按顺序单击按钮将ids属性设置为'3456 9876‘

Answer 2

利用Custom Elements - Adding JS properties and methods初始化方法HTMLElement.dataset ，尝试

​

var XFooProto = Object.create(HTMLElement.prototype);

// 1. Give x-foo a foo() method.
XFooProto.contains = function(id) {
  var data = JSON.parse(this.dataset.ids);
  return data.some(function(_id) {
    return id == _id
  })
};

XFooProto.add = function(id) {
  var data = JSON.parse(this.dataset.ids);
  if (!this.contains(id)) {
    data.push(id);
  };
  return data
};

XFooProto.remove = function(id) {
  var data = JSON.parse(this.dataset.ids);
  if (this.contains(id)) {
    for (var _id in data) {
      if (data[_id] === id) {
        data.splice(_id, 1)
      }
    };
  };
  return data
};

XFooProto.ids = function() {
  return this.dataset.ids
};

// 2. Define a property read-only "bar".
// Object.defineProperty(XFooProto, "ids", {value: this});

// 3. Register x-foo's definition.
var XFoo = document.registerElement('x-foo', {prototype: XFooProto});

// 4. Instantiate an x-foo.
var xfoo = document.createElement('x-foo');

xfoo.dataset.ids = '["23354", "115866"]';

// 5. Add it to the page.
document.body.appendChild(xfoo);

console.log(xfoo.add("123")); // `["23354", "115866", "123"]`

console.log(xfoo.remove("123")); // `["23354", "115866"]`

console.log(xfoo.contains("123")); // `false`

console.log(xfoo.contains("23354")); // `true`

console.log(xfoo.ids()); // `["23354", "115866"]` , type : `String`

var pre = document.getElementsByTagName("pre")[0]

pre.innerText = JSON.stringify(JSON.parse(xfoo.dataset.ids), null, 4);

<pre></pre>

​