mirror of https://github.com/OCA/web.git
139 lines
4.4 KiB
ReStructuredText
139 lines
4.4 KiB
ReStructuredText
=======================
|
|
Web URL widget advanced
|
|
=======================
|
|
|
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! 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-LGPL--3-blue.png
|
|
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
|
|
:alt: License: LGPL-3
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
|
|
:target: https://github.com/OCA/web/tree/13.0/web_widget_url_advanced
|
|
:alt: OCA/web
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
|
:target: https://translation.odoo-community.org/projects/web-13-0/web-13-0-web_widget_url_advanced
|
|
: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/13.0
|
|
:alt: Try me on Runbot
|
|
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
|
|
|
Extend URL widget features to ease customization of anchor's text.
|
|
|
|
By default, the URL widget will show the plain URL.
|
|
You can specify an attribute to provide a static label too.
|
|
|
|
With this module, you can use a field for link's inner text using attribute
|
|
'text_field'. You can also add a prefix to the link using attribute
|
|
'prefix_name'.
|
|
|
|
Until 13.0 this functionality was separated in modules 'web_widget_url_advanced'
|
|
and 'web_widget_prefixed_url'
|
|
|
|
**Table of contents**
|
|
|
|
.. contents::
|
|
:local:
|
|
|
|
Usage
|
|
=====
|
|
|
|
Use `url` widget as you do usually, then add an extra parameter `text_field`
|
|
to indicate which field (present in the view already) must be used for the anchor text.
|
|
|
|
|
|
.. code-block:: xml
|
|
|
|
<field name="some_url" widget="url" text_field="another_field" />
|
|
|
|
M2O fields are supported: `display_name` is used automatically.
|
|
|
|
|
|
For example, in the partner form,
|
|
if you want to display the website link with partner's name as anchor you can do:
|
|
|
|
|
|
.. code-block:: xml
|
|
|
|
<field name="website" widget="url" text_field="name" placeholder="e.g. www.odoo.com"/>
|
|
|
|
This is going to change the rendering from
|
|
|
|
.. figure:: https://raw.githubusercontent.com/OCA/web/13.0/web_widget_url_advanced/static/description/before.png
|
|
|
|
|
|
to
|
|
|
|
.. figure:: https://raw.githubusercontent.com/OCA/web/13.0/web_widget_url_advanced/static/description/after.png
|
|
|
|
Or user can add any hyperlink text using 'prefix_name' attribute
|
|
|
|
.. code-block:: xml
|
|
|
|
<field name="skype_name" widget="url" 'prefix_name': 'skype'/>
|
|
|
|
both can be applied inside the options attribute too:
|
|
|
|
.. code-block:: xml
|
|
|
|
<field name="skype_name" widget="url" options="{'prefix_name': 'skype'}"/>
|
|
|
|
Known issues / Roadmap
|
|
======================
|
|
|
|
* ``<field text_field="foo"/>`` is not supported in tree views.
|
|
|
|
Bug Tracker
|
|
===========
|
|
|
|
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.
|
|
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
|
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_url_advanced%0Aversion:%2013.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
|
|
=======
|
|
|
|
Authors
|
|
~~~~~~~
|
|
|
|
* Camptocamp
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Simone Orsi <simone.orsi@camptocamp.com>
|
|
* `CorporateHub <https://corporatehub.eu/>`__
|
|
|
|
* Alexey Pelykh <alexey.pelykh@corphub.eu>
|
|
|
|
* Jay Vora <jay.vora@serpentcs.com>
|
|
* Swapnesh Shah <s.shah.serpentcs@gmail.com>
|
|
* Joan Sisquella <joan.sisquella@forgeflow.com>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
This module is maintained by the OCA.
|
|
|
|
.. image:: https://odoo-community.org/logo.png
|
|
:alt: Odoo Community Association
|
|
:target: https://odoo-community.org
|
|
|
|
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.
|
|
|
|
This module is part of the `OCA/web <https://github.com/OCA/web/tree/13.0/web_widget_url_advanced>`_ project on GitHub.
|
|
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|