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.

92 lines
2.6 KiB

  1. .. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
  3. :alt: License: LGPL-3
  4. ==============
  5. Web Responsive
  6. ==============
  7. This module provides a mobile compliant interface for Odoo Community web.
  8. Features:
  9. * New navigation with an App drawer
  10. * Keyboard shortcuts for easier navigation
  11. Installation
  12. ============
  13. Configuration
  14. =============
  15. Usage
  16. =====
  17. Keyboard Shortcuts
  18. ------------------
  19. The following keyboard shortcuts are implemented:
  20. * Toggle App Drawer - `ActionKey <https://en.wikipedia.org/wiki/Access_key#Access_in_different_browsers`_+``A``
  21. * Navigate Apps Drawer - Arrow Keys
  22. * Type to select App Links
  23. * ``esc`` to close App Drawer
  24. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  25. :alt: Try me on Runbot
  26. :target: https://runbot.odoo-community.org/runbot/154/10.0
  27. Known issues / Roadmap
  28. ======================
  29. Note: Data added to the footer ``support_branding`` is not shown while using
  30. this module.
  31. * Provide full menu search feature instead of just App search
  32. * Drag drawer from left to open in mobile
  33. * Figure out how to test focus on hidden elements for keyboard nav tests
  34. * If you resize the window, body gets a wrong ``overflow: auto`` css property
  35. and you need to refresh your view or open/close the app drawer to fix that.
  36. * Override LESS styling to allow for responsive widget layouts
  37. * Adding ``oe_main_menu_navbar`` ID to the top navigation bar triggers some
  38. great styles, but also `JavaScript that causes issues on mobile
  39. <https://github.com/OCA/web/pull/446#issuecomment-254827880>`_
  40. Bug Tracker
  41. ===========
  42. Bugs are tracked on `GitHub Issues
  43. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  44. check there if your issue has already been reported. If you spotted it first,
  45. help us smashing it by providing a detailed and welcomed feedback.
  46. Credits
  47. =======
  48. Images
  49. ------
  50. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  51. Contributors
  52. ------------
  53. * Dave Lasley <dave@laslabs.com>
  54. * Jairo Llopis <jairo.llopis@tecnativa.com>
  55. Maintainer
  56. ----------
  57. .. image:: https://odoo-community.org/logo.png
  58. :alt: Odoo Community Association
  59. :target: https://odoo-community.org
  60. This module is maintained by the OCA.
  61. OCA, or the Odoo Community Association, is a nonprofit organization whose
  62. mission is to support the collaborative development of Odoo features and
  63. promote its widespread use.
  64. To contribute to this module, please visit https://odoo-community.org.