.. image:: https://travis-ci.org/collective/collective.z3cform.select2.svg?branch=master
:target: https://travis-ci.org/collective/collective.z3cform.select2
.. image:: https://coveralls.io/repos/collective/collective.z3cform.select2/badge.png?branch=master
:target: https://coveralls.io/r/collective/collective.z3cform.select2?branch=master
.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html
This text does not appear on pypi or github. It is a comment.
==========================
collective.z3cform.select2
==========================
Features
--------
- select2 multivalued facetednavigation widget for 2-level vocabulary created
with collective.taxonomy.
Select "Select2" criteria in facetednavigation and select a taxonomy.
- select2 multivalued z3c.form widget that works nice with 2-level vocabulary
created with collective.taxonomy
If you want to use the select2 widget instead the default z3cform widget for List/Set of Choice,
just include file widget/adapters.zcml in another package policy like this :
<include package="collective.z3cform.select2.widget" file="adapters.zcml" />
Theming
-------
The widget was developped initially for a bootstrap 3 theme and fontawesome.
There is a search button icon left to the select that upon click open the select.
If your site doesn't have a bootstrap based theme, you may want to add this
css rule to your project to hide the tiny button::
button[data-select2-open] { display: none; }
The z3cform widget in display mode uses the badge class, without a comma
separator so it may be confusing when you don't have style for the badge class.
You can revert to a comma separated display by including minimal.zcml instead
of configure.zcml, see Installation below.
Translations
------------
- One constant Faceted.taxonomyAllString currently in French.
Installation
------------
Install collective.z3cform.select2 by adding it to your buildout::
[buildout]
...
eggs =
collective.z3cform.select2
zcml =
collective.z3cform.select2
# or collective.z3cform.select2-minimal
and then running ``bin/buildout``
You need to install the collective.z3cform.select2 addon to register the
select2 js library. In a facetednav, add a Select2 criterion.
eea.facetednavigation
---------------------
Version 2.0.0+ is only working with eea.facetednavigation 10+.
If you need to make it work with eea.facetednavigation < 10, use versions < 2.0.0
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.z3cform.select2/issues
- Source Code: https://github.com/collective/collective.z3cform.select2
Support
-------
If you are having issues, please let us know.
License
-------
The project is licensed under the GPLv2.
Contributors
============
- Vincent Fretin [vincentfretin]
- Eric Bréhault
- Martin Peeters [mpeeters]
Changelog
=========
2.1.0 (2020-06-08)
------------------
- Make widget compatible with the latest versions of eea.faceted.vocabularies
This makes it no more compatible with eea.faceted.vocabularies < 6.7
[mpeeters]
2.0.1 (2018-08-27)
------------------
- Do not replace z3cform default widget for List/Set of Choice by
select2 widget by default. The widget/adapters.zcml will need to be included
manually so this behavior is applied.
[gbastien]
2.0.0 (2018-06-20)
------------------
- Make faceted widget compatible with eea.facetednavigation 10+.
This makes it no more compatible with eea.facetednavigation<10.
[gbastien]
1.4.1 (2017-12-01)
------------------
- Fixed `MultiSelect2Widget` to use a `@property` for `items` as it is the case
for `SingleSelect2Widget.items` it is inheriting from (that was fixed in
release 1.4.0).
[gbastien]
1.4.0 (2017-11-22)
------------------
- Fix an issue with the width of hidden elements (e.g. in tabs)
[mpeeters]
- Restore initialization for multi select2 widgets
[mpeeters]
- Require `z3c.form >= 3.2.11` where the `SelectWidget.items` is a `@property`
and no more a callable method.
[gbastien]
1.3.4 (2017-01-10)
------------------
- Fix widget in overlays when loading a form in an existing overlay.
This worked before 1.3, but another overlay fix in 1.3 broke this case.
[vincentfretin]
1.3.3 (2017-01-10)
------------------
- Don't use default param feature in select2-widget.js, the previous fix
was incomplete.
[vincentfretin]
1.3.2 (2017-01-09)
------------------
- Don't use default param feature in select2-widget.js, this is ES6, IE 10
doesn't support it.
[vincentfretin]
1.3.1 (2016-12-09)
------------------
- Rename wrong class facted-select-criterion to faceted-select-criterion
[vincentfretin]
1.3 (2016-12-01)
----------------
- Remove specific css rules that was introduced in 1.2
[vincentfretin]
- Fix widget in overlays. If you upgrade from 1.1, you need to reinstall
the profile to add a css in portal_css.
[cedricmessiant]
- Wrap call to select2 initialization in JS function `initializeSelect2Widgets`
so it is easy to call from everywhere (like in an overlay initialization).
Parameter width can be specified when calling `initializeSelect2Widgets`
and defaults to `resolve`.
[gbastien]
1.2 (2016-08-25)
----------------
- Avoid an error if Faceted namespace is not defined
[mpeeters]
- Add a select2 single and multi select widget
[mpeeters]
1.1 (2016-07-07)
----------------
- Use faceted-select2-widget instead of faceted-select-widget to not break
the original faceted-select-widget widget.
[vincentfretin]
- Depends on eea.jquery >= 8.8 to fix images in select2.
[vincentfretin]
- Replace collective.taxonomy.widget.TaxonomySelectFieldWidget by the widget
from this package.
[vincentfretin]
- Initialize widgets in overlays now.
[vincentfretin]
1.0 (2016-04-20)
----------------
- Initial release.
[vincentfretin]
Raw data
{
"_id": null,
"home_page": "https://pypi.python.org/pypi/collective.z3cform.select2",
"name": "collective.z3cform.select2",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Python Plone",
"author": "Vincent Fretin",
"author_email": "vincent.fretin@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/dd/0b/08f5c329b061edc82aee59e5415bb5ffbfe22c24432d8c5d9c1c337673d4/collective.z3cform.select2-2.1.0.tar.gz",
"platform": "",
"description": ".. image:: https://travis-ci.org/collective/collective.z3cform.select2.svg?branch=master\n :target: https://travis-ci.org/collective/collective.z3cform.select2\n.. image:: https://coveralls.io/repos/collective/collective.z3cform.select2/badge.png?branch=master\n :target: https://coveralls.io/r/collective/collective.z3cform.select2?branch=master\n\n\n.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide_addons.html\n This text does not appear on pypi or github. It is a comment.\n\n==========================\ncollective.z3cform.select2\n==========================\n\nFeatures\n--------\n\n- select2 multivalued facetednavigation widget for 2-level vocabulary created\n with collective.taxonomy.\n Select \"Select2\" criteria in facetednavigation and select a taxonomy.\n- select2 multivalued z3c.form widget that works nice with 2-level vocabulary\n created with collective.taxonomy\n\nIf you want to use the select2 widget instead the default z3cform widget for List/Set of Choice,\njust include file widget/adapters.zcml in another package policy like this :\n\n <include package=\"collective.z3cform.select2.widget\" file=\"adapters.zcml\" />\n\nTheming\n-------\n\nThe widget was developped initially for a bootstrap 3 theme and fontawesome.\nThere is a search button icon left to the select that upon click open the select.\nIf your site doesn't have a bootstrap based theme, you may want to add this\ncss rule to your project to hide the tiny button::\n\n button[data-select2-open] { display: none; }\n\nThe z3cform widget in display mode uses the badge class, without a comma\nseparator so it may be confusing when you don't have style for the badge class.\nYou can revert to a comma separated display by including minimal.zcml instead\nof configure.zcml, see Installation below.\n\n\nTranslations\n------------\n\n- One constant Faceted.taxonomyAllString currently in French.\n\n\nInstallation\n------------\n\nInstall collective.z3cform.select2 by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.z3cform.select2\n zcml =\n collective.z3cform.select2\n # or collective.z3cform.select2-minimal\n\n\nand then running ``bin/buildout``\n\nYou need to install the collective.z3cform.select2 addon to register the\nselect2 js library. In a facetednav, add a Select2 criterion.\n\neea.facetednavigation\n---------------------\n\nVersion 2.0.0+ is only working with eea.facetednavigation 10+.\nIf you need to make it work with eea.facetednavigation < 10, use versions < 2.0.0\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.z3cform.select2/issues\n- Source Code: https://github.com/collective/collective.z3cform.select2\n\n\nSupport\n-------\n\nIf you are having issues, please let us know.\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\nContributors\n============\n\n- Vincent Fretin [vincentfretin]\n- Eric Br\u00e9hault\n- Martin Peeters [mpeeters]\n\nChangelog\n=========\n\n\n2.1.0 (2020-06-08)\n------------------\n\n- Make widget compatible with the latest versions of eea.faceted.vocabularies\n This makes it no more compatible with eea.faceted.vocabularies < 6.7\n [mpeeters]\n\n\n2.0.1 (2018-08-27)\n------------------\n\n- Do not replace z3cform default widget for List/Set of Choice by\n select2 widget by default. The widget/adapters.zcml will need to be included\n manually so this behavior is applied.\n [gbastien]\n\n2.0.0 (2018-06-20)\n------------------\n\n- Make faceted widget compatible with eea.facetednavigation 10+.\n This makes it no more compatible with eea.facetednavigation<10.\n [gbastien]\n\n\n1.4.1 (2017-12-01)\n------------------\n\n- Fixed `MultiSelect2Widget` to use a `@property` for `items` as it is the case\n for `SingleSelect2Widget.items` it is inheriting from (that was fixed in\n release 1.4.0).\n [gbastien]\n\n\n1.4.0 (2017-11-22)\n------------------\n\n- Fix an issue with the width of hidden elements (e.g. in tabs)\n [mpeeters]\n\n- Restore initialization for multi select2 widgets\n [mpeeters]\n\n- Require `z3c.form >= 3.2.11` where the `SelectWidget.items` is a `@property`\n and no more a callable method.\n [gbastien]\n\n\n1.3.4 (2017-01-10)\n------------------\n\n- Fix widget in overlays when loading a form in an existing overlay.\n This worked before 1.3, but another overlay fix in 1.3 broke this case.\n [vincentfretin]\n\n\n1.3.3 (2017-01-10)\n------------------\n\n- Don't use default param feature in select2-widget.js, the previous fix\n was incomplete.\n [vincentfretin]\n\n\n1.3.2 (2017-01-09)\n------------------\n\n- Don't use default param feature in select2-widget.js, this is ES6, IE 10\n doesn't support it.\n [vincentfretin]\n\n\n1.3.1 (2016-12-09)\n------------------\n\n- Rename wrong class facted-select-criterion to faceted-select-criterion\n [vincentfretin]\n\n\n1.3 (2016-12-01)\n----------------\n\n- Remove specific css rules that was introduced in 1.2\n [vincentfretin]\n\n- Fix widget in overlays. If you upgrade from 1.1, you need to reinstall\n the profile to add a css in portal_css.\n [cedricmessiant]\n\n- Wrap call to select2 initialization in JS function `initializeSelect2Widgets`\n so it is easy to call from everywhere (like in an overlay initialization).\n Parameter width can be specified when calling `initializeSelect2Widgets`\n and defaults to `resolve`.\n [gbastien]\n\n\n1.2 (2016-08-25)\n----------------\n\n- Avoid an error if Faceted namespace is not defined\n [mpeeters]\n\n- Add a select2 single and multi select widget\n [mpeeters]\n\n\n1.1 (2016-07-07)\n----------------\n\n- Use faceted-select2-widget instead of faceted-select-widget to not break\n the original faceted-select-widget widget.\n [vincentfretin]\n\n- Depends on eea.jquery >= 8.8 to fix images in select2.\n [vincentfretin]\n\n- Replace collective.taxonomy.widget.TaxonomySelectFieldWidget by the widget\n from this package.\n [vincentfretin]\n\n- Initialize widgets in overlays now.\n [vincentfretin]\n\n\n1.0 (2016-04-20)\n----------------\n\n- Initial release.\n [vincentfretin]",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "select2 widget for z3c.form and eea.facetednavigation",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://pypi.python.org/pypi/collective.z3cform.select2"
},
"split_keywords": [
"python",
"plone"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd0b08f5c329b061edc82aee59e5415bb5ffbfe22c24432d8c5d9c1c337673d4",
"md5": "4837ecdcb98343c15241c5a5227f4591",
"sha256": "472c9e7a145b62f4a6fe498a514574fed265bd799a5401c13eca6dadeaa1a8ed"
},
"downloads": -1,
"filename": "collective.z3cform.select2-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "4837ecdcb98343c15241c5a5227f4591",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 24896,
"upload_time": "2020-06-08T11:13:20",
"upload_time_iso_8601": "2020-06-08T11:13:20.844222Z",
"url": "https://files.pythonhosted.org/packages/dd/0b/08f5c329b061edc82aee59e5415bb5ffbfe22c24432d8c5d9c1c337673d4/collective.z3cform.select2-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-06-08 11:13:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "collective.z3cform.select2"
}
JSON