Skip to content

Commit

Permalink
[MIG] web_widget_darkroom: Add migration changes
Browse files Browse the repository at this point in the history
* Remove fabric.js CDN link, source from static/lib instead
* Update python imports (openerp -> odoo)
* Remove unnecessary require('_')
* Update overlay image classes to v10
* Fix typo in readme
* Change module version number to standard (10.0.1.0.0)
* Add DarkroomJS version number to lib files
* Downgrade fabric.js (1.7.15 -> 1.6.7)
* Add Darkroomjs issue to ReadMe
  • Loading branch information
hughesbm authored and lasley committed Oct 2, 2017
1 parent cf8f89d commit bb2b144
Show file tree
Hide file tree
Showing 12 changed files with 26,160 additions and 31 deletions.
31 changes: 17 additions & 14 deletions web_widget_darkroom/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,31 @@
DarkroomJS Image Editing for Web
================================

This module provides a `DarkroomJS`_ (v2.0.1) web widget for use with image
fields. It also adds a Darkroom button to the normal image widget, which can
This module provides a `DarkroomJS`_ (v2.0.1) web widget for use with image
fields. It also adds a Darkroom button to the normal image widget, which can
be used to edit the image via Darkroom in a modal.

.. _DarkroomJS: https://github.com/MattKetmo/darkroomjs
.. _DarkroomJS: https://github.com/MattKetmo/darkroomjs

The widget currently supports the following operations and can be extended to
The widget currently supports the following operations and can be extended to
allow others:

* Zoom and pan
* Rotate
* Crop
* Step back in history client-side (before save)

Usage
=====

After installing the module, you can use it in the following ways:

* Specify the ``darkroom`` widget when adding an image field to a view.
* Specify the ``darkroom`` widget when adding an image field to a view.
Configuration values can be provided using the ``options`` attribute::

<field name="image" widget="darkroom" options="{'minWidth': 100}"/>

The widget passes options directly through to DarkroomJS, which supports the
The widget passes options directly through to DarkroomJS, which supports the
following:

* minWidth
Expand All @@ -40,9 +40,9 @@ After installing the module, you can use it in the following ways:
* ratio (aspect ratio)
* backgroundColor

* Open a form view that contains an image in edit mode and hover over the
image widget. You should see a Darkoom button that can be clicked to open
the image in a Darkroom modal, where it can be edited and the changes can be
* Open a form view that contains an image in edit mode and hover over the
image widget. You should see a Darkroom button that can be clicked to open
the image in a Darkroom modal, where it can be edited and the changes can be
saved.

.. image:: /web_widget_darkroom/static/description/modal_screenshot_1.png
Expand All @@ -59,13 +59,15 @@ Known Issues / Roadmap
======================

* Darkroom modals are currently not supported during record creation
* Fabric.js >= 1.70 is not currently supported by DarkroomJS
(`MattKetmo/darkroomjs#112 <https://github.com/MattKetmo/darkroomjs/issues/112>`_)

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_. In
case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smash it by providing detailed and welcome
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_. In
case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smash it by providing detailed and welcome
feedback.

Credits
Expand All @@ -74,14 +76,15 @@ Credits
Images
------

* Odoo Community Association:
* Odoo Community Association:
`Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.

Contributors
------------

* Dave Lasley <[email protected]>
* Oleg Bulkin <[email protected]>
* Brent Hughes <[email protected]>

Maintainer
----------
Expand Down
2 changes: 1 addition & 1 deletion web_widget_darkroom/__manifest__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
'name': 'Web DarkroomJS Image Editing',
'summary': 'Provides web widget for image editing and adds it to standard'
' image widget as modal',
'version': '10.0.1.0.1',
'version': '10.0.1.0.0',
'category': 'Web',
'website': 'https://laslabs.com/',
'author': 'LasLabs, Odoo Community Association (OCA)',
Expand Down
1 change: 1 addition & 0 deletions web_widget_darkroom/static/lib/darkroomjs/core/darkroom.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* Copyright 2013 Matthieu Moquet
* Copyright 2016-2017 LasLabs Inc.
* Version 2.0.1
* License MIT (https://opensource.org/licenses/MIT)
**/

Expand Down
1 change: 1 addition & 0 deletions web_widget_darkroom/static/lib/darkroomjs/core/plugin.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* Copyright 2013 Matthieu Moquet
* Copyright 2016-2017 LasLabs Inc.
* Version 2.0.1
* License MIT (https://opensource.org/licenses/MIT)
**/

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* Copyright 2013 Matthieu Moquet
* Copyright 2016-2017 LasLabs Inc.
* Version 2.0.1
* License MIT (https://opensource.org/licenses/MIT)
**/

Expand Down Expand Up @@ -37,7 +38,7 @@
if (protoProps) Darkroom.Utils.extend(child.prototype, protoProps);

child.__super__ = parent.prototype;

return child;
};
})();
1 change: 1 addition & 0 deletions web_widget_darkroom/static/lib/darkroomjs/core/utils.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
/**
* Copyright 2013 Matthieu Moquet
* Copyright 2016-2017 LasLabs Inc.
* Version 2.0.1
* License MIT (https://opensource.org/licenses/MIT)
**/

Expand Down
Loading

0 comments on commit bb2b144

Please sign in to comment.