Download the PHP package lifo/autocomplete-bundle without Composer
On this page you can find all versions of the php package lifo/autocomplete-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download lifo/autocomplete-bundle
More information about lifo/autocomplete-bundle
Files in lifo/autocomplete-bundle
Package autocomplete-bundle
Short Description Symfony Autocomplete Form Bundle
License MIT
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 autocomplete-bundle
Introduction
This is a Symfony Bundle that provides an autocomplete Form Type. This was designed for Symfony v4+. Currently, this widget uses Select2 as its base. In the future I might add other 'autocomplete' widgets using different interfaces.
This is a replacement for my older Typeahead Bundle that was originally for Symfony v2 and hasn't been updated in years (but has served me well!). This is not a one-for-one replacement, but rather a more modern approach to doing things.
I'm still working on features and ironing out some small issues. I have not tagged any releases yet.
Features
- Supports Entity and Non-Entity lookups using a single class type.
- Supports AJAX or Array lists.
- Easily add the javascript code to your existing bundler (webpack, etc), or use it directly via a
<script>tag. - Support different themes like
bootstrap. - Supports
tagging- The ability of adding new entities or items. - Form types for
SelectandVue-Multiselectwidgets. Vue-Multiselect type is not documented yet.
Requirements
-
This bundle requires the Select2 or Vue-multiselect javascript and CSS code, but does not provide it directly. You must include it yourself, eg:
yarn add select2, and add it to your webpack or other bundler configuration. Select2requires jQuery and is not actually provided in this bundle. You must provide it yourself, eg:yarn add jquery
Examples
Note: The examples below use the bootstrap theme from the NPM package select2-bootstrap-theme (yarn add select2-bootstrap-theme).
A simple select box that allows a single entity User to be selected from an AJAX request.
A simple select box that allows a multiple User entities to be selected from an AJAX request.
A simple select box that uses a plain array of choices.
Configuration
There are a lot of options to customize the way the autocomplete widget functions. Defaults are shown.
Note: A route, url, or choices must be specified for the widget to function.
| Option | Default | Description |
|---|---|---|
| route | null |
Symfony route name to generate an URL to perform an AJAX search request. |
| route_params | null |
Parameter array to generate the route |
| url | null |
An absolute URL to perform the AJAX search request from instead of a route name. |
| choices | null |
An keyed array of choices to populate the select box with instead of using AJAX. |
| class | null |
The Entity class representing the items in the results. Can be null to use non-entities. |
| property | "id" |
The unique ID property name to use for the id of each item. |
| text_property | null |
The property to render the selection text from. Can be null if your Entity has a __toString method. |
| multiple | false |
If true, multiple items can be selected. |
| min_input_length | 0 |
Minimum input length required before a search request is performed. |
| max_selections | 0 |
Maximum selections allowed (multiple is true). Set to 0 for no limit. |
| delay | 250 |
Delay, in milliseconds before a search request is performed. |
| tags | false |
Enable tagging support (adding new entries). |
| placeholder | null |
Placeholder text shown in the widget when nothing is selected. |
| allow_clear | true |
Allow the selection(s) to be cleared with a single click of an "x" icon. |
| close_on_select | true |
Close the dropdown after a selection is made. |
| theme | "bootstrap" |
Theme to use. 'default' is the standard option for Select2. |
| language | "en" |
Lanuage to use. |
| dropdown_auto_width | false |
If true, the dropdown width will expand to its contents. |
| dropdown_parent | null |
CSS Selector target for the dropdown parent placement. Useful if you need to target a modal, etc. |
| dir | "ltr" |
Language direction: Left-to-Right (rtl), or Right-to-Left (ltr) |
| disabled | false |
If true, the select will be disabled. |
| transformer | null |
Custom DataTransformer to use. |
Installation
Symfony v4+, v5+, v6+
composer require lifo/autocomplete-bundle
If you're using Flex then the bundle will work w/o any other configuration.
If you're not using Flex then you'll need to register the bundle in bundles.php:
Twig Configuration
By default, the form theme is enabled automatically in Twig, but you can disable this if you need to with the following config:
If autoconfigure is disabled, you'll have to manually update your Twig config:
Symfony v3.x
Symfony v3 is not officially supported, but might work if you manually register the
bundle in app/AppKernel.php
Webpack
This is an example of how to add the javascript and CSS to your app. The concept here is similar to other bundlers as well.
In your main entry point you would add something similar as this:
Script Tag
You can include the required javascript by using straight script tags too. The paths here assume the files
are already in your public web directory.
Data Format
AJAX responses and the simple Array lists require the following format:
AJAX Requests
Select2 sends the following on AJAX requests.
term- The current search term in the search box.q- Contains the same contents asterm._type- "request type". Will usually be query, but changes to query_append for paginated requests.page- The current page number to request. Only sent for paginated (infinite scrolling) searches.
