createBEM

Namespaces

• createBEM

Functions

createBEM()

createBEM(block, namespaceOverrides): Object

创建 BEM 格式的 CSS 类名辅助工具

Parameters

Parameter	Type	Default value	Description
block	string	undefined	块级名称
namespaceOverrides	MaybeFn<string>	createBEM.defaults.namespace	覆盖默认命名空间名称

Returns

Object

b

b: (blockSuffix) => string

Parameters

Parameter	Type	Default value
blockSuffix	string	''

Returns

string

be

be: (blockSuffix, element) => string

Parameters

Parameter	Type	Default value
blockSuffix	string	''
element	string	''

Returns

string

bem

bem: (blockSuffix, element, modifier) => string

Parameters

Parameter	Type	Default value
blockSuffix	string	''
element	string	''
modifier	string	''

Returns

string

block

block: string

bm

bm: (blockSuffix, modifier) => string

Parameters

Parameter	Type	Default value
blockSuffix	string	''
modifier	string	''

Returns

string

e

e: (element) => string

Parameters

Parameter	Type	Default value
element	string	''

Returns

string

em

em: (element, modifier) => string

Parameters

Parameter	Type	Default value
element	string	''
modifier	string	''

Returns

string

m

m: (modifier) => string

Parameters

Parameter	Type	Default value
modifier	string	''

Returns

string

namespace

namespace: string

Example

const ns = createBEM('block', 'el')
ns.b()
// => 'el-block'

ns.be('header', 'span')
// => 'el-block-header__span'

ns.bem('header', 'span', 'empty')
// => 'el-block-header__span--empty'

ns.e('header')
// => 'el-block__header'

ns.em('span', 'empty')
// => 'el-block__span--empty'

ns.m('empty')
// => 'el-block--empty'

Interfaces

CreateBEMOptions

Properties

Property	Type	Description
namespace	MaybeFn<string>	命名空间 Default ''