property-information

Information for HTML properties.

Installation

npm:

npm install property-information

Usage

var info = require('property-information');

console.log(info('class'));

Yields:

{
  "name": "class",
  "propertyName": "className",
  "mustUseAttribute": true,
  "mustUseProperty": false,
  "boolean": false,
  "overloadedBoolean": false,
  "numeric": false,
  "positiveNumeric": false,
  "commaSeparated": false,
  "spaceSeparated": true
}

API

propertyInformation(name)

Get information for a DOM property by (case-insensitive) name.

Returns an Information object, if available.

propertyInformation.all

Object mapping case-insensitive names to Information objects. This gives raw access to the information returned by propertyInformation(): do not change the objects.

Information

Object:

• name (string) — Case-insensitive name
• propertyName (string) — Case-sensitive IDL attribute (e.g., a class attribute is added in HTML and a className is added in Web IDL)
• mustUseAttribute (boolean) — Whether setAttribute must be used when patching a DOM node
• mustUseProperty (boolean) — Whether node[propertyName] must be used when patching a DOM node
• boolean (boolean) — Whether the value of the property is boolean
• overloadedBoolean (boolean) — Whether the value of the property can be boolean
• numeric (boolean) — Whether the value of the property is number
• positiveNumeric (boolean) — Whether the value of the property is number and positive
• spaceSeparated (boolean) — Whether the value of the property is a space-separated list
• commaSeparated (boolean) — Whether the value of the property is a comma-separated list

Note that some values can be both *Separated and a primitive, in that case each of the tokens should be regarded as a primitive. For example, itemScope is both spaceSeparated and boolean:

{
  "name": "itemscope",
  "propertyName": "itemScope",
  "mustUseAttribute": true,
  "mustUseProperty": false,
  "boolean": true,
  "overloadedBoolean": false,
  "numeric": false,
  "positiveNumeric": false,
  "commaSeparated": false,
  "spaceSeparated": true
}

License

MIT © Titus Wormer

Derivative work based on React licensed under BSD-3-Clause-Clear, © 2013-2015, Facebook, Inc.