hnhdigital-os/laravel-search-components

View on GitHub
README.md

Summary

Maintainability
Test Coverage
```
 _____                     _     _____                                              _       
/  ___|                   | |   /  __ \                                            | |      
\ `--.  ___  __ _ _ __ ___| |__ | /  \/ ___  _ __ ___  _ __   ___  _ __   ___ _ __ | |_ ___ 
 `--. \/ _ \/ _` | '__/ __| '_ \| |    / _ \| '_ ` _ \| '_ \ / _ \| '_ \ / _ \ '_ \| __/ __|
/\__/ /  __/ (_| | | | (__| | | | \__/\ (_) | | | | | | |_) | (_) | | | |  __/ | | | |_\__ \
\____/ \___|\__,_|_|  \___|_| |_|\____/\___/|_| |_| |_| .__/ \___/|_| |_|\___|_| |_|\__|___/
                                                      | |                                   
                                                      |_|                                   
```

Provides blade template and a search object to convert your model searches into html or json.

[![Latest Stable Version](https://poser.pugx.org/hnhdigital-os/laravel-search-components/v/stable.svg)](https://packagist.org/packages/hnhdigital-os/laravel-search-components) [![Total Downloads](https://poser.pugx.org/hnhdigital-os/laravel-search-components/downloads.svg)](https://packagist.org/packages/hnhdigital-os/laravel-search-components) [![Latest Unstable Version](https://poser.pugx.org/hnhdigital-os/laravel-search-components/v/unstable.svg)](https://packagist.org/packages/hnhdigital-os/laravel-search-components) [![Built for Laravel](https://img.shields.io/badge/Built_for-Laravel-green.svg)](https://laravel.com/) [![License](https://poser.pugx.org/hnhdigital-os/laravel-search-components/license.svg)](https://packagist.org/packages/hnhdigital-os/laravel-search-components)

[![Build Status](https://travis-ci.org/hnhdigital-os/laravel-search-components.svg?branch=master)](https://travis-ci.org/hnhdigital-os/laravel-search-components) [![StyleCI](https://styleci.io/repos/116639586/shield?branch=master)](https://styleci.io/repos/116639586) [![Test Coverage](https://codeclimate.com/github/hnhdigital-os/laravel-search-components/badges/coverage.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-search-components/coverage) [![Issue Count](https://codeclimate.com/github/hnhdigital-os/laravel-search-components/badges/issue_count.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-search-components) [![Code Climate](https://codeclimate.com/github/hnhdigital-os/laravel-search-components/badges/gpa.svg)](https://codeclimate.com/github/hnhdigital-os/laravel-search-components)

This package has been developed by H&H|Digital, an Australian botique developer. Visit us at [hnh.digital](http://hnh.digital).

## Documentation

* [Requirements](#requirements)
* [Installation](#install)
* [Configuration](#configuration)
* [Contributing](#contributing)
* [Credits](#credits)
* [License](#license)

## Requirements

* PHP >= 7.2
* Laravel >= 5.8

## Installation

Via composer:

`$ composer require hnhdigital-os/laravel-search-components ~1.0`

This package's service provider will autoload.

## Configuration

Access the search class by adding it as an alias to your controller.

```php
use HnhDigital\SearchComponents\Search;
```

## Contributing

Please see [CONTRIBUTING](https://github.com/hnhdigital-os/laravel-search-components/blob/master/CONTRIBUTING.md) for details.

## Credits

* [Rocco Howard](https://github.com/RoccoHoward)
* [All Contributors](https://github.com/hnhdigital-os/laravel-search-components/contributors)

## License

The MIT License (MIT). Please see [License File](https://github.com/hnhdigital-os/laravel-search-components/blob/master/LICENSE) for more information.