@@ -24,14 +24,14 @@ Install
24
24
-------
25
25
26
26
```
27
- $ npm install --save bem- entity-name
27
+ $ npm install --save @ bem/ entity-name
28
28
```
29
29
30
30
Usage
31
31
-----
32
32
33
33
``` js
34
- const BemEntityName = require (' bem- entity-name' );
34
+ const BemEntityName = require (' @ bem/ entity-name' );
35
35
36
36
const entityName = new BemEntityName ({ block: ' button' , elem: ' text' });
37
37
@@ -60,7 +60,7 @@ The modifier consists of a pair of fields `mod.name` and `mod.val`. This means t
60
60
** Example:**
61
61
62
62
``` js
63
- const BemEntityName = require (' bem- entity-name' );
63
+ const BemEntityName = require (' @ bem/ entity-name' );
64
64
65
65
// The modifier of block
66
66
new BemEntityName ({
@@ -120,7 +120,7 @@ Parameter | Type | Description
120
120
The name of block to which this entity belongs.
121
121
122
122
``` js
123
- const BemEntityName = require (' bem- entity-name' );
123
+ const BemEntityName = require (' @ bem/ entity-name' );
124
124
const name = new BemEntityName ({ block: ' button' });
125
125
126
126
name .block ; // button
@@ -133,7 +133,7 @@ The element name of this entity.
133
133
If entity is not element or modifier of element then returns empty string.
134
134
135
135
``` js
136
- const BemEntityName = require (' bem- entity-name' );
136
+ const BemEntityName = require (' @ bem/ entity-name' );
137
137
const name = new BemEntityName ({ block: ' button' , elem: ' text' });
138
138
139
139
name .elem ; // text
@@ -146,7 +146,7 @@ The modifier of this entity.
146
146
** Important:** If entity is not a modifier then returns ` undefined ` .
147
147
148
148
``` js
149
- const BemEntityName = require (' bem- entity-name' );
149
+ const BemEntityName = require (' @ bem/ entity-name' );
150
150
151
151
const blockName = new BemEntityName ({ block: ' button' });
152
152
const modName = new BemEntityName ({ block: ' button' , mod: ' disabled' });
@@ -164,7 +164,7 @@ The id for this entity.
164
164
If you want to get string representation in accordance with the provisions naming convention you should use [ bem-naming] ( https://github.com/bem-sdk/bem-naming ) package.
165
165
166
166
``` js
167
- const BemEntityName = require (' bem- entity-name' );
167
+ const BemEntityName = require (' @ bem/ entity-name' );
168
168
const name = new BemEntityName ({ block: ' button' , mod: ' disabled' });
169
169
170
170
name .id ; // button_disabled
@@ -177,7 +177,7 @@ The type for this entity.
177
177
Possible values: ` block ` , ` elem ` , ` blockMod ` , ` elemMod ` .
178
178
179
179
``` js
180
- const BemEntityName = require (' bem- entity-name' );
180
+ const BemEntityName = require (' @ bem/ entity-name' );
181
181
182
182
const elemName = new BemEntityName ({ block: ' button' , elem: ' text' });
183
183
const modName = new BemEntityName ({ block: ' menu' , elem: ' item' , mod: ' current' });
@@ -196,7 +196,7 @@ Parameter | Type | Description
196
196
Determines whether specified entity is the deepEqual entity.
197
197
198
198
``` js
199
- const BemEntityName = require (' bem- entity-name' );
199
+ const BemEntityName = require (' @ bem/ entity-name' );
200
200
201
201
const inputName = new BemEntityName ({ block: ' input' });
202
202
const buttonName = new BemEntityName ({ block: ' button' });
@@ -213,7 +213,7 @@ Returns string representing the entity name.
213
213
you should use [ bem-naming] ( https://github.com/bem-sdk/bem-naming ) package.
214
214
215
215
``` js
216
- const BemEntityName = require (' bem- entity-name' );
216
+ const BemEntityName = require (' @ bem/ entity-name' );
217
217
const name = new BemEntityName ({ block: ' button' , mod: ' focused' });
218
218
219
219
name .toString (); // button_focused
@@ -224,7 +224,7 @@ name.toString(); // button_focused
224
224
Returns object representing the entity name.
225
225
226
226
``` js
227
- const BemEntityName = require (' bem- entity-name' );
227
+ const BemEntityName = require (' @ bem/ entity-name' );
228
228
const name = new BemEntityName ({ block: ' button' , mod: ' focused' });
229
229
230
230
name .valueOf ();
@@ -240,7 +240,7 @@ In Node.js, `console.log()` calls `util.inspect()` on each argument without a fo
240
240
` BemEntityName ` has ` inspect() ` method to get custom string representation of the object.
241
241
242
242
``` js
243
- const BemEntityName = require (' bem- entity-name' );
243
+ const BemEntityName = require (' @ bem/ entity-name' );
244
244
245
245
const name = new BemEntityName ({ block: ' input' , mod: ' disabled' });
246
246
@@ -252,7 +252,7 @@ console.log(name);
252
252
You can also convert ` BemEntityName ` object to ` string ` .
253
253
254
254
``` js
255
- const BemEntityName = require (' bem- entity-name' );
255
+ const BemEntityName = require (' @ bem/ entity-name' );
256
256
257
257
const name = new BemEntityName ({ block: ' input' , mod: ' disabled' });
258
258
0 commit comments