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.

110 lines
3.3 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. * Display kanban views for small screens if an action or field One2x
  12. Installation
  13. ============
  14. Configuration
  15. =============
  16. Usage
  17. =====
  18. Keyboard Shortcuts
  19. ------------------
  20. The following keyboard shortcuts are implemented:
  21. * Toggle App Drawer - `ActionKey <https://en.wikipedia.org/wiki/Access_key#Access_in_different_browsers>` + ``A``
  22. * Navigate Apps Drawer - Arrow Keys
  23. * Type to select App Links
  24. * ``esc`` to close App Drawer
  25. Quick Search
  26. ------------
  27. A search feature is provided in the App Drawer, which allow for you to easily
  28. navigate menus without a mouse.
  29. To activate the search, just begin typing while within the App Drawer.
  30. You can use the arrow keys or mouse to navigate and select results, in a similar
  31. fashion to navigating the apps in the drawer.
  32. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  33. :alt: Try me on Runbot
  34. :target: https://runbot.odoo-community.org/runbot/162/10.0
  35. Known issues / Roadmap
  36. ======================
  37. Note: Data added to the footer ``support_branding`` is not shown while using
  38. this module.
  39. * Drag drawer from left to open in mobile
  40. * Figure out how to test focus on hidden elements for keyboard nav tests
  41. * Override LESS styling to allow for responsive widget layouts
  42. * Adding ``oe_main_menu_navbar`` ID to the top navigation bar triggers some
  43. great styles, but also `JavaScript that causes issues on mobile
  44. <https://github.com/OCA/web/pull/446#issuecomment-254827880>`_
  45. * The ``AppDrawer`` JavaScript object currently extends ``Class``. We should extend
  46. ``Widget`` instead.
  47. * On Android (FireFox) - clicking the search icon does not focus the search input.
  48. * On Android (FireFox & Chrome) - clicking the search query input will show the on
  49. screen keyboard for a split second, but the App Drawer immediately closes and the
  50. keyboard closes with it.
  51. Bug Tracker
  52. ===========
  53. Bugs are tracked on `GitHub Issues
  54. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  55. check there if your issue has already been reported. If you spotted it first,
  56. help us smashing it by providing a detailed and welcomed feedback.
  57. Credits
  58. =======
  59. Images
  60. ------
  61. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  62. Contributors
  63. ------------
  64. * Dave Lasley <dave@laslabs.com>
  65. * Jairo Llopis <jairo.llopis@tecnativa.com>
  66. * Dennis Sluijk <d.sluijk@onestein.nl>
  67. * Sergio Teruel <sergio.teruel@tecnativa.com>
  68. * Serpent Consulting Services Pvt. Ltd.<jay.vora@serpentcs.com>
  69. Maintainer
  70. ----------
  71. .. image:: https://odoo-community.org/logo.png
  72. :alt: Odoo Community Association
  73. :target: https://odoo-community.org
  74. This module is maintained by the OCA.
  75. OCA, or the Odoo Community Association, is a nonprofit organization whose
  76. mission is to support the collaborative development of Odoo features and
  77. promote its widespread use.
  78. To contribute to this module, please visit https://odoo-community.org.