Skip to content

Latest commit

 

History

History

naming.entity.stringify

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
benchmark
benchmark
 
 
test
test
 
 
CHANGELOG.md
CHANGELOG.md
 
 
LICENSE.txt
LICENSE.txt
 
 
README.md
README.md
 
 
index.d.ts
index.d.ts
 
 
index.js
index.js
 
 
package.json
package.json
 
 

README.md

stringify

Stringifier for a BEM entity representation.

NPM Status

Introduction

Stringify returns a string with the name of the specified BEM entity representation. This name can be used in class attributes.

You can choose which naming convention to use for creating a stingify() function.

Note. If you don't have any BEM projects available to try out the @bem/sdk.naming.entity.stringify package, the quickest way to create one is to use bem-express.

Try stringify

An example is available in the RunKit editor.

Quick start

Attention. To use @bem/sdk.naming.entity.stringify, you must install Node.js 8.0+.

To run the @bem/sdk.naming.entity.stringify package:

  1. Install required packages.
  2. Create a stringify() function.
  3. Make a string from a BEM entity.

Installing required packages

Install the following packages:

To install the packages, run the following command:

$ npm install --save @bem/sdk.naming.entity.stringify @bem/sdk.naming.presets

Creating a stringify() function

Create a JavaScript file with any name (for example, app.js) and do the following:

  1. Choose the naming convention and import the preset with this convention (for example, origin naming convention).
  2. Import the @bem/sdk.naming.entity.stringify package and create the stringify() function using the imported preset:
const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.entity.stringify')(originNaming);

Creating a string from a BEM entity name

Stringify an object representation of a BEM entity:

stringify({ block: 'my-block', mod: 'my-modifier' });

This function will return the string my-block_my-modifier.

Example:

const originNaming = require('@bem/sdk.naming.presets/origin');
const stringify = require('@bem/sdk.naming.entity.stringify')(originNaming);

console.log(stringify({ block: 'my-block', mod: 'my-modifier' }));
// => my-block_my-modifier

console.log(stringify({ block: 'my-block', mod: { name: 'my-modifier'}}));
// => my-block_my-modifier

console.log(stringify({ block: 'my-block',
                        mod: { name: 'my-modifier', val: 'some-value'}}));
// => my-block__my-modifier_some-value

console.log(stringify({ block: 'my-block', elem: 'my-element' }));
// => my-block__my-element

console.log(stringify({ block: 'my-block',
                        elem: 'my-element',
                        mod: 'my-modifier'}));
// => my-block__my-element_my-modifier

console.log(stringify({ block: 'my-block',
                        elem: 'my-element',
                        mod: { name: 'my-modifier', val: 'some-value'}}));
// => my-block__my-element_my-modifier_some-value

RunKit live example.

API reference

stringify()

Forms a string based on the object representation of a BEM entity.

/**
 * @typedef BemEntityName
 * @property {string} block — Block name.
 * @property {string} [elem] — Element name.
 * @property {string|Object} [mod] — Modifier name or object with name and value.
 * @property {string} mod.name — Modifier name.
 * @property {string|boolean} [mod.val] — Modifier value.
 */

/**
 * @param {object|BemEntityName} entity — Object representation of the BEM entity.
 * @returns {string} — Name of the BEM entity. This name can be used in class attributes.
 */
stringify(entity);

Parameter tuning

Using a custom naming convention

Specify an INamingConvention object with the delims field, which defines the delimiters that are used to separate names in the naming convention.

Use this object to make your stringify() function.

Example:

const convention = {
    delims: {
        elem: '_EL-',
        mod: {
            name: '_MOD-',
            val: '-'
    }}};
const stringify = require('@bem/sdk.naming.entity.stringify')(convention);

console.log(stringify({ block: 'myBlock',
                        elem: 'myElement',
                        mod: 'myModifier'}));
// => myBlock_EL-myElement_MOD-myModifier

RunKit live example.