Download the PHP package mezcalito/ux-search without Composer
On this page you can find all versions of the php package mezcalito/ux-search. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mezcalito/ux-search
More information about mezcalito/ux-search
Files in mezcalito/ux-search
Package ux-search
Short Description Effortless search and faceted search with Symfony UX and Mezcalito UX Search
License MIT
Homepage https://github.com/Mezcalito/ux-search
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package ux-search
Mezcalito UX Search
Overview
The Mezcalito UxSearch Bundle provides an easy-to-use classic search and faceted search system in your Symfony application using Twig Components and Live Components. It allows you to create and manage multiple search, each with its unique configuration. Currently, the bundle supports Doctrine and Meilisearch adapter.
Installation
Add mezcalito/ux-search to your composer.json file:
Register and configure the bundle
If you are using Symfony Flex, the following steps should be done automatically. Otherwise, follow the instructions.
Register the bundle
Inside config/bundles.php, add the following line:
Configuration
To configure the bundle, add the following configuration to your config/packages/mezcalito_ux_search.yaml file.
This example demonstrates how to set up a Meiliseach adapter:
Available adapter
For now, only 2 adapters are available: Meilisearch and Doctrine.
| Adapter | DSN |
|---|---|
| Meilisearch | meilisearch://key@localhost:7700 |
| Doctrine | doctrine://default |
Read the Doctrine part docs to learn about the configuration options available for each adapter.
You can also create your own Adapter to use other provider.
Usage
To use the bundle, create your first Search. To do this, just use the make:search command and follow indications.
In the case of Meilisearch, you need to specify the name of the index to use, and for Doctrine, the FQCN of the entity to use.
By default, the name of your search will be the name of your class with the Search suffix removed. You can change this by specifying a custom name.
Also, by default, the Adapter used is the one specified in the configuration under default_adapter. You can specify the name of the Adapter to use, for example, if you have multiple Search instances that use different Adapters.
After that, you have a fully functional simple search. Feel free to check the documentation to customize your search (adding facets, sorting, ...) or if you prefer not to use the maker.
Render a Search
To render a search in your Twig template, you can use the Mezcalito:UxSearch:Layout, you will then have a default rendering provided by the bundle.
Using compnent function
Using HTML-like Syntax
In both cases, replace listing with the name of search configuration.
Default layout component
Customization
You can tailor the behavior and appearance according to your needs by overriding default component or implementing custom logic. This allows you to adapt the bundle to your specific use cases and requirements.
| Component name | Description |
|---|---|
| Layout | The root wrapper component for all components |
| CurrentRefinements | Displays a list of refinements applied to the search |
| ClearRefinements | Displays a button that lets users clean every refinement applied to the search |
| SearchInput | Let users perform a text-based query |
| SortBy | Displays a list of sorting possibility, allowing a user to change the way hits are sorted |
| TotalHits | Displays the total number of matching hits |
| Pagination | Displays a pagination system which lets users change the current page of search results |
| Facet/RangeInput | Allows a user to select a numeric range using a minimum and maximum input. |
| Facet/RangeSlider | Provides a user-friendly way to filter the results, based on a single numeric range |
| Facet/RefinementList | Users can filter the dataset based on facets |
| Hits | Display a list of results. |
Issues and feature requests
Please report issues and request features at https://github.com/mezcalito/ux-search/issues.
License
This bundle is under the MIT license. For the whole copyright, see the LICENSE file distributed with this source code.
All versions of ux-search with dependencies
nyholm/psr7 Version ^1.0
phpdocumentor/reflection-docblock Version ^5.4
symfony/asset Version ^6.4|^7.0
symfony/config Version ^6.4|^7.0
symfony/dependency-injection Version ^6.4|^7.0
symfony/http-client Version ^6.4|^7.0
symfony/options-resolver Version ^6.4|^7.0
symfony/serializer Version ^6.4|^7.0
symfony/ux-live-component Version ^2.20
symfony/ux-twig-component Version ^2.20
twig/twig Version ^3.8