A PostHTML helper plugin that provides a better API for working with tag attributes.

Usage

1import posthtml from 'posthtml';
2import parseAttrs from 'posthtml-attrs-parser';
3
4posthtml()
5  .use(function (tree) {
6    const div = tree[0];
7    const attrs = parseAttrs(div.attrs);
8
9    attrs.style['font-size'] = '15px';
10    attrs.class.push('title-sub');
11
12    // Compose attributes back to PostHTML-compatible format
13    div.attrs = attrs.compose();
14  })
15  .process('<div class="title" style="font-size: 14px">Hello!</div>')
16  .then(function (result) {
17    console.log(result.html);
18  });
19
20// <div class="title title-sub" style="font-size: 15px">Hello!</div>

Both ESM and CJS exports are provided, you can use the plugin in CJS too:

1const posthtml = require('posthtml');
2const parseAttrs = require('posthtml-attrs-parser');
3
4// ...

Attributes

Only style and class attributes are parsed by default (as object and array, respectively). For other attributes, the parsing rules should be specified (see Custom parsing rule below).

Default attributes

style

1<div style="color: red; font-size: 14px; color: blue"></div>

1const attrs = parseAttrs(div.attrs);
2
3console.log(attrs.style);
4/*
5{
6  // If there are several properties with the same name,
7  // the values are packed in array
8  'color': ['red', 'blue'],
9  'font-size': '14px'
10}
11*/

class

1<div class="title title-sub"></div>

1const attrs = parseAttrs(div.attrs);
2
3console.log(attrs.class);
4// ['title', 'title-sub']

Custom parsing rule

You may also define the parsing rule for other attributes.

Array-like attribute

1<div data-ids="1  2 4 5   6"></div>

1const attrs = parseAttrs(div.attrs, {
2  rules: {
3  'data-ids': {
4    delimiter: /\s+/,
5    // Optional parameter for stringifying attribute's values
6    // If not set, glue = delimiter
7    glue: ' '
8  }
9}
10});
11
12console.log(attrs['data-ids']);
13// ['1', '2', '4', '5', '6']
14
15console.log(attrs.compose()['data-ids']);
16// 1 2 3 4 5 6

Object-like attribute

1<div data-config="TEST=1;ENV=debug;PATH=."></div>

1const attrs = parseAttrs(div.attrs, {
2  rules: {
3    'data-config': {
4      // Delimiter for key-value pairs
5      delimiter: ';',
6      // Delimiter for a key-value
7      keyDelimiter: '=',
8      // Optional parameter for stringifying key-value pairs
9      // If not set, keyGlue = keyDelimiter
10      glue: '; ',
11      // Optional parameter for stringifying a key-value
12      // If not set, glue = delimiter
13      keyGlue: ' = '
14    }
15  }
16});
17
18console.log(attrs['data-config']);
19// {TEST: '1', ENV: 'debug', PATH: '.'}
20
21console.log(attrs.compose()['data-config']);
22// TEST = 1; ENV = debug; PATH = .