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.

106 lines
3.6 KiB

  1. ===================
  2. Drop target support
  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_drop_target
  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_drop_target
  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. This module extends the functionality of the web client to support dropping local files into the web client.
  25. By default, an attachment will be created when dropping a file on a form.
  26. Further, this module is meant as a base drag&drop module supporting other actions after some file is dropped so that other modules can add more features.
  27. **Table of contents**
  28. .. contents::
  29. :local:
  30. Usage
  31. =====
  32. To use this module, you need to:
  33. 1. drag a file from your local computer onto an Odoo form view
  34. 2. it should become an attachment of the currently opened record
  35. .. image:: https://raw.githubusercontent.com/web_drop_target/static/description/screenshot.png
  36. :alt: Screenshot
  37. Development
  38. ===========
  39. **Libraries**
  40. * `base64js <https://raw.githubusercontent.com/beatgammit/base64-js>`_.
  41. Known issues / Roadmap
  42. ======================
  43. * dropping on list or kanban views would be nice too
  44. * handle multiple files
  45. * add an upload progress meter for huge files
  46. * trigger custom events about different stages of the drop operation for other addons to hook in
  47. * Install document module to display attachments in the sidebar
  48. Bug Tracker
  49. ===========
  50. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  51. In case of trouble, please check there if your issue has already been reported.
  52. If you spotted it first, help us smashing it by providing a detailed and welcomed
  53. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_drop_target%0Aversion:%2010.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  54. Do not contact contributors directly about support or help with technical issues.
  55. Credits
  56. =======
  57. Authors
  58. ~~~~~~~
  59. * Therp BV
  60. Contributors
  61. ~~~~~~~~~~~~
  62. * Holger Brunn <hbrunn@therp.nl>
  63. * Pablo Fuentes <pablo@studio73.es>
  64. * Akim Juillerat <akim.juillerat@camptocamp.com>
  65. Maintainers
  66. ~~~~~~~~~~~
  67. This module is maintained by the OCA.
  68. .. image:: https://odoo-community.org/logo.png
  69. :alt: Odoo Community Association
  70. :target: https://odoo-community.org
  71. OCA, or the Odoo Community Association, is a nonprofit organization whose
  72. mission is to support the collaborative development of Odoo features and
  73. promote its widespread use.
  74. This module is part of the `OCA/web <https://github.com/OCA/web/tree/10.0/web_drop_target>`_ project on GitHub.
  75. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.