silverware / navigation
SilverWare Navigation Module.
Installs: 395
Dependents: 2
Suggesters: 0
Security: 0
Stars: 1
Watchers: 2
Forks: 2
Open Issues: 0
Type:silverstripe-vendormodule
Requires
- php: >=5.6.0
- silverware/silverware: ^1.5
README
Provides a series of navigation components for use with SilverWare.
Contents
- Requirements
- Installation
- Configuration
- Usage
- Issues
- To-Do
- Contribution
- Attribution
- Maintainers
- License
Requirements
Installation
Installation is via Composer:
$ composer require silverware/navigation
Configuration
As with all SilverStripe modules, configuration is via YAML. Page settings for navigation are applied
using the included PageExtension class. Style mappings for Bootstrap are configured in the styles.yml
configuration file.
Usage
This module provides a series of navigation-related components:
- Anchor Navigation
- Bar Navigation
- Block Navigation
- Button Navigation
- Crumb Navigation
- Icon Navigation
- Inline Navigation
- Level Navigation
- List Navigation
These components can be added to your SilverWare templates or layouts using the CMS.
Anchor Navigation
The Anchor Navigation component shows a list of links to anchors within the current page's content.
Bar Navigation
The Bar Navigation component represents a standard Bootstrap navbar.
Block Navigation
The Block Navigation component renders a series of Link components in a block layout.
Button Navigation
The Button Navigation component renders a series of Button components in an inline layout.
Crumb Navigation
The Crumb Navigation component is used to add Bootstrap breadcrumb navigation to your template or layout.
Icon Navigation
The Icon Navigation component renders a series of Link components as icons in an inline layout.
Inline Navigation
The Inline Navigation component renders a series of Link components in an inline layout.
Level Navigation
The Level Navigation component is typically added to a sidebar to provide navigation for the current page level, i.e. all of the pages within the current section.
List Navigation
The List Navigation component renders a series of Link components as a list (similar to Level Navigation).
Issues
Please use the GitHub issue tracker for bug reports and feature requests.
To-Do
- Tests
Contribution
Your contributions are gladly welcomed to help make this project better. Please see contributing for more information.
Attribution
- Makes use of Bootstrap by the Bootstrap Authors and Twitter, Inc.
Maintainers
License
BSD-3-Clause © Praxis Interactive