Git Product home page Git Product logo

silverware-navigation's Introduction

SilverWare Navigation Module

Latest Stable Version Latest Unstable Version License

Provides a series of navigation components for use with SilverWare.

Contents

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

Maintainers

Colin Tucker Praxis Interactive
Colin Tucker Praxis Interactive

License

BSD-3-Clause © Praxis Interactive

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.