[ADD] developer: scroller service added #1313
Conversation
There was a problem hiding this comment.
hmm, it's not a part of the scroller service, is it?
There was a problem hiding this comment.
It is not, so I don't know if and were I could document that
There was a problem hiding this comment.
@ged-odoo I removed it. Is it better now?
Iucapad
force-pushed
the
15.0-scroller-service-luvi
branch
3 times, most recently
from
976411f to
4d23086
Compare
| - Technical name: `scroller` | ||
| - Dependencies: none | ||
|
|
||
| Provides a way to handle scrolls to anchors in the webclient. |
There was a problem hiding this comment.
maybe clearer to explain what it does. Suggestion: Replace the 2 lines with:
Whenever the user clicks on an anchor in the web client, this service automatically scrolls
to the target (if appropriate).
| Provides a way to handle scrolls to anchors in the webclient. | ||
| This service is used whenever a click occurs on the webclient. | ||
|
|
||
| The service adds an event listener to get `click`'s on the document. The service is then |
There was a problem hiding this comment.
use present tense: is then checking => checks
|
|
||
| The service adds an event listener to get `click`'s on the document. The service is then | ||
| checking if the selector contained in its href attribute is valid to distinguish anchors and Odoo | ||
| actions (e.g. ``<a href="#target_element"></a>``). It returns nothing if it is not the case. |
There was a problem hiding this comment.
it does not returns nothing. it just does nothing.
| checking if the selector contained in its href attribute is valid to distinguish anchors and Odoo | ||
| actions (e.g. ``<a href="#target_element"></a>``). It returns nothing if it is not the case. | ||
|
|
||
| An event ``SCROLLER:ANCHOR_LINK_CLICKED`` is triggered on the main application bus. That event contains a |
There was a problem hiding this comment.
If the click seems to be targeted at an element, then an event ...
| An event ``SCROLLER:ANCHOR_LINK_CLICKED`` is triggered on the main application bus. That event contains a | ||
| custom event containing the `element` matching and its `id` to notify other parts that may need to handle | ||
| an anchor behavior themselves. The original event is also given as it might need to be prevented. Otherwise, | ||
| the ``scrollTo`` function is used to handle the scroll to the correct element directly in the service. |
There was a problem hiding this comment.
here and elsewhere: you can use single quote instead of double quote
|
|
||
| An event ``SCROLLER:ANCHOR_LINK_CLICKED`` is triggered on the main application bus. That event contains a | ||
| custom event containing the `element` matching and its `id` to notify other parts that may need to handle | ||
| an anchor behavior themselves. The original event is also given as it might need to be prevented. Otherwise, |
There was a problem hiding this comment.
replace Otherwise with: `If the event is not prevented, then the user interface will scroll to the target element.
No need to explain that it uses the scrollto function. this is an internal implementation detail
Iucapad
force-pushed
the
15.0-scroller-service-luvi
branch
from
4d23086 to
31d299b
Compare
|
@robodoo delegate=ged-odoo |
This commit adds the documentation related to the scroller service. This service is used for the webclient to handle clicks on links and there were no documentation related until now.
Iucapad
force-pushed
the
15.0-scroller-service-luvi
branch
from
31d299b to
f809e7b
Compare
|
@robodoo r+ |
|
I'm sorry, @Iucapad. I must know your email before you can review PRs. Please contact an administrator. |
|
robodoo r+ |
|
|
This commit adds the documentation related to
the scroller service. This service is used for
the webclient to handle clicks on links and there
were no documentation related until now.