1.0.0 • Published 6 years ago

@blinkmobile/html-class-data v1.0.0

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
6 years ago

html-class-data.js

encode / decode data stored in an HTML class attribute (like Angular)

npm module travis-ci

What is this?

It may be convenient to encode values within an HTML class attribute, just like the CSS syntax for Angular directives. We provide a helper function to decode such attributes.

API

We export an Object with the following function(s)...

decode()

  • @param {String} class contents of an HTML 'class' attribute
  • @returns {Object} key-value pairs of properties encoded in the string

The returned Object will always have a "class" property, with a String value containing any non-Setting content (i.e. actual CSS classes). We consider everything after the last semi-colon to be CSS classes.

If there is no semi-colon at all, then we treat the whole string as a normal CSS class. For example, cat dog becomes:

{
  "class": "cat dog"
}

Inspired by HTML attributes, we consider any Setting that does not have an explicit value to be a Boolean Setting, with a default true value.

For example, cat; dog becomes:

{
  "class": "dog",
  "cat": true
}

Use semi-colons to delimit Settings, and use colons to delimit Setting key-value pairs. We ignore spaces when parsing Settings.

For example, cats: rule; dogs: drool; becomes:

{
  "class": "",
  "cats": "rule",
  "dogs": "drool"
}

For multi-word Setting names, follow CSS conventions by using lower-case kebab-style. We convert this to camelCase automatically to follow JavaScript conventions.

For example, multi-word: value; becomes:

{
  "class": "",
  "multiWord": "value"
}
1.0.0

6 years ago