Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

License: LGPL-3

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 be used to edit the image via Darkroom in a modal.

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. 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 following:

    • minWidth

    • minHeight

    • maxWidth

    • maxHeight

    • 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 saved.

    Darkroom Modal Screenshot 1 Darkroom Modal Screenshot 2

Known Issues / Roadmap

  • Darkroom modals are currently not supported during record creation

Bug Tracker

Bugs are tracked on GitHub 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

Images

  • Odoo Community Association: Icon.

Contributors

Maintainer

Odoo Community Association

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

To contribute to this module, please visit https://odoo-community.org.

Metadata

Release files for odoo9-addon-web-widget-darkroom 9.0.1.0.1.99.dev5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for odoo9-addon-web-widget-darkroom 9.0.1.0.1.99.dev5
File Interpreter ABI Platform
odoo9_addon_web_widget_darkroom-9.0.1.0.1.99.dev5-py2-none-any.whl Python 2 none any Details

Release files / odoo9_addon_web_widget_darkroom-9.0.1.0.1.99.dev5-py2-none-any.whl

Download URL odoo9_addon_web_widget_darkroom-9.0.1.0.1.99.dev5-py2-none-any.whl
Size 128.2 kB
Tags Python 2
SHA-256 checksum
How to use checksums
96d08f924d53da382a35a9d5f60cf4360177ae71dd91bddd6c3bebbe5534a24f
BLAKE2b-256 checksum
How to use checksums
612fbce654dee26667d3c10c156e4ca4ea208b41087875f436414aad3782656b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page