Skip to main content

A reference browser widget (Maintainer Timon Tschanz)

Project description

ftw.referencewidget

This Widget provides a Referencebrowser and a searchfield, which allows users to select references.

The basequery is all types which are not in the types_not_searched property all modification to the allowed types are relative to this query.

Traversal or Selectability can be changed for all widgets with the IReferenceSettings registry interface or per widget with the widget parameters.

The widget takes the following parameters:
  • allow_traversal: These Types are traversable

  • block_traversal: These Types are not traversable

  • selectable: These Types are selectable

  • nonselectable: These Types are not selectable

  • start: The path first opened. Can either be a callable or a path. Additionaly the strings “parent”, “navroot”, “ploneroot” can be used.

  • allow_nonsearched_types: If this is set to true all the types will be traversable and selectable.

  • override: drops all global config and the base query if a list is passed to the widget. All types need to be added to be selectable.

IMPORTANT NOTE: Currently this widget drops the SourceBinder concept, which has huge impact on the usability.

The following combinations are supported. - RelationList with value_type Relation –> Stores a List of RelationValues - RelationList with value_type RelationChoice –> Stores a List of RelationValues - Relation –> Stores a RelationValue - List of RelationChoice –> Stores a list of absolute paths, without the portal root part - TextLine –> Stores a absolute path as string, without the portal root part

TODO

  • The SourceBinder concept needs to be implemented for better compatibility with everything/everyone else.

  • Proper Integration Tests using test behaviors with several configurations.

Screenshots

The general Listing: ![Listing](https://github.com/4teamwork/ftw.referencewidget/raw/master/docs/static/list.png) The Search Listing: ![Search Listing](https://github.com/4teamwork/ftw.referencewidget/raw/master/docs/static/search.png) The Selected Items ![Selected](https://github.com/4teamwork/ftw.referencewidget/raw/master/docs/static/selected.png)

Changelog

1.3.0 (2016-11-09)

  • Implement some sort options. [mathias.leimgruber]

  • Use plone.app.redirector to follow renamed and moved content. Also do not fail if the content has been removed. [mathias.leimgruber]

1.2.3 (2016-10-18)

  • Fix edge case (mainly for tests) if the value passed to the IList/Widget converter is not a list, but a string. [raphael-s]

1.2.2 (2016-10-18)

  • Implement testbrowser widget. [raphael-s]

1.2.1 (2016-10-17)

  • Respect missing_value set by the field. [tschanzt]

  • Implement support for ITextLine only with ReferenceWidget. [mathias.leimgruber]

1.2.0 (2016-10-04)

  • Show absolute path starting at the plone root for the selected value. [mathias.leimgruber]

  • Remove the list style type and the obsolete spacing for the selected elements. [mathias.leimgruber]

  • Implement support for IList of IRelationChoice explicitly. Check Readme for more informations [mathias.leimgruber]

1.1.0 (2016-09-27)

  • Ignore empty value for multiple value field. [mathias.leimgruber]

  • Support chameleon by not rendering handlebar templates. [jone]

1.0.4 (2016-09-19)

  • Make it possible to remove an given internal reference (radio button). [mathias.leimgruber]

  • Ignore empty value for single value field. [mathias.leimgruber]

  • Fix search by pressing the “enter” button. [mathias.leimgruber]

  • Always unbind the click event before binding a new one on the ref button. [mathias.leimgruber]

1.0.3 (2016-09-14)

  • Same as 1.0.2 but uploaded to PyPI. [mbaechtold]

1.0.2 (2016-09-14)

  • Reload Items when overlay is reloaded. [tschanzt]

  • Respect Type constraints on search. [tschanzt]

1.0.1 (2016-09-09)

  • Ignore empty strings in converter. [tschanzt]

  • Improve overlay behavior (close on click outside the overlay + close on ESC). [mathias.leimgruber]

  • Get Widget name on overlay creation. [tschanzt]

1.0.0 (2016-09-07)

  • Initial release [tschanzt]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ftw.referencewidget-1.3.0.tar.gz (601.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page