silverware/search

SilverWare Search Module.

SilverWare Search Module

, _(*1)

Provides a search results page and navigation bar search item for use with SilverWare., _(*2)

Contents

• Requirements
• Installation
• Configuration
• Usage
• Issues
• Contribution
• Maintainers
• License

Requirements

• SilverWare
• SilverWare Navigation Module

Installation

Installation is via Composer:, _(*3)

$ composer require silverware/search

Configuration

As with all SilverStripe modules, configuration is via YAML. Frontend requirements for ContentController are applied via config.yml. Style mappings for Bootstrap are configured in the styles.yml configuration file., _(*4)

Usage

This module provides a SearchResultsPage which will be created automatically upon build. This page is a dedicated page for showing search results generated by SilverStripe's built-in fulltext search., _(*5)

A component named SearchComponent will be made available in the CMS after installation. This component presents a search field allowing the user to search the site, and is ideal for inclusion in the app's header or navigation bar., _(*6)

Also provided is a SearchItem object which can be added as a child of the BarNavigation component provided by the SilverWare Navigation module. This item adds a search icon to your navbar which shows a search form popover upon click., _(*7)

On small screen devices, the icon and popover are hidden, and instead the search form is added directly into the collapsible navigation area., _(*8)

Issues

Please use the GitHub issue tracker for bug reports and feature requests., _(*9)

Contribution

Your contributions are gladly welcomed to help make this project better. Please see contributing for more information., _(*10)

Maintainers

Colin Tucker	Praxis Interactive

License

BSD-3-Clause © Praxis Interactive, _(*11)