Property | Type | Description | |
---|---|---|---|
$brandLabel | the text of the brand or false if it's not used. Note that this is not HTML-encoded. | ||
$brandOptions | the HTML attributes of the brand link. | ||
$brandUrl | array | string | boolean | ||
$containerOptions | the HTML attributes of the inner container. | ||
$fixed | whether the navbar content should be included in an inner div container which by default adds left and right padding. Set this to false for a 100% width navbar. | ||
$fixedContainerOptions | the HTML attributes of the fixed container. | ||
$options | the HTML attributes for the widget container tag. The following special options are recognized: - tag: string, defaults to "nav", the name of the container tag. | ||
$screenReaderToggleText | text to show for screen readers for the button to toggle the navbar. | ||
$wrapperOptions | the HTML attributes of the navigation wrapper container. |
Method | Description | |
---|---|---|
init ( ) | Initializes the widget. | |
run ( ) | Renders the widget. |
Method | Description | |
---|---|---|
registerToggleButtonScript ( string $targetId ) | Registers the JS for the toggle button. | |
renderToggleButton ( ) : string | Renders collapsible toggle button. |
protected registerToggleButtonScript ( string $targetId ) | ||
$targetId | string | the ID of the toggled navigation. |
protected renderToggleButton ( ) : string | ||
return | string | the rendered toggle button. |
public $brandLabel |
public $containerOptions |
public $fixed |
public $fixedContainerOptions |
public $options |
public $screenReaderToggleText |