floor12/breadcrumbs-microdata

HTML 面包屑微数据生成器。

1.0.0 2021-05-04 13:57 UTC

This package is auto-updated.

Last update: 2024-08-27 14:03:17 UTC


README

Scrutinizer Code Quality Build Status Code Coverage

安装

使用composer将此软件包添加到您的项目中。

composer require "floor12/breadcrumbs-microdata"

用法

面包屑API简单明了。以下是一些示例。这个

use floor12\Breadcrumbs\Breadcrumbs;

$elements = [
    '/first' => 'First element 1',
    '/first/second' => 'Second element 2',
    'Current',
]; 
(new Breadcrumbs($elements))->getHtml();

或者这个

use floor12\Breadcrumbs\Breadcrumbs;

(new Breadcrumbs())
        ->addElement('First element 1', '/first')
        ->addElement('Second element 2', '/first/second')
        ->addElement('Current')
        ->getHtml();

... 将生成这个HTML代码

<ol itemscope itemtype="http://schema.org/BreadcrumbList" class="f12-breadcrumbs" id="f12-breadcrumbs">
    <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <a data-pjax="0" itemprop="item" href="/first">
            <span itemprop="name">First element 1</span>
            <meta itemprop="position" content="1">
        </a>
    </li>
    <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <a data-pjax="0" itemprop="item" href="/first/second"><span itemprop="name">Second element 2</span>
            <meta itemprop="position" content="2">
        </a>
    </li>
    <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem">
        <span itemprop="name">Current</span>
        <meta itemprop="position" content="3">
    </li>
</ol>

您也可以设置自己的ID和CSS类名

use floor12\Breadcrumbs\Breadcrumbs;

(new Breadcrumbs([]))
    ->setMainId('some-id')
    ->setCssClass('some-css-class')
    ->getHtml();

CSS样式

要创建默认的精美样式面包屑,请将scss/f12-breadcrumbs.scssscss/f12-breadcrumbs.css包含到您的项目样式文件中,并覆盖所需的内容。

贡献

我很乐意得到任何对此模块的开发、支持和错误报告的帮助。