Skip to content

Variables

Michael Witwicki edited this page Nov 29, 2017 · 7 revisions
Name Type
accessKey string
active string
ancestorActive boolean
assetId integer
categoryId integer
class string
dateCreated Craft\DateTime
dateUpdated Craft\DateTime
descendantActive boolean
entryId integer
hasChildren boolean
id integer
idAttr string
includeInNavigation boolean
lft integer
link string
linkType string
level integer
name string
navigationId integer
passive boolean
rel string
rgt integer
siblingActive boolean
slug string
target string
text string
titleAttr string
userGroups array

accessKey

The accesskey variable outputs any access key you have associated with a Navee node.

active

A boolean determining if the current node is the active node.

ancestorActive

A boolean determining if the active node is an ancestor of the current node.

assetId

If your node is using the Assets link type this will contain the id of your selected asset.

categoryId

If your node is using the Category link type this will contain the id of your selected category.

class

The class variable outputs any specific class you have associated with a Navee item. Additionally, this variable will contain the active class.

dateCreated

The Craft\DateTime for the date the current node was created.

dateUpdated

The Craft\DateTime for the date the current node was created.

descendantActive

A boolean determining if the active node is a descendant of the current node.

entryId

If your node is using the Entry link type this will contain the id of your selected entry.

hasChildren

Boolean which returns if a node has child nodes. This variable takes into consideration the state of the tree after all parameters have been passed.

id

The id of your node Element. This should not be confused with the idAttr below.

idAttr

If you added a unique id to your node in the control panel, this variable will access it.

includeInNavigation

Returns the value you set for the include in navigation field in the control panel.

lft

The nested set lft value for your node.

link

The uri of the page you linked your node to.

linkType

Navee supports creating links to assets, categories, entries as well as custom urls. This field will contain the selection for the current node.

level

The nested set lft value for your node.

name

The name variable outputs the name attribute associated with each Navee item (for use in an anchor tag).

navigationId

The id of the navigation this node belongs to.

passive

Returns whether this node is a passive node.

rel

The rel variable outputs the rel attribute associated with each Navee item (for use in an anchor tag).

rgt

The nested set rgt value for your node.

siblingActive

A boolean determining if the active node is a sibling of the current node.

slug

A slugified version of the title.

target

The target variable outputs the target attribute associated with each Navee item (for use in an anchor tag).

text

The text that will accompany your link. For example:

<a href="{{ node.link }}">{{ node.text }}</a>

titleAttr

The titleAttr variable outputs the title attribute associated with each Navee item (for use in an anchor tag).

userGroups

An array of user groups with permission to view this node.