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.

123 lines
4.4 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/11.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-11-0/web-11-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/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module provides a mobile compliant interface for Odoo Community web.
  25. Features:
  26. * New navigation with an App drawer
  27. * Keyboard shortcuts for easier navigation
  28. * Display kanban views for small screens if an action or field One2x
  29. * Set chatter side (Optional per user)
  30. * Quick search
  31. **Table of contents**
  32. .. contents::
  33. :local:
  34. Usage
  35. =====
  36. The following keyboard shortcuts are implemented:
  37. * Toggle App Drawer - `ActionKey <https://en.wikipedia.org/wiki/Access_key#Access_in_different_browsers>` + ``A``
  38. * Navigate Apps Drawer - Arrow Keys
  39. * Type to select App Links
  40. * ``esc`` to close App Drawer
  41. Known issues / Roadmap
  42. ======================
  43. Note: Data added to the footer ``support_branding`` is not shown while using
  44. this module.
  45. * Provide full menu search feature instead of just App search
  46. * Drag drawer from left to open in mobile
  47. * Figure out how to test focus on hidden elements for keyboard nav tests
  48. * If you resize the window, body gets a wrong ``overflow: auto`` css property
  49. and you need to refresh your view or open/close the app drawer to fix that.
  50. * Override LESS styling to allow for responsive widget layouts
  51. * Adding ``oe_main_menu_navbar`` ID to the top navigation bar triggers some
  52. great styles, but also `JavaScript that causes issues on mobile
  53. <https://github.com/OCA/web/pull/446#issuecomment-254827880>`_
  54. * Sticky header and footer in list view only works on certain browsers:
  55. https://caniuse.com/#search=sticky (note that the used feature is in
  56. `thead`).
  57. * On Android (FireFox) - clicking the search icon does not
  58. focus the search input.
  59. * On Android (FireFox & Chrome) - clicking the search query input will
  60. show the on screen keyboard for a split second, but the App Drawer
  61. immediately closes and the keyboard closes with it.
  62. * Filter menu items completely on client-side, to make it smoother and allow
  63. users to filter on complete paths of menus and not only on the last item.
  64. Bug Tracker
  65. ===========
  66. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  67. In case of trouble, please check there if your issue has already been reported.
  68. If you spotted it first, help us smashing it by providing a detailed and welcomed
  69. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_responsive%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  70. Do not contact contributors directly about support or help with technical issues.
  71. Credits
  72. =======
  73. Authors
  74. ~~~~~~~
  75. * LasLabs
  76. * Tecnativa
  77. * Alexandre Díaz
  78. Contributors
  79. ~~~~~~~~~~~~
  80. * Dave Lasley <dave@laslabs.com>
  81. * Jairo Llopis <jairo.llopis@tecnativa.com>
  82. * Dennis Sluijk <d.sluijk@onestein.nl>
  83. * Sergio Teruel <sergio.teruel@tecnativa.com>
  84. * Alexandre Díaz <dev@redneboa.es>
  85. Maintainers
  86. ~~~~~~~~~~~
  87. This module is maintained by the OCA.
  88. .. image:: https://odoo-community.org/logo.png
  89. :alt: Odoo Community Association
  90. :target: https://odoo-community.org
  91. OCA, or the Odoo Community Association, is a nonprofit organization whose
  92. mission is to support the collaborative development of Odoo features and
  93. promote its widespread use.
  94. This module is part of the `OCA/web <https://github.com/OCA/web/tree/11.0/web_responsive>`_ project on GitHub.
  95. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.