包简介

A PHP project to enforce the Block Element Modifier (CSS) methodology.

README 文档

README

BEM — is a methodology that helps you to create reusable components and code sharing in front‑end development

Usage

Create a class instance to represent your BEM model. Pass the "block" as the constructor argument.

$bem = new \AKlump\Bem\Fluent\Bem('foo');

All methods return an object instance that can be typecast to a string. Or, you can also call toString() or toArray() as appropriate; see \AKlump\Bem\Fluent\Interfaces\OutputInterface for details. All of the following produce the same output.

(string) $bem->block(); // foo
strval($bem->block()); // foo
$bem->block()->toString(); // foo

For simplicity any remaining examples will show only the first form.

The Basic Four

(string) $bem->block(); // "foo"
(string) $bem->element('content'); // "foo__content"
(string) $bem->block()->modifier('has-image'); // "foo--has-image"
(string) $bem->element()->modifier('content', 'has-image'); // "foo__content--has-image"

For Javascript Purposes

(string) $bem->block()->js(); // "js-foo"
(string) $bem->element('content')->js(); // "js-foo__content"

Convenience Syntax

There are some conveniences you should take note of; pay special attention to the plus* methods.

// In both cases "foo js-foo" === $classes.
$classes = $bem->block() . ' ' . $bem->block()-js();
$classes = $bem->block()->plusJs();

// In both cases "foo foo--bar" === $classes.
$classes = $bem->block() . ' ' . $bem->block()->modifier('bar);
$classes = $bem->block()->plusModifier('bar);

// In both cases "foo foo--bar js-foo js-foo--bar" === $classes.
$classes = implode(' ', [
  $bem->block(),
  $bem->block()->modifier('bar),
  $bem->block()->js(),
  $bem->block()->modifier('bar)->js(),
]);
  
$classes = $bem->block()->plusModifier('bar)->plusJs()

"Global" Innovation

You'll find an innovation in this project called global. It can be used to target common parts across all blocks at once. Refer to the example below where component and component__content represent the global block and global element, respectively. This innovation, in this case, allows you to target all three components' content in a single line of CSS. It can be thought of as a means of grouping. Use the the plusGlobal() method for this feature.

<section>
  <div class="story component">
    <div class="story__content component__content"></div>
  </div>
  <div class="film component">
    <div class="film__content component__content"></div>
  </div>
  <div class="copy component">
    <div class="copy__content component__content"></div>
  </div>
</section>

.component__content {
  width: 900px;
  margin: auto;
}

$story = new \AKlump\Bem\Fluent\Bem('story', 'component');
$film = new \AKlump\Bem\Fluent\Bem('film', 'component');
$copy = new \AKlump\Bem\Fluent\Bem('copy', 'component');

$story->element('content')->plusGlobal(); // "story__content component__content"
$film->element('content')->plusGlobal(); // "film__content component__content"
$copy->element('content')->plusGlobal(); // "copy__content component__content"

Casting to Array

Given a complex chain as shown next, you can see the helpfulness of the plus* methods and why you might want to use the toArray() method.

$bem = new \AKlump\Bem\Fluent\Bem('foo', 'components');
$classes = $bem->element('content')
  ->plusModifier('first')
  ->plusGlobal()
  ->plusJs()
  ->toArray();

$classes === [
  'foo__content',
  'foo__content--first',
  'js-foo__content',
  'js-foo__content--first',
  'js-components__content',
  'js-components__content--first',
  'components__content',
  'components__content--first',
];

Customizing Output Style

To alter the way the classes are formatted, create a new, custom class implementing \AKlump\Bem\Styles\StyleInterface for control of the processing and output of the classes, including the division characters. Look to \AKlump\Bem\Styles\Official for a model. Pass your custom style to \AKlump\Bem\Fluent\Bem when constructing.

Usage With Twig

Themers

{{ bem_set_global('component') }}
{{ bem_set_block('story-section') }}
<body>
<h1>Twig Extension Example</h1>

<pre>
{% set classes = [
  bem_block().plus_js(),
  bem_block().modifier('th-summary'),
  bem_block().modifier('lang-en'),
] %}
&lt;section>
  &ltdiv class="{{ classes|join(' ') }}">
    &lt;div class="{{ bem_element('width').plus_global() }}">
      &lt;div class="{{ bem_element('item').plus_modifier('first') }}">&lt;/div>
      &lt;div class="{{ bem_element('item') }}">&lt;/div>
      &lt;div class="{{ bem_element('item').plus_modifier('last') }}">&lt;/div>
    &lt;/div>
  &lt;/div>
&lt;/section>
</pre>
</body>

<section>
  <div class="story-section js-story-section story-section--th-summary story-section--lang-en">
    <div class="story-section__width component__width">
      <div class="story-section__item story-section__item--first"></div>
      <div class="story-section__item"></div>
      <div class="story-section__item story-section__item--last"></div>
    </div>
  </div>
</section>

Developers

See \AKlump\Bem\Twig\BemExtension

Contributing

If you find this project useful... please consider making a donation.

Similar Packages

aklump/bem 适用场景与选型建议

aklump/bem 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 62 次下载、GitHub Stars 达 0，最近一次更新时间为 2023 年 06 月 10 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 aklump/bem 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 aklump/bem 我们能提供哪些服务？

定制开发 / 二次开发

基于 aklump/bem 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

aklump/bem

包简介