search

plone / plone.app.widgets

Integrating plone.widgets into plone
Other
7 stars 38 forks source link

readme

Warning

2.x is only to be used with Plone 5 and 1.x is to be used in Plone 4.3.

Contents

The goal of plone.app.widgets is to provide an implementation for a new set of javascript widgets being developed outside Plone as part of Mockup_ project. It overrides explicit widgets used in dexterity and archetypes to provide tested and modularized widgets based on the concept of patterns.

.. image:: https://travis-ci.org/plone/plone.app.widgets.png?branch=master :target: https://travis-ci.org/plone/plone.app.widgets

.. image:: https://coveralls.io/repos/plone/plone.app.widgets/badge.png?branch=master :target: https://coveralls.io/r/plone/plone.app.widgets?branch=master

.. image:: https://img.shields.io/pypi/v/plone.app.widgets.svg :target: https://crate.io/packages/plone.app.widgets

.. image:: https://img.shields.io/pypi/dm/plone.app.widgets.svg :target: https://crate.io/packages/plone.app.widgets

.. image:: https://saucelabs.com/browser-matrix/plone-pa-widgets.svg :target: https://saucelabs.com/u/plone-pa-widgets

.. contents::

Is safe to use this package?

This package should be safe to install and easy to uninstall (there is also uninstall profile). That means its fairly safe to give it a try, but just in case don't forget to create backup before testing it.

As of version 1.4.0 there is quite comprehensive unittest coverage of python code as well as high coverage of our javascript code. There are also some robot tests which are testing integration with Plone, but this will be improved with future releases.

This project will be integrated with Plone 5 and will never reach version 2.0.0. You can monitor progress of PLIP here_.

If you wonder why there is no Alpha/Beta marker in version, its because version of this package is kept in sync with other projects deriving from Mockup (eg. plone.app.toolbar). Version 1.4.1 would then mean we're using Mockup version 1.4 and there was one bugfix only to the python code. Version packaged javascript inside is still in sync with Mockup project.

What is included?

The fields that are using updated widgets are:

.. - Text field (TinyMCEWidget)

All client side code (javascript/css/images) is done and tested as part of Mockup_ project.

.. image:: https://travis-ci.org/plone/mockup.png :target: https://travis-ci.org/plone/mockup :alt: Travis CI

.. image:: https://coveralls.io/repos/plone/mockup/badge.png?branch=master :target: https://coveralls.io/r/plone/mockup?branch=master :alt: Coveralls

.. image:: https://d2weczhvl823v0.cloudfront.net/plone/mockup/trend.png :target: https://bitdeli.com/free :alt: Bitdeli

For any feature / bug / comment please create an issue in the issue tracker_.

.. Mockup: http://plone.github.io/mockup .. issue tracker: https://github.com/plone/mockup/issues?labels=widgets .. PLIP here: https://dev.plone.org/ticket/13476 .. plone.app.toolbar: https://github.com/plone/plone.app.toolbar .. _plone.app.contenttypes: https://github.com/plone/plone.app.contenttypes