diff --git a/web_widget_timepicker/README.rst b/web_widget_timepicker/README.rst index b3b474c5..fe0009b3 100644 --- a/web_widget_timepicker/README.rst +++ b/web_widget_timepicker/README.rst @@ -1,55 +1,72 @@ .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :alt: License: AGPL-3 + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 -============================== -Timepicker widget in form view -============================== -This module defines a timepicker widget, to be used with float fields -or (function) fields. Use ``widget='timepicker'`` in your form view -definition. It can be use as a replacement for the standard float_time widget. +=============================== +Timepicker widget in form views +=============================== -If you use the widget with a field record, the input field has the following default -timepicker options: +This module provides a timepicker widget for float fields. +It can be used as a replacement for the standard float_time widget in form views. -* By default the possible selection is based on 15 minute interval (step: 15) -* By default 24 hour mode with H:i format (timeFormat: 'H:i') -* By default scroll selection starts at current time (scrollDefault: 'now') -The widget uses the jquery.timepicker plugin by Jon Thornton +|picker| + + +The widget has the following default timepicker options: + +* the possible selection is based on 15 minute interval (step: 15) +* 24 hour mode in H:i format (timeFormat: 'H:i') +* scroll selection starts at current time (scrollDefault: 'now') + + +|formview| Usage ===== -This module defines a new widget type for form views input fileds. -Set the attribute ``widget=timepicker`` in a ``field`` tag in a form view. +In the form view declaration, put widget='timepicker' attribute in the field tag:: -You can pass custom options through the "timepicker" field in the options attribute: + ... + +
+ ... + + + ... + + + ... + +Additional jquery-timepicker plugin options can be specified by an options attribute:: ... - + ... -See the available options at https://github.com/jonthornton/jquery-timepicker#timepicker-plugin-for-jquery. +See the available options at `jquery-timepicker `_. + +.. |picker| image:: ./images/picker.png +.. |formview| image:: ./images/form_view.png Known issues / Roadmap ====================== -* Absolutely no sanity check or validation on options. +* No validation on options. Credits ======= -Jon Thornton (https://cdnjs.com/libraries/jquery-timepicker) -jquery.timepicker plugin - This software is made available under the open source MIT License. © 2014 Jon Thornton and contributors +* The module uses the `jquery-timepicker `_ plugin by Jon Thornton. This software is made available under the open source MIT License. © 2014 Jon Thornton and contributors -Odoo Community Association (OCA) +* Odoo Community Association (OCA) Contributors ------------ -* Michael Fried +* Michael Fried diff --git a/web_widget_timepicker/__openerp__.py b/web_widget_timepicker/__openerp__.py index d2cdeb42..634dd98a 100644 --- a/web_widget_timepicker/__openerp__.py +++ b/web_widget_timepicker/__openerp__.py @@ -1,32 +1,29 @@ # -*- coding: utf-8 -*- -# © 2016 Michael Fried @ Vividlab () +# © 2016 Vividlab () # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). - { - 'name': 'Web Timepicker Widget', - 'version': '9.0.1.0.0', - 'author': 'Michael Fried@Vividlab, Odoo Community Association (OCA)', - 'license': 'AGPL-3', - 'category': 'Web', - 'website': 'https://github.com/OCA/Web', - - 'depends': [ - 'web' - ], - 'css': [ - 'static/src/lib/jquery.timerpicker/jquery.timepicker.css', - 'static/src/css/web_widget_timepicker.css' + "name": "Web Timepicker Widget", + "version": "9.0.1.0.0", + "author": "VividLab, Odoo Community Association (OCA)", + "license": "AGPL-3", + "category": "Web", + "website": "http://www.vividlab.de", + "installable": True, + "depends": [ + "web", ], - 'js': [ - 'static/src/lib/jquery.timerpicker/jquery.timepicker.js', - 'static/src/js/web_widget_timepicker.js', + "css": [ + "static/src/lib/jquery.timerpicker/jquery.timepicker.css", + "static/src/css/web_widget_timepicker.css", ], - 'qweb': [ - 'static/src/xml/web_widget_timepicker.xml' + "js": [ + "static/src/lib/jquery.timerpicker/jquery.timepicker.js", + "static/src/js/web_widget_timepicker.js", ], - 'data': [ - 'views/web_widget_timepicker_assets.xml' + "data": [ + "views/web_widget_timepicker_assets.xml", ], - - "installable": True, + "qweb": [ + "static/src/xml/web_widget_timepicker.xml", + ] } diff --git a/web_widget_timepicker/images/form_view.png b/web_widget_timepicker/images/form_view.png new file mode 100644 index 00000000..1feae7a1 Binary files /dev/null and b/web_widget_timepicker/images/form_view.png differ diff --git a/web_widget_timepicker/images/picker.png b/web_widget_timepicker/images/picker.png new file mode 100644 index 00000000..1dda86ee Binary files /dev/null and b/web_widget_timepicker/images/picker.png differ diff --git a/web_widget_timepicker/static/description/icon.png b/web_widget_timepicker/static/description/icon.png index 3a0328b5..91216607 100644 Binary files a/web_widget_timepicker/static/description/icon.png and b/web_widget_timepicker/static/description/icon.png differ