Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Adds new options to MojoMotor's native page_list tag
PHP
branch: develop

This branch is even with aaronfowler:develop

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
pagelistplus
README.md

README.md

Page List Plus

Page List Plus expands the options available to MojoMotor's native page_list tag

Version: 1.3.4

Authors:

License: OSL3

Changes

1.3.x (feb 2012)

  • list items have a class (instead of ID) mojo_page_list_url_title, so you can have multiple lists on a page.

Installation

Drop the "pagelistplus" folder into MojoMotor's "/system/mojomotor/third-party" folder.

Usage

{mojo:pagelistplus:page_list}

This outputs a navigation menu, almost identical to MojoMotor's {mojo:site:page_list} tag.

  • every page item in the list has a CSS class set to "mojo_page_list_url_title"
  • every page that has children, has class "has_kids"
  • the current active page has class "mojo_active"
  • every active parent-page has class "parent_active"

Parameters

pagelistplus accepts the default mojomotor page_list parameters
page, depth, class, id, plus some extra

start=

The "start" parameter tells the tag from where to start building the menu.
There are several options to choose from

start="current"
Starts from the current page.

start="parent"
Start at the current page's immediate parent. If the current page is top level, outputs nothing.

start="root"
Starts at the current page's root parent. Shows all the children of the topmost page.

active_children=yes

When set to yes, only child-pages of the current page will be shown, one level deep. Other pages with children do have a class "has_kids".

header="h3"

Output the page title of the page specified in the start or page parameter,
wrapped in a HTML tag. header="h1/h2/p/div/etc..."

header_link="yes"

If set to "yes", the header text will also be wrapped with a link

prepend= and append="some text or HTML"

If a page_list is output, prepend/append some custom text or HTML

force_output="yes"

By default, when a page_list is empty, nothing will be output (e.g. when start=root but the page has no children). When force_ouput=yes, page_list will always output any header and/or prepend and append text. For example, if you always want to show the header in a sidebar, regardless of any child-pages.

Example

{mojo:pagelistplus:page_list start="root" depth="1" id="top_nav"}

Outputs:

<ul id="top_nav">
    <li class="mojo_page_list_page1 mojo_active has_kids"><a href="http://example.com/index.php/welcome">Welcome</a></li>
    <li class="mojo_page_list_page2"><a href="http://example.com/index.php/about">About</a></li>
</ul>

{mojo:pagelistplus:page_list start="root" header_link="no" header="h3" id="side_nav"}

Outputs:

<h3>Welcome</h3>
<ul id="side_nav">
    <li class="mojo_page_list_ut1"><a href="http://example.com/index.php/ut1">some_page1</a></li>
    <li class="mojo_page_list_ut2"><a href="http://example.com/index.php/ut2">some_page2</a></li>
    <li class="mojo_page_list_ut3 parent_active has_kids"><a href="http://example.com/index.php/ut3">some_page3</a>
        <ul>
            <li class="mojo_page_list_ut4 mojo_active"><a href="http://example.com/index.php/ut4">some_page4</a></li>
            <li class="mojo_page_list_ut5"><a href="http://example.com/index.php/ut5">some_page5</a></li>
        </ul>
    </li>
</ul>
Something went wrong with that request. Please try again.