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.

159 lines
5.5 KiB

  1. ==============
  2. Web Responsive
  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-LGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  13. :alt: License: LGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/12.0/web_responsive
  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-12-0/web-12-0-web_responsive
  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/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module adds responsiveness to web backend.
  25. Features for all devices:
  26. * New navigation with an app drawer
  27. .. image:: https://user-images.githubusercontent.com/973709/48417193-09a1e080-e74a-11e8-8a0c-e73eb689b2fb.gif
  28. * Quick menu search from the app drawer
  29. .. image:: https://user-images.githubusercontent.com/973709/48417213-17576600-e74a-11e8-846a-57691e82636b.gif
  30. Features for mobile:
  31. * App-specific submenus are shown on full screen when toggling them from the
  32. "hamburger" menu
  33. .. image:: https://user-images.githubusercontent.com/973709/48417297-51286c80-e74a-11e8-9a47-22c810b18c43.gif
  34. * View type picker dropdown displays confortably
  35. .. image:: https://user-images.githubusercontent.com/973709/50964322-e3d55580-14c6-11e9-8249-48db9539600f.gif
  36. * Top app bar is always visible, but the control panel is hidden when
  37. scrolling down, to save some vaulable vertical space
  38. .. image:: https://user-images.githubusercontent.com/973709/50964496-5cd4ad00-14c7-11e9-9261-fd223a329d02.gif
  39. * Form status bar action and status buttons are collapsed in dropdowns.
  40. Other control panel buttons use icons to save space.
  41. .. image:: https://user-images.githubusercontent.com/973709/50965446-e08f9900-14c9-11e9-92d6-dda472cb6557.gif
  42. * Breadcrumbs navigation is collapsed with a "back arrow" button.
  43. .. image:: https://user-images.githubusercontent.com/973709/50965168-1d0ec500-14c9-11e9-82a0-dfee82ed0861.gif
  44. Features for computers:
  45. * Keyboard shortcuts for easier navigation, **using ``Alt + Shift + [key]``**
  46. combination instead of just ``Alt + [key]``.
  47. See https://github.com/odoo/odoo/issues/30068 to understand why.
  48. .. image:: https://user-images.githubusercontent.com/973709/48417578-ff341680-e74a-11e8-8881-017709e912bc.png
  49. * Autofocus on search menu box when opening the drawer
  50. .. image:: https://user-images.githubusercontent.com/973709/48417213-17576600-e74a-11e8-846a-57691e82636b.gif
  51. * Set chatter on the side of the screen, optional per user
  52. .. image:: https://user-images.githubusercontent.com/973709/48417270-41108d00-e74a-11e8-9172-cba825d027ed.gif
  53. * Full width form sheets
  54. .. image:: https://user-images.githubusercontent.com/973709/48417428-ac5a5f00-e74a-11e8-8839-5bc538c54c1d.png
  55. * Sticky chatter topbar
  56. .. image:: https://raw.githubusercontent.com/OCA/web/12.0/web_responsive/static/img/chatter_topbar.gif
  57. **Table of contents**
  58. .. contents::
  59. :local:
  60. Usage
  61. =====
  62. The following keyboard shortcuts are implemented:
  63. * Toggle app drawer - ``Alt + Shift + H``
  64. * Navigate app search results - Arrow keys
  65. * Choose app result - ``Enter``
  66. * ``Esc`` to close app drawer
  67. Known issues / Roadmap
  68. ======================
  69. * To view the full experience in a device, the page must be loaded with the
  70. device screen size. This means that, if you change the size of your browser,
  71. you should reload the web client to get the full experience for that
  72. new size. This is Odoo's own limitation.
  73. * App navigation with keyboard.
  74. * Make it more beautiful. Maybe OCA-branded?
  75. Bug Tracker
  76. ===========
  77. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  78. In case of trouble, please check there if your issue has already been reported.
  79. If you spotted it first, help us smashing it by providing a detailed and welcomed
  80. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_responsive%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  81. Do not contact contributors directly about support or help with technical issues.
  82. Credits
  83. =======
  84. Authors
  85. ~~~~~~~
  86. * LasLabs
  87. * Tecnativa
  88. * Alexandre Díaz
  89. Contributors
  90. ~~~~~~~~~~~~
  91. * Dave Lasley <dave@laslabs.com>
  92. * Jairo Llopis <jairo.llopis@tecnativa.com>
  93. * Dennis Sluijk <d.sluijk@onestein.nl>
  94. * Sergio Teruel <sergio.teruel@tecnativa.com>
  95. * Alexandre Díaz <dev@redneboa.es>
  96. Maintainers
  97. ~~~~~~~~~~~
  98. This module is maintained by the OCA.
  99. .. image:: https://odoo-community.org/logo.png
  100. :alt: Odoo Community Association
  101. :target: https://odoo-community.org
  102. OCA, or the Odoo Community Association, is a nonprofit organization whose
  103. mission is to support the collaborative development of Odoo features and
  104. promote its widespread use.
  105. This module is part of the `OCA/web <https://github.com/OCA/web/tree/12.0/web_responsive>`_ project on GitHub.
  106. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.