craigpearson/bem-walker-nav-menu

BEM naming for WordPress navigation menus.

Maintainers

Details

github.com/craigpearson/bem-walker-nav-menu

Homepage

Source

Issues

Installs: 2 144

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 4

Open Issues: 1

Type:package

3.1.1 2020-12-03 17:25 UTC

Requires

  • php: >=5.6

WTFPL a7666200d34c4f8be878f0d7b9281ba9923b1855

wordpressnavigation

This package is auto-updated.

Last update: 2024-04-16 18:25:42 UTC

README

BEM naming for WordPress navigation menus.

Installation

You can manually download it and install it in your plugins folder or install it via Composer:

composer require craigpearson/bem-walker-nav-menu

Usage

<nav class="nav">
    <?php
    wp_nav_menu([
        'walker' => new CP\BEM\navWalker,
    ]);

    // Will generate:
    // <ul id="..." class="nav__list">
    //     <li class="nav__item ... nav__item--123">
    //         <a href="..." class="nav__link">...</a>
    //         <ul class="sub-nav">
    //             <li class="sub-nav__item">
    // ...
    ?>
</nav>

Extend the class to change the HTML classes.

<?php

class CustomWalkerNavMenu extends \CP\BEM\navWalker
{
    protected $prefix = 'c';

    protected $navListClass = 'menu__list';

    protected $navItemClass = 'menu__item';

    protected $navLinkClass = 'menu__link';

    protected $subNavClass = 'sub-menu';

    protected $subNavItemClass = 'sub-menu__item';

    protected $subNavLinkClass = 'sub-menu__link';
}

License

WTFPL