mirror of https://github.com/OCA/web.git
[MIG] web_search_autocomplete_prefetch
Holger Brunn
parent
55df4a57f6
commit
e32cf8ba14
|
|
@ -1,27 +1,41 @@
|
||||||
.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
|
|
||||||
:alt: License: AGPL-3
|
|
||||||
|
|
||||||
============================
|
============================
|
||||||
Prefetch autocomplete offers
|
Prefetch autocomplete offers
|
||||||
============================
|
============================
|
||||||
|
|
||||||
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! This file is generated by oca-gen-addon-readme !!
|
||||||
|
!! changes will be overwritten. !!
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
|
||||||
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||||
|
:target: https://odoo-community.org/page/development-status
|
||||||
|
:alt: Beta
|
||||||
|
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||||
|
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||||
|
:alt: License: AGPL-3
|
||||||
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
|
||||||
|
:target: https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch
|
||||||
|
:alt: OCA/web
|
||||||
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||||
|
:target: https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_search_autocomplete_prefetch
|
||||||
|
:alt: Translate me on Weblate
|
||||||
|
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||||
|
:target: https://runbot.odoo-community.org/runbot/162/10.0
|
||||||
|
:alt: Try me on Runbot
|
||||||
|
|
||||||
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||||
|
|
||||||
When searching, the autocomplete options can be a bit frustrating because you
|
When searching, the autocomplete options can be a bit frustrating because you
|
||||||
will be offered choices that won't yield a result. This addon searches for the
|
will be offered choices that won't yield a result. This addon searches for the
|
||||||
term in the background and only offers an option if this search has a result.
|
term in the background and only offers an option if this search has a result.
|
||||||
|
|
||||||
Usage
|
**Table of contents**
|
||||||
=====
|
|
||||||
|
|
||||||
.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
|
.. contents::
|
||||||
:alt: Try me on Runbot
|
:local:
|
||||||
:target: https://runbot.odoo-community.org/runbot/162/8.0
|
|
||||||
|
|
||||||
For further information, please visit:
|
Configuration
|
||||||
|
=============
|
||||||
* https://www.odoo.com/forum/help-1
|
|
||||||
|
|
||||||
Known issues / Roadmap
|
|
||||||
======================
|
|
||||||
|
|
||||||
* some searches (especially via function fields) can be very heavy on the
|
* some searches (especially via function fields) can be very heavy on the
|
||||||
server.
|
server.
|
||||||
|
|
@ -32,38 +46,46 @@ Known issues / Roadmap
|
||||||
|
|
||||||
on your field in the search view.
|
on your field in the search view.
|
||||||
* by default, the addon triggers a search 350 milliseconds after the last key
|
* by default, the addon triggers a search 350 milliseconds after the last key
|
||||||
pess. If you want a different timeout, set the parameter
|
press. If you want a different timeout, set the parameter
|
||||||
``web_search_autocomplete_prefetch.keypress_timeout`` to the amount of
|
``web_search_autocomplete_prefetch.keypress_timeout`` to the amount of
|
||||||
milliseconds you need as timeout.
|
milliseconds you need as timeout.
|
||||||
|
|
||||||
|
|
||||||
Bug Tracker
|
Bug Tracker
|
||||||
===========
|
===========
|
||||||
|
|
||||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
|
||||||
In case of trouble, please check there if your issue has already been reported.
|
In case of trouble, please check there if your issue has already been reported.
|
||||||
If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
|
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||||
`here <https://github.com/OCA/web/issues/new?body=module:%20web_search_autocomplete_prefetch%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
`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**>`_.
|
||||||
|
|
||||||
|
Do not contact contributors directly about support or help with technical issues.
|
||||||
|
|
||||||
Credits
|
Credits
|
||||||
=======
|
=======
|
||||||
|
|
||||||
|
Authors
|
||||||
|
~~~~~~~
|
||||||
|
|
||||||
|
* Therp BV
|
||||||
|
|
||||||
Contributors
|
Contributors
|
||||||
------------
|
~~~~~~~~~~~~
|
||||||
|
|
||||||
* Holger Brunn <hbrunn@therp.nl>
|
* Holger Brunn <hbrunn@therp.nl>
|
||||||
|
|
||||||
Maintainer
|
Maintainers
|
||||||
----------
|
~~~~~~~~~~~
|
||||||
|
|
||||||
|
This module is maintained by the OCA.
|
||||||
|
|
||||||
.. image:: https://odoo-community.org/logo.png
|
.. image:: https://odoo-community.org/logo.png
|
||||||
:alt: Odoo Community Association
|
:alt: Odoo Community Association
|
||||||
:target: https://odoo-community.org
|
:target: https://odoo-community.org
|
||||||
|
|
||||||
This module is maintained by the OCA.
|
|
||||||
|
|
||||||
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||||
mission is to support the collaborative development of Odoo features and
|
mission is to support the collaborative development of Odoo features and
|
||||||
promote its widespread use.
|
promote its widespread use.
|
||||||
|
|
||||||
To contribute to this module, please visit https://odoo-community.org.
|
This module is part of the `OCA/web <https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch>`_ project on GitHub.
|
||||||
|
|
||||||
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,2 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# © 2015 Therp BV <http://therp.nl>
|
|
||||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,11 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
# © 2015 Therp BV <http://therp.nl>
|
# Copyright 2015-2018 Therp BV <http://therp.nl>
|
||||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||||
{
|
{
|
||||||
"name": "Prefetch autocomplete offers",
|
"name": "Prefetch autocomplete offers",
|
||||||
"version": "8.0.1.0.0",
|
"version": "10.0.1.0.0",
|
||||||
"author": "Therp BV,Odoo Community Association (OCA)",
|
"author": "Therp BV,Odoo Community Association (OCA)",
|
||||||
|
"website": "https://github.com/OCA/web",
|
||||||
"license": "AGPL-3",
|
"license": "AGPL-3",
|
||||||
"category": "Usability",
|
"category": "Usability",
|
||||||
"summary": "Offer only items on autocompletion that will yield results",
|
"summary": "Offer only items on autocompletion that will yield results",
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
* some searches (especially via function fields) can be very heavy on the
|
||||||
|
server.
|
||||||
|
To disable prefetching on a per field basis, set the option
|
||||||
|
`web_search_autocomplete_prefetch.disable`::
|
||||||
|
|
||||||
|
options="{'web_search_autocomplete_prefetch.disable': true}"
|
||||||
|
|
||||||
|
on your field in the search view.
|
||||||
|
* by default, the addon triggers a search 350 milliseconds after the last key
|
||||||
|
press. If you want a different timeout, set the parameter
|
||||||
|
``web_search_autocomplete_prefetch.keypress_timeout`` to the amount of
|
||||||
|
milliseconds you need as timeout.
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
* Holger Brunn <hbrunn@therp.nl>
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
When searching, the autocomplete options can be a bit frustrating because you
|
||||||
|
will be offered choices that won't yield a result. This addon searches for the
|
||||||
|
term in the background and only offers an option if this search has a result.
|
||||||
|
|
@ -0,0 +1,419 @@
|
||||||
|
<?xml version="1.0" encoding="utf-8" ?>
|
||||||
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||||
|
<head>
|
||||||
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||||
|
<meta name="generator" content="Docutils 0.12: http://docutils.sourceforge.net/" />
|
||||||
|
<title>Prefetch autocomplete offers</title>
|
||||||
|
<style type="text/css">
|
||||||
|
|
||||||
|
/*
|
||||||
|
:Author: David Goodger (goodger@python.org)
|
||||||
|
:Id: $Id: html4css1.css 7614 2013-02-21 15:55:51Z milde $
|
||||||
|
:Copyright: This stylesheet has been placed in the public domain.
|
||||||
|
|
||||||
|
Default cascading style sheet for the HTML output of Docutils.
|
||||||
|
|
||||||
|
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||||
|
customize this style sheet.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* used to remove borders from tables and images */
|
||||||
|
.borderless, table.borderless td, table.borderless th {
|
||||||
|
border: 0 }
|
||||||
|
|
||||||
|
table.borderless td, table.borderless th {
|
||||||
|
/* Override padding for "table.docutils td" with "! important".
|
||||||
|
The right padding separates the table cells. */
|
||||||
|
padding: 0 0.5em 0 0 ! important }
|
||||||
|
|
||||||
|
.first {
|
||||||
|
/* Override more specific margin styles with "! important". */
|
||||||
|
margin-top: 0 ! important }
|
||||||
|
|
||||||
|
.last, .with-subtitle {
|
||||||
|
margin-bottom: 0 ! important }
|
||||||
|
|
||||||
|
.hidden {
|
||||||
|
display: none }
|
||||||
|
|
||||||
|
a.toc-backref {
|
||||||
|
text-decoration: none ;
|
||||||
|
color: black }
|
||||||
|
|
||||||
|
blockquote.epigraph {
|
||||||
|
margin: 2em 5em ; }
|
||||||
|
|
||||||
|
dl.docutils dd {
|
||||||
|
margin-bottom: 0.5em }
|
||||||
|
|
||||||
|
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||||
|
dl.docutils dt {
|
||||||
|
font-weight: bold }
|
||||||
|
*/
|
||||||
|
|
||||||
|
div.abstract {
|
||||||
|
margin: 2em 5em }
|
||||||
|
|
||||||
|
div.abstract p.topic-title {
|
||||||
|
font-weight: bold ;
|
||||||
|
text-align: center }
|
||||||
|
|
||||||
|
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||||
|
div.hint, div.important, div.note, div.tip, div.warning {
|
||||||
|
margin: 2em ;
|
||||||
|
border: medium outset ;
|
||||||
|
padding: 1em }
|
||||||
|
|
||||||
|
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||||
|
div.important p.admonition-title, div.note p.admonition-title,
|
||||||
|
div.tip p.admonition-title {
|
||||||
|
font-weight: bold ;
|
||||||
|
font-family: sans-serif }
|
||||||
|
|
||||||
|
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||||
|
div.danger p.admonition-title, div.error p.admonition-title,
|
||||||
|
div.warning p.admonition-title, .code .error {
|
||||||
|
color: red ;
|
||||||
|
font-weight: bold ;
|
||||||
|
font-family: sans-serif }
|
||||||
|
|
||||||
|
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||||
|
compound paragraphs.
|
||||||
|
div.compound .compound-first, div.compound .compound-middle {
|
||||||
|
margin-bottom: 0.5em }
|
||||||
|
|
||||||
|
div.compound .compound-last, div.compound .compound-middle {
|
||||||
|
margin-top: 0.5em }
|
||||||
|
*/
|
||||||
|
|
||||||
|
div.dedication {
|
||||||
|
margin: 2em 5em ;
|
||||||
|
text-align: center ;
|
||||||
|
font-style: italic }
|
||||||
|
|
||||||
|
div.dedication p.topic-title {
|
||||||
|
font-weight: bold ;
|
||||||
|
font-style: normal }
|
||||||
|
|
||||||
|
div.figure {
|
||||||
|
margin-left: 2em ;
|
||||||
|
margin-right: 2em }
|
||||||
|
|
||||||
|
div.footer, div.header {
|
||||||
|
clear: both;
|
||||||
|
font-size: smaller }
|
||||||
|
|
||||||
|
div.line-block {
|
||||||
|
display: block ;
|
||||||
|
margin-top: 1em ;
|
||||||
|
margin-bottom: 1em }
|
||||||
|
|
||||||
|
div.line-block div.line-block {
|
||||||
|
margin-top: 0 ;
|
||||||
|
margin-bottom: 0 ;
|
||||||
|
margin-left: 1.5em }
|
||||||
|
|
||||||
|
div.sidebar {
|
||||||
|
margin: 0 0 0.5em 1em ;
|
||||||
|
border: medium outset ;
|
||||||
|
padding: 1em ;
|
||||||
|
background-color: #ffffee ;
|
||||||
|
width: 40% ;
|
||||||
|
float: right ;
|
||||||
|
clear: right }
|
||||||
|
|
||||||
|
div.sidebar p.rubric {
|
||||||
|
font-family: sans-serif ;
|
||||||
|
font-size: medium }
|
||||||
|
|
||||||
|
div.system-messages {
|
||||||
|
margin: 5em }
|
||||||
|
|
||||||
|
div.system-messages h1 {
|
||||||
|
color: red }
|
||||||
|
|
||||||
|
div.system-message {
|
||||||
|
border: medium outset ;
|
||||||
|
padding: 1em }
|
||||||
|
|
||||||
|
div.system-message p.system-message-title {
|
||||||
|
color: red ;
|
||||||
|
font-weight: bold }
|
||||||
|
|
||||||
|
div.topic {
|
||||||
|
margin: 2em }
|
||||||
|
|
||||||
|
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||||
|
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||||
|
margin-top: 0.4em }
|
||||||
|
|
||||||
|
h1.title {
|
||||||
|
text-align: center }
|
||||||
|
|
||||||
|
h2.subtitle {
|
||||||
|
text-align: center }
|
||||||
|
|
||||||
|
hr.docutils {
|
||||||
|
width: 75% }
|
||||||
|
|
||||||
|
img.align-left, .figure.align-left, object.align-left {
|
||||||
|
clear: left ;
|
||||||
|
float: left ;
|
||||||
|
margin-right: 1em }
|
||||||
|
|
||||||
|
img.align-right, .figure.align-right, object.align-right {
|
||||||
|
clear: right ;
|
||||||
|
float: right ;
|
||||||
|
margin-left: 1em }
|
||||||
|
|
||||||
|
img.align-center, .figure.align-center, object.align-center {
|
||||||
|
display: block;
|
||||||
|
margin-left: auto;
|
||||||
|
margin-right: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
.align-left {
|
||||||
|
text-align: left }
|
||||||
|
|
||||||
|
.align-center {
|
||||||
|
clear: both ;
|
||||||
|
text-align: center }
|
||||||
|
|
||||||
|
.align-right {
|
||||||
|
text-align: right }
|
||||||
|
|
||||||
|
/* reset inner alignment in figures */
|
||||||
|
div.align-right {
|
||||||
|
text-align: inherit }
|
||||||
|
|
||||||
|
/* div.align-center * { */
|
||||||
|
/* text-align: left } */
|
||||||
|
|
||||||
|
ol.simple, ul.simple {
|
||||||
|
margin-bottom: 1em }
|
||||||
|
|
||||||
|
ol.arabic {
|
||||||
|
list-style: decimal }
|
||||||
|
|
||||||
|
ol.loweralpha {
|
||||||
|
list-style: lower-alpha }
|
||||||
|
|
||||||
|
ol.upperalpha {
|
||||||
|
list-style: upper-alpha }
|
||||||
|
|
||||||
|
ol.lowerroman {
|
||||||
|
list-style: lower-roman }
|
||||||
|
|
||||||
|
ol.upperroman {
|
||||||
|
list-style: upper-roman }
|
||||||
|
|
||||||
|
p.attribution {
|
||||||
|
text-align: right ;
|
||||||
|
margin-left: 50% }
|
||||||
|
|
||||||
|
p.caption {
|
||||||
|
font-style: italic }
|
||||||
|
|
||||||
|
p.credits {
|
||||||
|
font-style: italic ;
|
||||||
|
font-size: smaller }
|
||||||
|
|
||||||
|
p.label {
|
||||||
|
white-space: nowrap }
|
||||||
|
|
||||||
|
p.rubric {
|
||||||
|
font-weight: bold ;
|
||||||
|
font-size: larger ;
|
||||||
|
color: maroon ;
|
||||||
|
text-align: center }
|
||||||
|
|
||||||
|
p.sidebar-title {
|
||||||
|
font-family: sans-serif ;
|
||||||
|
font-weight: bold ;
|
||||||
|
font-size: larger }
|
||||||
|
|
||||||
|
p.sidebar-subtitle {
|
||||||
|
font-family: sans-serif ;
|
||||||
|
font-weight: bold }
|
||||||
|
|
||||||
|
p.topic-title {
|
||||||
|
font-weight: bold }
|
||||||
|
|
||||||
|
pre.address {
|
||||||
|
margin-bottom: 0 ;
|
||||||
|
margin-top: 0 ;
|
||||||
|
font: inherit }
|
||||||
|
|
||||||
|
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||||
|
margin-left: 2em ;
|
||||||
|
margin-right: 2em }
|
||||||
|
|
||||||
|
pre.code .ln { color: grey; } /* line numbers */
|
||||||
|
pre.code, code { background-color: #eeeeee }
|
||||||
|
pre.code .comment, code .comment { color: #5C6576 }
|
||||||
|
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||||
|
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||||
|
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||||
|
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||||
|
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||||
|
|
||||||
|
span.classifier {
|
||||||
|
font-family: sans-serif ;
|
||||||
|
font-style: oblique }
|
||||||
|
|
||||||
|
span.classifier-delimiter {
|
||||||
|
font-family: sans-serif ;
|
||||||
|
font-weight: bold }
|
||||||
|
|
||||||
|
span.interpreted {
|
||||||
|
font-family: sans-serif }
|
||||||
|
|
||||||
|
span.option {
|
||||||
|
white-space: nowrap }
|
||||||
|
|
||||||
|
span.pre {
|
||||||
|
white-space: pre }
|
||||||
|
|
||||||
|
span.problematic {
|
||||||
|
color: red }
|
||||||
|
|
||||||
|
span.section-subtitle {
|
||||||
|
/* font-size relative to parent (h1..h6 element) */
|
||||||
|
font-size: 80% }
|
||||||
|
|
||||||
|
table.citation {
|
||||||
|
border-left: solid 1px gray;
|
||||||
|
margin-left: 1px }
|
||||||
|
|
||||||
|
table.docinfo {
|
||||||
|
margin: 2em 4em }
|
||||||
|
|
||||||
|
table.docutils {
|
||||||
|
margin-top: 0.5em ;
|
||||||
|
margin-bottom: 0.5em }
|
||||||
|
|
||||||
|
table.footnote {
|
||||||
|
border-left: solid 1px black;
|
||||||
|
margin-left: 1px }
|
||||||
|
|
||||||
|
table.docutils td, table.docutils th,
|
||||||
|
table.docinfo td, table.docinfo th {
|
||||||
|
padding-left: 0.5em ;
|
||||||
|
padding-right: 0.5em ;
|
||||||
|
vertical-align: top }
|
||||||
|
|
||||||
|
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||||
|
font-weight: bold ;
|
||||||
|
text-align: left ;
|
||||||
|
white-space: nowrap ;
|
||||||
|
padding-left: 0 }
|
||||||
|
|
||||||
|
/* "booktabs" style (no vertical lines) */
|
||||||
|
table.docutils.booktabs {
|
||||||
|
border: 0px;
|
||||||
|
border-top: 2px solid;
|
||||||
|
border-bottom: 2px solid;
|
||||||
|
border-collapse: collapse;
|
||||||
|
}
|
||||||
|
table.docutils.booktabs * {
|
||||||
|
border: 0px;
|
||||||
|
}
|
||||||
|
table.docutils.booktabs th {
|
||||||
|
border-bottom: thin solid;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||||
|
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||||
|
font-size: 100% }
|
||||||
|
|
||||||
|
ul.auto-toc {
|
||||||
|
list-style-type: none }
|
||||||
|
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div class="document" id="prefetch-autocomplete-offers">
|
||||||
|
<h1 class="title">Prefetch autocomplete offers</h1>
|
||||||
|
|
||||||
|
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||||
|
!! This file is generated by oca-gen-addon-readme !!
|
||||||
|
!! changes will be overwritten. !!
|
||||||
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||||
|
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-10-0/web-10-0-web_search_autocomplete_prefetch"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/10.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||||
|
<p>When searching, the autocomplete options can be a bit frustrating because you
|
||||||
|
will be offered choices that won’t yield a result. This addon searches for the
|
||||||
|
term in the background and only offers an option if this search has a result.</p>
|
||||||
|
<p><strong>Table of contents</strong></p>
|
||||||
|
<div class="contents local topic" id="contents">
|
||||||
|
<ul class="simple">
|
||||||
|
<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
|
||||||
|
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
|
||||||
|
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
|
||||||
|
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
|
||||||
|
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
|
||||||
|
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
|
||||||
|
</ul>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="configuration">
|
||||||
|
<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
|
||||||
|
<ul>
|
||||||
|
<li><p class="first">some searches (especially via function fields) can be very heavy on the
|
||||||
|
server.
|
||||||
|
To disable prefetching on a per field basis, set the option
|
||||||
|
<cite>web_search_autocomplete_prefetch.disable</cite>:</p>
|
||||||
|
<pre class="literal-block">
|
||||||
|
options="{'web_search_autocomplete_prefetch.disable': true}"
|
||||||
|
</pre>
|
||||||
|
<p>on your field in the search view.</p>
|
||||||
|
</li>
|
||||||
|
<li><p class="first">by default, the addon triggers a search 350 milliseconds after the last key
|
||||||
|
press. If you want a different timeout, set the parameter
|
||||||
|
<tt class="docutils literal">web_search_autocomplete_prefetch.keypress_timeout</tt> to the amount of
|
||||||
|
milliseconds you need as timeout.</p>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="bug-tracker">
|
||||||
|
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
|
||||||
|
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
|
||||||
|
In case of trouble, please check there if your issue has already been reported.
|
||||||
|
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||||||
|
<a class="reference external" href="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**">feedback</a>.</p>
|
||||||
|
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="credits">
|
||||||
|
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
|
||||||
|
<div class="section" id="authors">
|
||||||
|
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Therp BV</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="contributors">
|
||||||
|
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
|
||||||
|
<ul class="simple">
|
||||||
|
<li>Holger Brunn <<a class="reference external" href="mailto:hbrunn@therp.nl">hbrunn@therp.nl</a>></li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="maintainers">
|
||||||
|
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
|
||||||
|
<p>This module is maintained by the OCA.</p>
|
||||||
|
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||||
|
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||||||
|
mission is to support the collaborative development of Odoo features and
|
||||||
|
promote its widespread use.</p>
|
||||||
|
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/10.0/web_search_autocomplete_prefetch">OCA/web</a> project on GitHub.</p>
|
||||||
|
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -1,127 +1,144 @@
|
||||||
//-*- coding: utf-8 -*-
|
//-*- coding: utf-8 -*-
|
||||||
//© 2015 Therp BV <http://therp.nl>
|
//Copyright 2015-2018 Therp BV <http://therp.nl>
|
||||||
//License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
//License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
|
||||||
|
odoo.define('web_search_autocomplete_prefetch', function(require) {
|
||||||
|
var CompoundDomain = require('web.data').CompoundDomain,
|
||||||
|
Mutex = require('web.utils').Mutex;
|
||||||
|
|
||||||
openerp.web_search_autocomplete_prefetch = function(instance)
|
var complete = function(self, value, data) {
|
||||||
{
|
if(self.options['web_search_autocomplete_prefetch.disable']) {
|
||||||
// overwrite this or use it to recycle the functionality for your own field
|
|
||||||
openerp.web_search_autocomplete_prefetch.complete = function(self, value, data)
|
|
||||||
{
|
|
||||||
if(self.options['web_search_autocomplete_prefetch.disable'])
|
|
||||||
{
|
|
||||||
return data;
|
return data;
|
||||||
}
|
}
|
||||||
if(!self.autocomplete_mutex)
|
if(!self.autocomplete_mutex) {
|
||||||
{
|
self.autocomplete_mutex = new Mutex();
|
||||||
self.autocomplete_mutex = new instance.Mutex()
|
|
||||||
}
|
}
|
||||||
var facet = {
|
var facet = {
|
||||||
get: function(name)
|
get: function(name) {
|
||||||
{
|
switch(name) {
|
||||||
switch(name)
|
|
||||||
{
|
|
||||||
case 'label': return value;
|
case 'label': return value;
|
||||||
case 'value': return value;
|
case 'value': return value;
|
||||||
case 'operator': return 'ilike';
|
case 'operator': return 'ilike';
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
attributes: {
|
||||||
|
value: value,
|
||||||
},
|
},
|
||||||
domain = new instance.web.CompoundDomain(
|
},
|
||||||
|
domain = new CompoundDomain(
|
||||||
self.get_domain({values: [facet]}),
|
self.get_domain({values: [facet]}),
|
||||||
self.view.dataset.domain);
|
self.searchview.dataset.domain
|
||||||
domain.set_eval_context(self.view.dataset.get_context());
|
);
|
||||||
return self.autocomplete_mutex.exec(function()
|
domain.set_eval_context(self.searchview.dataset.get_context());
|
||||||
{
|
return self.autocomplete_mutex.exec(function() {
|
||||||
return self.view.dataset._model.call(
|
return self.searchview.dataset._model.call(
|
||||||
'search_count', [domain.eval()],
|
'search_count', [domain.eval()],
|
||||||
{context: self.view.dataset.get_context()})
|
{context: self.searchview.dataset.get_context()}
|
||||||
.then(function(count)
|
)
|
||||||
{
|
.then(function(count) {
|
||||||
if(count)
|
if(count) {
|
||||||
{
|
_.each(data, function(obj) {
|
||||||
_.each(data, function(obj)
|
|
||||||
{
|
|
||||||
obj.label += _.str.sprintf(' (%s)', count);
|
obj.label += _.str.sprintf(' (%s)', count);
|
||||||
});
|
});
|
||||||
return data;
|
return data;
|
||||||
}
|
}
|
||||||
else
|
|
||||||
{
|
|
||||||
return null;
|
return null;
|
||||||
}
|
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
}
|
};
|
||||||
|
|
||||||
instance.web.search.CharField.include({
|
return {
|
||||||
init: function()
|
// overwrite this or use it to recycle the functionality
|
||||||
{
|
// for your own field
|
||||||
|
complete: complete,
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
odoo.define('web_search_autocomplete_prefetch.inputs', function(require) {
|
||||||
|
var AutoComplete = require('web.AutoComplete'),
|
||||||
|
Field = require('web.search_inputs').Field,
|
||||||
|
Model = require('web.Model'),
|
||||||
|
pyeval = require('web.pyeval'),
|
||||||
|
search_widgets_registry = require('web.core').search_widgets_registry,
|
||||||
|
web_search_autocomplete_prefetch = require(
|
||||||
|
'web_search_autocomplete_prefetch'
|
||||||
|
);
|
||||||
|
|
||||||
|
Field.include({
|
||||||
|
init: function() {
|
||||||
var result = this._super.apply(this, arguments);
|
var result = this._super.apply(this, arguments);
|
||||||
this.options = instance.web.py_eval(this.attrs.options || '{}');
|
this.options = pyeval.py_eval(this.attrs.options || '{}');
|
||||||
return result;
|
return result;
|
||||||
},
|
},
|
||||||
complete: function(value)
|
});
|
||||||
{
|
|
||||||
|
search_widgets_registry.get('char').include({
|
||||||
|
complete: function(value) {
|
||||||
var self = this;
|
var self = this;
|
||||||
return this._super.apply(this, arguments).then(function(data)
|
return this._super.apply(this, arguments).then(function(data) {
|
||||||
{
|
return web_search_autocomplete_prefetch.complete(
|
||||||
return openerp.web_search_autocomplete_prefetch.complete(
|
self, value, data
|
||||||
self, value, data);
|
);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
instance.web.search.ManyToOneField.include({
|
search_widgets_registry.get('many2one').include({
|
||||||
complete: function(value)
|
complete: function(value) {
|
||||||
{
|
|
||||||
var self = this;
|
var self = this;
|
||||||
return this._super.apply(this, arguments).then(function(data)
|
return this._super.apply(this, arguments).then(function(data) {
|
||||||
{
|
return web_search_autocomplete_prefetch.complete(
|
||||||
return openerp.web_search_autocomplete_prefetch.complete(
|
self, value, data
|
||||||
self, value, data);
|
);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
|
||||||
instance.web.search.AutoComplete.include({
|
search_widgets_registry.get('selection').include({
|
||||||
|
complete: function(value) {
|
||||||
|
var self = this;
|
||||||
|
return this._super.apply(this, arguments).then(function(data) {
|
||||||
|
return web_search_autocomplete_prefetch.complete(
|
||||||
|
self, value, data
|
||||||
|
);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
AutoComplete.include({
|
||||||
keypress_timeout: 350,
|
keypress_timeout: 350,
|
||||||
start: function()
|
start: function() {
|
||||||
{
|
|
||||||
var self = this;
|
var self = this;
|
||||||
return jQuery.when(
|
return jQuery.when(
|
||||||
this._super.apply(this, arguments),
|
this._super.apply(this, arguments),
|
||||||
new instance.web.Model('ir.config_parameter').call(
|
new Model('ir.config_parameter').call(
|
||||||
'get_param',
|
'get_param',
|
||||||
[
|
[
|
||||||
'web_search_autocomplete_prefetch.keypress_timeout',
|
'web_search_autocomplete_prefetch.keypress_timeout',
|
||||||
this.keypress_timeout
|
this.keypress_timeout
|
||||||
]
|
]
|
||||||
).then(function(keypress_timeout)
|
).then(function(keypress_timeout) {
|
||||||
{
|
self.keypress_timeout = parseInt(keypress_timeout, 10);
|
||||||
self.keypress_timeout = parseInt(keypress_timeout);
|
|
||||||
})
|
})
|
||||||
);
|
);
|
||||||
},
|
},
|
||||||
select_item: function()
|
select_item: function() {
|
||||||
{
|
if(!this.current_result) {
|
||||||
if(!this.current_result)
|
|
||||||
{
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
return this._super.apply(this, arguments);
|
return this._super.apply(this, arguments);
|
||||||
},
|
},
|
||||||
initiate_search: function(query)
|
initiate_search: function(query) {
|
||||||
{
|
|
||||||
var self = this,
|
var self = this,
|
||||||
_super = this._super,
|
_super = this._super,
|
||||||
last_timeout = null;
|
last_timeout = null;
|
||||||
this.last_timeout = last_timeout = window.setTimeout(function()
|
this.last_timeout = last_timeout = window.setTimeout(
|
||||||
{
|
function() {
|
||||||
if(self.last_timeout == last_timeout)
|
if(self.last_timeout === last_timeout) {
|
||||||
{
|
|
||||||
_super.apply(self, [query]);
|
_super.apply(self, [query]);
|
||||||
}
|
}
|
||||||
}, this.keypress_timeout)
|
},
|
||||||
|
this.keypress_timeout
|
||||||
|
);
|
||||||
},
|
},
|
||||||
});
|
});
|
||||||
}
|
});
|
||||||
|
|
|
||||||
|
|
@ -1,16 +1,12 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<openerp>
|
<odoo>
|
||||||
<data>
|
|
||||||
<record model="ir.ui.view" id="view_view_search_autocomplete">
|
<record model="ir.ui.view" id="view_view_search_autocomplete">
|
||||||
<field name="model">ir.ui.view</field>
|
<field name="model">ir.ui.view</field>
|
||||||
<field name="inherit_id" ref="base.view_view_search"/>
|
<field name="inherit_id" ref="base.view_view_search"/>
|
||||||
<field name="arch" type="xml">
|
<field name="arch" type="xml">
|
||||||
|
|
||||||
<field name="name" position="attributes">
|
<field name="name" position="attributes">
|
||||||
<attribute name="options">{'web_search_autocomplete_prefetch.disable': true}</attribute>
|
<attribute name="options" translation="off">{'web_search_autocomplete_prefetch.disable': true}</attribute>
|
||||||
</field>
|
</field>
|
||||||
|
|
||||||
</field>
|
</field>
|
||||||
</record>
|
</record>
|
||||||
</data>
|
</odoo>
|
||||||
</openerp>
|
|
||||||
|
|
|
||||||
|
|
@ -1,10 +1,8 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
<openerp>
|
<odoo>
|
||||||
<data>
|
|
||||||
<template id="assets_backend" name="web_search_autocomplete_prefetch assets" inherit_id="web.assets_backend">
|
<template id="assets_backend" name="web_search_autocomplete_prefetch assets" inherit_id="web.assets_backend">
|
||||||
<xpath expr="." position="inside">
|
<xpath expr="." position="inside">
|
||||||
<script type="text/javascript" src="/web_search_autocomplete_prefetch/static/src/js/web_search_autocomplete_prefetch.js"></script>
|
<script type="text/javascript" src="/web_search_autocomplete_prefetch/static/src/js/web_search_autocomplete_prefetch.js"></script>
|
||||||
</xpath>
|
</xpath>
|
||||||
</template>
|
</template>
|
||||||
</data>
|
</odoo>
|
||||||
</openerp>
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue