-
Notifications
You must be signed in to change notification settings - Fork 31
/
README.md
660 lines (477 loc) · 16.6 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
BH [![NPM version](https://badge.fury.io/js/bh.svg)](http://badge.fury.io/js/bh) [![Build Status](https://travis-ci.org/bem/bh.svg?branch=master)](https://travis-ci.org/bem/bh) [![Dependency Status](https://gemnasium.com/bem/bh.svg)](https://gemnasium.com/bem/bh) [![Coverage Status](https://img.shields.io/coveralls/bem/bh.svg?branch=master)](https://coveralls.io/r/bem/bh)
===
## What is this?
BH is processor that converts BEMJSON to HTML. Or in other words a template engine.
[Online demo](//bem.github.io/bh/).
## Advantages
BH is:
1. fast;
2. easy to debug due to no need of compilation to another code;
3. based on JavaScript (usage and extensions);
4. easy to understand – it is a wrapper over a regular conversion of source BEMJSON to output BEMJSON / HTML;
5. compact on client side (12.4 Kb after compression, 3.7 Kb after gzip);
6. does not require a compilation.
## Install
You can find BH processor within `bh` npm package. ENB technologies for its usage are available in `enb-bh` npm package.
```
npm install bh
```
## Usage
BH files within a project have `bh.js` suffix (for example, `page.bh.js`). The file is formed in CommonJS format for NodeJS:
```javascript
module.exports = function(bh) {
// ...
};
```
Use `apply` method to convert source tree of BEMJSON into an output HTML.
Use `processBemJson` method to get an interim result in detailed BEMJSON tree form.
Use `toHtml` method to get an output HTML without BEMJSON tree transform.
Common use case:
```javascript
var bh = new (require('bh').BH);
bh.match('button', function(ctx) {
ctx.tag('button');
})
bh.processBemJson({ block: 'button' }); // { block: 'button', mods: {}, tag: 'button' }
bh.apply({ block: 'button' }); // '<button class="button"></button>'
bh.toHtml({ block: 'button' }); // '<div class="button"></div>'
```
## Conversion
Working functions for BEMJSON are **templates**. Use `match` method to declare templates. Logic of BEMJSON conversion is declared in a function body.
There are two arguments provided to a template function:
* `ctx` – instance of `Ctx` class;
* `json` – link to a current BEMJSON tree node.
*N.B.* Do not make changes directly in `json` object. Use methods of `ctx` object instead. We recommend you to use `json` object for reading only (see also `ctx.json()` method).
Syntax:
```javascript
{BH} bh.match({String} expression, function({Ctx} ctx, {Object} json) {
//.. actions
});
```
You could also declare several templates within one call of `match` method.
Syntax:
```javascript
{BH} bh.match({Array} expressions, function({Ctx} ctx));
```
Where `expressions` is an array like this:
```javascript
[
{String} expression1,
...,
{String} expressionN
]
```
Or in an object form:
```javascript
{BH} bh.match({Object} templates);
```
Where `templates` is an object like this:
```javascript
{
{String} expression1 : function({Ctx} ctx) {
//.. actions1
},
...,
{String} expressionN : function({Ctx} ctx) {
//.. actionsN
},
}
```
You can find below a list of `Ctx` class methods. Let's check examples for step-by-step explanation.
For instance, to declare `button` tag for `button` block and `input` tag for `input` block do the following:
```javascript
bh.match('button', function(ctx) {
ctx.tag('button');
});
bh.match('input', function(ctx) {
ctx.tag('input');
});
```
Now we are going to create a pseudo button that looks like a button and acts like a link. If `pseudo` modifier of the button is set to `true`, you need to add tag `a` and attribute `role="button"` to your template.
```javascript
bh.match('button_pseudo_yes', function(ctx) {
ctx
.tag('a')
.attr('role', 'button');
});
```
In this example, we do not match just to `button` block. We match to `button` block with modifier `pseudo` that has `yes` value.
## Matching
Let's go into details of syntax of a matching string for conversion functions (optional parameters are set in square brackets):
```javascript
'block[_blockModName[_blockModVal]][__elemName][_elemModName[_elemModVal]]'
```
## Setting up
The `setOptions` method allows you to set the template engine parameters.
### jsAttrName
`jsAttrName` allows you to set the attribute name to store the `js` field. Default value is `onclick`.
```javascript
bh.setOptions({ jsAttrName: 'data-bem' });
bh.apply({ block: 'button', js: true });
```
```html
<div class="button i-bem" data-bem='return {"button":{}}'></div>
```
### jsAttrScheme
The data store format in the attribute. Default value is `js`.
```javascript
bh.setOptions({ jsAttrScheme: 'json' });
bh.apply({ block: 'button', js: { foo: bar } });
```
```html
<div class="button i-bem" onclick='{"button":{"foo":"bar"}}'></div>
```
### jsCls
The name of additional class for nodes with `js`. Default value is `i-bem`. If you set the `false` value, the additional class will not be added.
```javascript
bh.setOptions({ jsCls: false });
bh.apply({ block: 'button', js: true });
```
```html
<div class="button" onclick='{"button":{}}'></div>
```
### jsElem
`jsElem` controls the set up of an additional class of the [jsCls](https://github.com/bem/bh/blob/master/README.md#jscls) parameter for elements with `js`. Default value is `true`. If you set the `false` value, the additional class will not be added.
```javascript
bh.setOptions({ jsElem: false });
bh.apply({ block: 'button', elem: 'box', js: true });
```
```html
<div class="button__box" onclick='return {"button__box":{}}'></div>
```
### escapeContent
`escapeContent` turns on content escaping. Option is turned off by default.
```javascript
bh.setOptions({ escapeContent: true });
bh.apply({ content: '<script>' });
```
```html
<div><script></div>
```
### clsNobaseMods
`clsNobaseMods` removes the block or element name from the modifier names in the class. Default value is `false`.
```javascript
bh.setOptions({ clsNobaseMods: true });
bh.apply({
block: 'button',
mods: { disabled: true, theme: 'new' },
mix: [
{ block: 'clearfix' },
{ elem: 'box', elemMods: { pick: 'left' } }
],
content: {
elem: 'control',
elemMods: { disabled: true }
}
});
```
```html
<div class="button _disabled _theme_new clearfix button__box _pick_left">
<div class="button__control _disabled"></div>
</div>
```
### delimElem
Defines the delimiter between block and element names. Default value is `__`.
```javascript
bh.setOptions({ delimElem: '_' });
bh.apply({ block: 'button', elem: 'text' });
```
```html
<div class="button_text"></div>
```
### delimMod
Defines the delimiter between block or element and they modifier. Default value is `_`.
```javascript
bh.setOptions({ delimMod: '--' });
bh.apply({ block: 'button', mods: { disabled: true } });
```
```html
<div class="button button--disabled"></div>
```
### shortTags
`shortTags` extend default short tag list.
```javascript
bh.setOptions({ shortTags: ['rect'] });
```
## Additional examples
For example, if you want to set `state` modifier with `closed` value for all blocks do the following:
```javascript
bh.match('popup', function(ctx) {
ctx.mod('state', 'closed');
});
```
Mix `form` with `search-form`:
```javascript
bh.match('search-form', function(ctx) {
ctx.mix({ block: 'form' });
});
```
Specify a class for `page` block:
```javascript
bh.match('page', function(ctx) {
ctx.cls('ua_js_no ua_css_standard');
});
```
## BEMJSON-tree conversion
In addition to element modification, converter function can return a new BEMJSON. For this, we will use following methods:
* `ctx.json()` that returns a current element “as is”;
* `ctx.content()` that returns and sets a content.
For example, let's wrap `header` block with `header-wrapper` block:
```javascript
bh.match('header', function(ctx) {
return {
block: 'header-wrapper',
content: ctx.json()
};
});
```
*N.B.* Any non-undefined value will replace current node in BEMJSON tree. So you can delete current node just returning `null` value.
Then wrap a content of `button` block with `content` element:
```javascript
bh.match('button', function(ctx) {
ctx.content({
elem: 'content',
content: ctx.content()
}, true);
});
```
`ctx.content` method gets BEMJSON as first argument that should be specified for a content. The second argument is a `force` flag that specifies a content even if it already exists.
Let's add following elements to `header` block:
* `before` element in the very beginning of the block content;
* `after` elemtnet in the end of the block content.
```javascript
bh.match('header', function(ctx) {
ctx.content([
{ elem: 'before' },
ctx.content(),
{ elem: 'after' }
], true);
});
```
Add `before-button` block before `button` block:
```javascript
bh.match('button', function(ctx) {
return [
{ block: 'before-button' },
ctx.json()
];
});
```
## Infinite loop detection
The `enableInfiniteLoopDetection` method allows you to enable or disable the infinite loop detection process.
*N.B.* Enable the infinite loop detection in debugging mode only, because it slows down a template engine application.
```javascript
bh.enableInfiniteLoopDetection(true);
bh.match('button', function(ctx) {
ctx.content({ block: 'button' });
});
```
```
Error: Infinite matcher loop detected at "button".
```
# `Ctx` class
`Ctx` class instances are passed to all templates. All class methods in a set mode return the class instance.
## ctx.process(bemJson)
This class method applies templates for given BEMJSON tree in the current context. It returns the processed BEMJSON.
```javascript
bh.match('button', function(ctx) {
bh.toHtml(ctx.process({ elem: 'control' }));
});
```
## ctx.tag([value[, force]])
This class method returns/sets a tag depending on arguments. Use **force** to set the tag value even if it was specified earlier.
```javascript
bh.match('input', function(ctx) {
ctx.tag('input');
});
```
*N.B.* If you set a value as `false` or as an empty string, the template will not put the current node to output HTML. The template will put only the content of this node if it exists.
## ctx.mod(key[, value[, force]])
This class method returns/sets a modifier depending on arguments. Use **force** to set the modifier even if it was specified earlier.
```javascript
bh.match('input', function(ctx) {
ctx.mod('native', 'yes');
ctx.mod('disabled', true);
});
bh.match('input_islands_yes', function(ctx) {
ctx.mod('native', '', true);
ctx.mod('disabled', false, true);
});
```
## ctx.mods([values[, force]])
This class method returns/sets modifiers depending on arguments. Use **force** to set the modifiers even if they were specified earlier.
```javascript
bh.match('paranja', function(ctx) {
ctx.mods({
theme: 'normal',
disabled: true
});
});
```
## ctx.attr(key[, value[, force]])
This class method returns/sets an attribute depending on arguments. Use **force** to set the attribute even if it was specified earlier.
```javascript
bh.match('input_disabled_yes', function(ctx) {
ctx.attr('disabled', 'disabled');
});
```
*N.B.* If an attribute is needed to be deleted and not nulled in its value, you have to pass `null` as a second parameter:
```javascript
bh.match('link', function(ctx) {
ctx.attr('href', null);
});
```
*N.B.* Pass `true` as a second parameter to set a boolean attribute:
```javascript
bh.match('link_hidden_yes', function(ctx) {
ctx.attr('hidden', true);
});
```
## ctx.attrs([values[, force]])
This class method returns/sets attributes depending on arguments. Use **force** to set the attributes even if they were specified earlier.
```javascript
bh.match('input', function(ctx) {
ctx.attrs({
name: ctx.param('name'),
autocomplete: 'off'
});
});
```
## ctx.mix([value[, force]])
This class method returns/sets a mix value depending on arguments.
Use **force** to set the attribute even if it was specified earlier.
If **force** has `true` value, the specified mix replaces the previous value, otherwise the both mixes are added.
```javascript
bh.match('button_pseudo_yes', function(ctx) {
ctx.mix({ block: 'link', mods: { pseudo: 'yes' } });
ctx.mix([
{ elem: 'text' },
{ block: 'ajax' }
]);
});
```
## ctx.bem([value[, force]])
This class method returns/sets `bem` value depending on arguments. Use **force** to set the `bem` value even if it was specified earlier.
If `bem` has `false` value, any BEM classes will not be generated for an element.
```javascript
bh.match('meta', function(ctx) {
ctx.bem(false);
});
```
## ctx.js([value[, force]])
This class method returns/sets `js` value depending on arguments. Use **force** to set the `js` value even if it was specified earlier.
Use `js` value for blocks initialization in browser by `BEM.DOM.init()`.
```javascript
bh.match('input', function(ctx) {
ctx.js(true);
});
```
## ctx.cls([value[, force]])
This class method returns/sets CSS class additional value depending on arguments. Use **force** to set the `cls` value even if it was specified earlier.
```javascript
bh.match('field_type_email', function(ctx) {
ctx.cls('validate');
});
```
```html
<div class="field field_type_email validate"></div>
```
## ctx.content([value[, force]])
This class method returns/sets a content depending on arguments. Use **force** to set the content even if it was specified earlier.
```javascript
bh.match('input', function(ctx) {
ctx.content({ elem: 'control' });
});
```
## ctx.json()
Returns the current section of BEMJSON tree. You could use this class method with `return` method for wrapping. For brevity, you can use the second argument of the template function – `json`.
*N.B.* The call of `ctx.applyBase()` function breaks the chain of consistent templates application. This causes the case when `json` stops to point out the current node in BEMJSON tree. To avoid this you must use `ctx.json()` method.
```javascript
bh.match('input', function(ctx, json) {
return {
elem: 'wrapper',
attrs: { name: json.name },
content: ctx.json()
};
});
```
## ctx.position()
**ctx.position()** returns the position of the current BEMJSON element within parental element.
See example for `ctx.position()`, `ctx.isFirst()` and `ctx.isLast()` below.
## ctx.isFirst()
**ctx.isFirst()** returns `true` if the current BEMJSON element is the first within the parental BEMJSON element.
See example for `ctx.position()`, `ctx.isFirst()` and `ctx.isLast()` below.
## ctx.isLast()
**ctx.isLast()** returns `true` if the current BEMJSON element is the last within the parental BEMJSON element.
Example for `ctx.position()`, `ctx.isFirst()` and `ctx.isLast()`:
```javascript
bh.match('list__item', function(ctx) {
ctx.mod('pos', ctx.position());
if (ctx.isFirst()) {
ctx.mod('first', 'yes');
}
if (ctx.isLast()) {
ctx.mod('last', 'yes');
}
});
```
## ctx.isSimple()
Verifies that object is a primitive.
```javascript
bh.match('link', function(ctx) {
ctx.tag(ctx.isSimple(ctx.content()) ? 'span' : 'div');
});
```
## ctx.extend()
This class method is analogue of `extend` function in jQuery.
## ctx.applyBase()
This class method converts the BEMJSON element by another templates. For example, it could be used to add the element in the end of the content after all other elements that are added in the end by base templates.
For example:
```javascript
bh.match('header', function(ctx) {
ctx.content([
ctx.content(),
{ elem: 'under' }
], true);
});
bh.match('header_float_yes', function(ctx) {
ctx.applyBase();
ctx.content([
ctx.content(),
{ elem: 'clear' }
], true);
});
```
## ctx.stop()
This class method stops application of other templates for BEMJSON element.
For example:
```javascript
bh.match('button', function(ctx) {
ctx.tag('button', true);
});
bh.match('button', function(ctx) {
ctx.tag('span');
ctx.stop();
});
```
## ctx.generateId()
This class method returns the unique identifier. For example, you can use it to set the correspondence between `label` and` input`.
## ctx.param(key[, value[, force]])
This class method returns/sets parameter of the current BEMJSON element. Use **force** to set the parameter value even if it was specified earlier.
For example:
```javascript
bh.match('search', function(ctx) {
ctx.attr('action', ctx.param('action') || '/');
});
```
## ctx.tParam(key[, value[, force]])
This class method get / passes a parameter into BEMJSON tree. Use **force** to set the parameter value even if it was specified earlier.
```javascript
bh.match('input', function(ctx) {
ctx.content({ elem: 'control' });
ctx.tParam('value', ctx.param('value'));
});
bh.match('input__control', function(ctx) {
ctx.attr('value', ctx.tParam('value'));
});
```