You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

91 lines
3.3 KiB

  1. ============================
  2. Prefetch autocomplete offers
  3. ============================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch
  16. :alt: OCA/web
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_search_autocomplete_prefetch
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/162/10.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. When searching, the autocomplete options can be a bit frustrating because you
  25. will be offered choices that won't yield a result. This addon searches for the
  26. term in the background and only offers an option if this search has a result.
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Configuration
  31. =============
  32. * some searches (especially via function fields) can be very heavy on the
  33. server.
  34. To disable prefetching on a per field basis, set the option
  35. `web_search_autocomplete_prefetch.disable`::
  36. options="{'web_search_autocomplete_prefetch.disable': true}"
  37. on your field in the search view.
  38. * by default, the addon triggers a search 350 milliseconds after the last key
  39. press. If you want a different timeout, set the parameter
  40. ``web_search_autocomplete_prefetch.keypress_timeout`` to the amount of
  41. milliseconds you need as timeout.
  42. Bug Tracker
  43. ===========
  44. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  45. In case of trouble, please check there if your issue has already been reported.
  46. If you spotted it first, help us smashing it by providing a detailed and welcomed
  47. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_search_autocomplete_prefetch%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  48. Do not contact contributors directly about support or help with technical issues.
  49. Credits
  50. =======
  51. Authors
  52. ~~~~~~~
  53. * Therp BV
  54. Contributors
  55. ~~~~~~~~~~~~
  56. * Holger Brunn <hbrunn@therp.nl>
  57. Maintainers
  58. ~~~~~~~~~~~
  59. This module is maintained by the OCA.
  60. .. image:: https://odoo-community.org/logo.png
  61. :alt: Odoo Community Association
  62. :target: https://odoo-community.org
  63. OCA, or the Odoo Community Association, is a nonprofit organization whose
  64. mission is to support the collaborative development of Odoo features and
  65. promote its widespread use.
  66. This module is part of the `OCA/web <https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch>`_ project on GitHub.
  67. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.