crispy-forms-foundation-0.8.0/ 0000755 0001750 0001750 00000000000 13661262315 016205 5 ustar carsten carsten crispy-forms-foundation-0.8.0/MANIFEST.in 0000644 0001750 0001750 00000000724 13661262315 017746 0 ustar carsten carsten include MANIFEST.in
include LICENCE.txt
include README.rst
recursive-include crispy_forms_foundation/templates *
recursive-include crispy_forms_foundation/static *
recursive-include crispy_forms_foundation/locale *
recursive-include crispy_forms_foundation/test_fixtures *
recursive-exclude data *
recursive-exclude docs *
recursive-exclude sandbox *
recursive-exclude tests *
recursive-exclude * .cache
recursive-exclude * __pycache__
recursive-exclude * *.py[co]
crispy-forms-foundation-0.8.0/setup.py 0000644 0001750 0001750 00000000124 13661262315 017714 0 ustar carsten carsten #!/usr/bin/env python
# -*- coding: utf-8 -*-
from setuptools import setup
setup()
crispy-forms-foundation-0.8.0/LICENCE.txt 0000644 0001750 0001750 00000002040 13661262315 020004 0 ustar carsten carsten Copyright (c) 2012 David Thenon.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE. crispy-forms-foundation-0.8.0/tests/ 0000755 0001750 0001750 00000000000 13661262315 017347 5 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/004_buttons.py 0000644 0001750 0001750 00000003143 13661262315 022003 0 ustar carsten carsten import os
import pytest
from django.test.html import parse_html
from crispy_forms_foundation.layout import (Layout, ButtonGroup,
Submit, Button,
ButtonElement, ButtonSubmit)
from tests.forms import BasicInputForm
#from tests.utils import write_output
def test_buttongroup(output_test_path, render_output, rendered_template,
helper, client):
form = BasicInputForm()
pack = helper.template_pack
helper.layout = Layout(
'simple',
ButtonGroup(
Submit('Save', 'Save'),
Button('Cancel', 'Cancel'),
)
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_buttongroup.html"))
#write_output(output_test_path, pack, "test_buttongroup.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_buttonelement(output_test_path, render_output, rendered_template,
helper, client):
form = BasicInputForm()
pack = helper.template_pack
helper.layout = Layout(
ButtonSubmit('Save', 'Save'),
ButtonElement('Foo', 'Foo', content="""<Pong/>"""),
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_buttonelement.html"))
#write_output(output_test_path, pack, "test_buttonelement.html", rendered)
assert attempted == rendered
crispy-forms-foundation-0.8.0/tests/005_containers.py 0000644 0001750 0001750 00000003404 13661262315 022453 0 ustar carsten carsten import os
import pytest
from django.test.html import parse_html
from crispy_forms_foundation.layout import (Layout, TabHolder, TabItem,
AccordionHolder, AccordionItem)
from tests.forms import AdvancedForm
#from tests.utils import write_output
def test_tab(output_test_path, render_output, rendered_template, helper,
client):
form = AdvancedForm()
pack = helper.template_pack
helper.layout = Layout(
TabHolder(
TabItem('My tab 1', 'simple'),
TabItem('My tab 2', 'opt_in'),
TabItem('My tab 3', 'longtext'),
css_id="meep-meep"
)
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_tab.html"))
#write_output(output_test_path, pack, "test_tab.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_accordion(output_test_path, render_output, rendered_template, helper,
client):
form = AdvancedForm()
pack = helper.template_pack
# Define 'css_id' to avoid test fails with automatic generated random ID
helper.layout = Layout(
AccordionHolder(
AccordionItem('Group 1', 'simple'),
AccordionItem('Group 2', 'opt_in'),
AccordionItem('Group 3', 'longtext'),
css_id="meep-meep"
)
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_accordion.html"))
#write_output(output_test_path, pack, "test_accordion.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
crispy-forms-foundation-0.8.0/tests/__init__.py 0000644 0001750 0001750 00000000000 13661262315 021446 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/utils.py 0000644 0001750 0001750 00000004777 13661262315 021100 0 ustar carsten carsten import os
import io
from django.template import Context, Template
import django
from distutils.version import LooseVersion
# Getting Django versions compatibilities
DJANGO110_COMPAT = LooseVersion(django.get_version()) >= LooseVersion('1.10')
def write_output(filepath, pack, filename, content):
"""
Write content to filepath+pack+filename, create filepath if it does not
allready exists.
This an helper to automatically rewrite HTML outputs when needed during
development.
Beware, using this will lose every templating instructions previously
written in output attempts.
"""
if (filepath and filepath != '.'
and not os.path.exists(os.path.join(filepath, pack))):
os.makedirs(os.path.join(filepath, pack))
destination = os.path.join(filepath, pack, filename)
with io.open(destination, 'w', encoding='utf-8') as f:
f.write(content)
return destination
def render_attempted_output(path, **kwargs):
"""
Return compiled template from given path with given context
It's a little hack to be able to use Django template stuff to conditionnate
some HTML differences on Django versions.
Template is readed as a simple file without using Django template engine
loader select.
Template context will contains some variables about Django versions
compatibilities. Actually this is only about the 'required' input attribute
behavior that is different from 1.9 (``required=""``) to
1.10 (``required``).
"""
context_kwargs = {
'DJANGO110_COMPAT': DJANGO110_COMPAT,
}
context_kwargs.update(**kwargs)
context = Context(context_kwargs)
with io.open(path, 'r', encoding='utf-8') as f:
template = Template(f.read())
return template.render(context)
def get_rendered_template(form, **kwargs):
"""
Return compiled template with given context where only 'form' is required.
If crispy helper is given, it must be given as 'helper' named argument.
Template is different depending helper is given or not in kwargs.
"""
context_kwargs = {
"form": form,
}
context_kwargs.update(**kwargs)
context = Context(context_kwargs)
# Use spaceless to avoid too much unuseful white spaces
tpl = """{% spaceless %}{% load crispy_forms_tags %}"""
if 'helper' in kwargs:
tpl += """{% crispy form helper %}"""
else:
tpl += """{% crispy form %}"""
tpl += """{% endspaceless %}"""
template = Template(tpl)
return template.render(context)
crispy-forms-foundation-0.8.0/tests/conftest.py 0000644 0001750 0001750 00000001675 13661262315 021557 0 ustar carsten carsten """
Some fixture methods
"""
import os
import pytest
from crispy_forms.helper import FormHelper
from tests.utils import get_rendered_template, render_attempted_output
@pytest.fixture(scope='session')
def output_test_path(pytestconfig):
"""Return absolute path to test outputs directory"""
return os.path.join(pytestconfig.rootdir.strpath, 'tests', 'output')
@pytest.fixture(scope='session')
def rendered_template():
"""
Return callable function to render form template
"""
return get_rendered_template
@pytest.fixture(scope='session')
def render_output():
"""
Return callable function to render output template
"""
return render_attempted_output
@pytest.fixture(scope='function', params=[
"foundation-6"
])
def helper(request):
"""
Parametrized fixture to return helper configured for a template pack
"""
helper = FormHelper()
helper.template_pack = request.param
return helper
crispy-forms-foundation-0.8.0/tests/forms.py 0000644 0001750 0001750 00000003461 13661262315 021053 0 ustar carsten carsten """
Used forms in tests
"""
from django import forms
from crispy_forms.helper import FormHelper
from crispy_forms_foundation.layout import (Layout, Row, Column, ButtonHolder,
Submit)
class BasicInputForm(forms.Form):
"""
Basic form with a single CharField field
"""
simple = forms.CharField(label='Simple text',
widget=forms.TextInput(attrs={'required':''}),
required=True)
def save(self, commit=True):
return
class BoolInputForm(forms.Form):
"""
Basic form with a single BooleanField field
"""
opt_in = forms.BooleanField(
label="Opt in",
widget=forms.CheckboxInput(attrs={'required': ''}),
required=True)
def save(self, commit=True):
return
class BasicInputFormLayoutIncluded(BasicInputForm):
"""
Basic form with included layout
"""
def __init__(self, *args, **kwargs):
self.helper = kwargs.pop('helper', FormHelper())
self.helper.form_action = '.'
self.helper.layout = Layout(
'simple',
)
super(BasicInputFormLayoutIncluded, self).__init__(*args, **kwargs)
class AdvancedForm(forms.Form):
"""
Form with an advanced layout with some inputs
"""
simple = forms.CharField(label='Simple text',
widget=forms.TextInput(attrs={'required':''}),
required=True)
opt_in = forms.BooleanField(
label="Opt in",
widget=forms.CheckboxInput(attrs={'required': ''}),
required=True)
longtext = forms.CharField(label='Address', required=False,
widget=forms.Textarea(attrs={'rows': 3}))
def save(self, commit=True):
return
crispy-forms-foundation-0.8.0/tests/003_fields.py 0000644 0001750 0001750 00000004310 13661262315 021547 0 ustar carsten carsten import os
import pytest
from django.test.html import parse_html
from crispy_forms_foundation.layout import (Layout, InlineField,
InlineSwitchField, FakeField)
from tests.forms import BasicInputForm, BoolInputForm
#from tests.utils import write_output
def test_fakefield(output_test_path, render_output, rendered_template,
helper, client):
form = BasicInputForm()
pack = helper.template_pack
helper.layout = Layout(
FakeField('simple')
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_fakefield.html"))
#write_output(output_test_path, pack, "test_fakefield.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_inlinefield(output_test_path, render_output, rendered_template,
helper, client):
form = BasicInputForm()
pack = helper.template_pack
helper.layout = Layout(
InlineField('simple', label_column='large-7', input_column='large-5',
label_class='foobar')
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_inlinefield.html"))
#write_output(output_test_path, pack, "test_inlinefield.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_inlineswitchfield(output_test_path, render_output, rendered_template,
helper, client):
form = BoolInputForm()
pack = helper.template_pack
helper.layout = Layout(
InlineSwitchField('opt_in', label_column='large-8',
input_column='large-4', label_class='foobar',
switch_class="inline")
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_inlineswitchfield.html"))
#write_output(output_test_path, pack, "test_inlineswitchfield.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
crispy-forms-foundation-0.8.0/tests/output/ 0000755 0001750 0001750 00000000000 13661262315 020707 5 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/ 0000755 0001750 0001750 00000000000 13661262315 023220 5 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_advanced.html 0000644 0001750 0001750 00000002324 13661262315 026713 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_buttongroup.html 0000644 0001750 0001750 00000001066 13661262315 027540 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_buttonelement.html 0000644 0001750 0001750 00000000366 13661262315 030037 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_inlinefield.html 0000644 0001750 0001750 00000000672 13661262315 027434 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_inlineswitchfield.html 0000644 0001750 0001750 00000001145 13661262315 030652 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_basic.html 0000644 0001750 0001750 00000000612 13661262315 026225 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_fakefield.html 0000644 0001750 0001750 00000000523 13661262315 027057 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_layout.html 0000644 0001750 0001750 00000000556 13661262315 026470 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_tab.html 0000644 0001750 0001750 00000002563 13661262315 025721 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/output/foundation-6/test_accordion.html 0000644 0001750 0001750 00000002556 13661262315 027116 0 ustar carsten carsten crispy-forms-foundation-0.8.0/tests/002_layout.py 0000644 0001750 0001750 00000004231 13661262315 021617 0 ustar carsten carsten import os
import pytest
from django.test.html import parse_html
from crispy_forms_foundation.layout import (Layout, Row, Column, ButtonHolder,
Submit)
from tests.forms import BasicInputForm, BasicInputFormLayoutIncluded, AdvancedForm
#from tests.utils import write_output
def test_basic(output_test_path, render_output, rendered_template, helper, client):
form = BasicInputForm()
pack = helper.template_pack
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_basic.html"))
#write_output(output_test_path, pack, "test_basic.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_layout(output_test_path, render_output, rendered_template, helper, client):
form = BasicInputFormLayoutIncluded(helper=helper)
pack = helper.template_pack
rendered = rendered_template(form)
attempted = render_output(os.path.join(output_test_path, pack,
"test_layout.html"))
#write_output(output_test_path, pack, "test_layout.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
def test_advanced(output_test_path, render_output, rendered_template, helper, client):
form = AdvancedForm()
pack = helper.template_pack
helper.layout = Layout(
Row(
Column(
'simple',
css_class='six'
),
Column(
'opt_in',
css_class='six'
),
),
Row(
Column(
'longtext'
),
),
Row(
Column(
ButtonHolder(Submit('submit', 'Submit')),
),
css_class="large"
),
)
rendered = rendered_template(form, helper=helper)
attempted = render_output(os.path.join(output_test_path, pack,
"test_advanced.html"))
#write_output(output_test_path, pack, "test_advanced.html", rendered)
assert parse_html(attempted) == parse_html(rendered)
crispy-forms-foundation-0.8.0/tests/001_ping_demo.py 0000644 0001750 0001750 00000001354 13661262315 022245 0 ustar carsten carsten """
Some dummy pinging to ensure demo urls are consistent
WARNING: Keep this syncrhonized with enabled urls files
"""
import pytest
from django.urls import reverse
@pytest.mark.parametrize("url_name,url_args,url_kwargs", [
('home', [], {}),
('demo:crispy-demo-form-fieldsets', [], {'foundation_version':6}),
('demo:crispy-demo-form-tabs', [], {'foundation_version':6}),
('demo:crispy-demo-form-accordions', [], {'foundation_version':6}),
('demo:crispy-demo-success', [], {'foundation_version':6}),
])
def test_ping_reverse_urlname(client, url_name, url_args, url_kwargs):
"""Ping reversed url names"""
response = client.get(reverse(url_name, args=url_args, kwargs=url_kwargs))
assert response.status_code == 200
crispy-forms-foundation-0.8.0/setup.cfg 0000644 0001750 0001750 00000004461 13661262315 020033 0 ustar carsten carsten ;;
;; crispy-forms-foundation package
;;
[metadata]
name = crispy-forms-foundation
version = 0.8.0
description = Django application to add 'django-crispy-forms' layout objects for 'Foundation for sites'
long_description = file:README.rst
long_description_content_type = text/x-rst
author = David Thenon
author_email = sveetch@gmail.com
url = https://github.com/sveetch/crispy-forms-foundation
license = MIT
keywords = Django, django-crispy-forms, foundation-site
classifiers =
Development Status :: 5 - Production/Stable
Environment :: Web Environment
Framework :: Django
Framework :: Django :: 2.0
Framework :: Django :: 2.1
Framework :: Django :: 2.2
Framework :: Django :: 3.0
Intended Audience :: Developers
License :: OSI Approved :: BSD License
Operating System :: OS Independent
Programming Language :: Python
Programming Language :: Python :: 3
Programming Language :: Python :: 3.5
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Programming Language :: Python :: 3.8
Topic :: Internet :: WWW/HTTP
Topic :: Internet :: WWW/HTTP :: Dynamic Content
Topic :: Software Development :: Libraries :: Python Modules
[options]
include_package_data = True
install_requires =
Django>=2.0
django-crispy-forms>=1.8.1
packages = find:
zip_safe = True
[options.extras_require]
dev =
flake8
pytest
pytest-django
sphinx
sphinx-rtd-theme
sphinx-autobuild
django-debug-toolbar
[options.packages.find]
where = .
exclude=
data
docs
tests
sandbox
[wheel]
universal = 0
;;
;; Third-party packages configuration
;;
[flake8]
max-line-length = 80
exclude =
.git,
.venv,
build,
venv,
__pycache__,
*/migrations/*
[tool:pytest]
DJANGO_SETTINGS_MODULE = sandbox.settings.tests
addopts = -vv
python_files =
*.py
testpaths =
tests
[tox:tox]
envlist = py{36}-django{200,210,220,300}
minversion = 3.4.0
[testenv]
# Get the right django version following the current env
deps =
django200: Django>=2.0,<2.1
django210: Django>=2.1,<2.2
django220: Django>=2.2,<2.3
django300: Django>=3.0,<3.1
django200,django210: django-crispy-forms>=1.8.0,<1.9.0
django220,django300: django-crispy-forms>=1.9.0,<2.0.0
commands =
pip install -e .[dev]
pytest -vv tests
crispy-forms-foundation-0.8.0/README.rst 0000644 0001750 0001750 00000001546 13661262315 017702 0 ustar carsten carsten .. _Django: https://www.djangoproject.com/
.. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
.. _Foundation for sites: http://foundation.zurb.com/
.. _Python: http://python.org/
Introduction
============
This is a `Django`_ application to add `django-crispy-forms`_ layout objects for `Foundation for sites`_.
This app does not include `Foundation for sites`_ assets, you will have to install them yourself in your projects.
Links
*****
* Read the documentation on `Read the docs `_;
* Download his `PyPi package `_;
* Clone it on its `Github repository `_;
Requires
========
* `Python`_ >= 3.5;
* `Django`_ >= 2.0;
* `django-crispy-forms`_ >= 1.8.1;
* `Foundation for sites`_ >= 6.3.x;
crispy-forms-foundation-0.8.0/docs/ 0000755 0001750 0001750 00000000000 13661262315 017135 5 ustar carsten carsten crispy-forms-foundation-0.8.0/docs/dummy_settings.py 0000644 0001750 0001750 00000000202 13661262315 022554 0 ustar carsten carsten # Dummy Django settings file required to import
# crispy-form-foundation when building the documentation
SECRET_KEY = 'dummy-key' crispy-forms-foundation-0.8.0/docs/usage.rst 0000644 0001750 0001750 00000003164 13661262315 020777 0 ustar carsten carsten ============
Basic sample
============
Import **crispy-forms-foundation** then you can use the layout objects in your form :
.. sourcecode:: python
from crispy_forms_foundation.layout import Layout, Fieldset, SplitDateTimeField, Row, Column, ButtonHolder, Submit
class YourForm(forms.ModelForm):
def __init__(self, *args, **kwargs):
self.helper = FormHelper()
self.helper.form_action = '.'
self.helper.layout = Layout(
Fieldset(
'Content',
'title',
'content',
),
Fieldset(
'Display settings',
Row(
Column('template', css_class='large-6'),
Column('order', css_class='large-3'),
Column('visible', css_class='large-3'),
),
),
Fieldset(
'Publish settings',
'parent',
Row(
Column(SplitDateTimeField('published'), css_class='large-6'),
Column('slug', css_class='large-6'),
),
),
ButtonHolder(
Submit('submit_and_continue', 'Save and continue'),
Submit('submit', 'Save'),
),
)
super(YourForm, self).__init__(*args, **kwargs)
Embedded templates are in ``crispy_forms_foundation/templates/foundation-5`` or ``crispy_forms_foundation/templates/foundation-6`` depending of your template pack.
crispy-forms-foundation-0.8.0/docs/layout/ 0000755 0001750 0001750 00000000000 13661262315 020452 5 ustar carsten carsten crispy-forms-foundation-0.8.0/docs/layout/grid.rst 0000644 0001750 0001750 00000000131 13661262315 022124 0 ustar carsten carsten .. automodule:: crispy_forms_foundation.layout.grid
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/layout/containers.rst 0000644 0001750 0001750 00000000137 13661262315 023352 0 ustar carsten carsten .. automodule:: crispy_forms_foundation.layout.containers
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/layout/base.rst 0000644 0001750 0001750 00000000131 13661262315 022111 0 ustar carsten carsten .. automodule:: crispy_forms_foundation.layout.base
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/layout/buttons.rst 0000644 0001750 0001750 00000000134 13661262315 022700 0 ustar carsten carsten .. automodule:: crispy_forms_foundation.layout.buttons
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/layout/fields.rst 0000644 0001750 0001750 00000000133 13661262315 022447 0 ustar carsten carsten .. automodule:: crispy_forms_foundation.layout.fields
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/install.rst 0000644 0001750 0001750 00000001722 13661262315 021337 0 ustar carsten carsten .. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
.. _Foundation: http://github.com/zurb/foundation
.. _install-intro:
=======
Install
=======
#. Get it from PyPi: ::
pip install crispy-forms-foundation
#. Register app in your project settings:
.. sourcecode:: python
INSTALLED_APPS = (
...
'crispy_forms',
'crispy_forms_foundation',
...
)
#. Import default settings at the end of the settings file:
.. sourcecode:: python
from crispy_forms_foundation.settings import *
Default template pack name used will be ``foundation-6``.
All other `django-crispy-forms`_ settings option apply, see its documentation for more details.
#. Finally you will need to install Foundation assets in your project. For novices, a quick way is to use last `Foundation compiled version from CDN links `_. crispy-forms-foundation-0.8.0/docs/abide.rst 0000644 0001750 0001750 00000005416 13661262315 020741 0 ustar carsten carsten .. _Abide: http://foundation.zurb.com/docs/components/abide.html
===============================
Use Foundation Abide validation
===============================
You can use `Abide`_ validation in your form but note that there is no support within the layout objects. You will have to add the ``required`` attribute (and eventually its validation pattern) on your field widgets in your form like this:
.. sourcecode:: python
title = forms.CharField(label=_('Title'), widget=forms.TextInput(attrs={'required':''}), required=True)
To enable `Abide`_ on your form, you'll have to load its Javascript library (if you don't load yet the whole Foundation library) then in your form helper you will have to add its attribute on the form like this :
.. sourcecode:: python
class SampleForm(forms.Form):
title = forms.CharField(label=_('Title'), widget=forms.TextInput(attrs={'required':''}), required=True)
textarea_input = forms.CharField(label=_('Textarea'), widget=forms.Textarea(attrs={'required':''}), required=True)
def __init__(self, *args, **kwargs):
self.helper = FormHelper()
# Enable Abide validation on the form
self.helper.attrs = {'data_abide': '', 'novalidate': ''}
self.helper.form_action = '.'
self.helper.layout = Layout(
...
)
super(SampleForm, self).__init__(*args, **kwargs)
If needed, you can define an `Abide`_ error message directly on the field like this :
.. sourcecode:: python
class SampleForm(forms.Form):
def __init__(self, *args, **kwargs):
super(SampleForm, self).__init__(*args, **kwargs)
self.fields['textarea_input'].abide_msg = "This field is required !"
Support within tabs
*******************
Default `Abide`_ behavior is not aware of Tabs and so input errors can be hided when they are not in the active tab.
**crispy-forms-foundation** ships a jQuery plugin that add support for this usage, you will need to load it in your pages then initialize it on your form:
.. sourcecode:: html
This way, all input errors will be raised to their tab name that will display an error mark.
Support within accordions
*************************
Like with tabs, there is a jQuery plugin to add `Abide`_ support within accordions.
You will need to load it in your pages then initialize it on your form:
.. sourcecode:: html
crispy-forms-foundation-0.8.0/docs/index.rst 0000644 0001750 0001750 00000004104 13661262315 020775 0 ustar carsten carsten .. _Django: https://www.djangoproject.com/
.. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
.. _Foundation for sites: http://foundation.zurb.com/
.. crispy-form-foundation documentation master file, created by
sphinx-quickstart on Sat Nov 15 20:21:48 2014.
Welcome to crispy-form-foundation's documentation!
==================================================
This is a `Django`_ application to add `django-crispy-forms`_ layout objects for `Foundation for sites`_.
This app does not include `Foundation for sites`_ assets, you will have to install them yourself in your projects.
Links
*****
* Read the documentation on `Read the docs `_;
* Download his `PyPi package `_;
* Clone it on its `Github repository `_;
Requires
========
* `Python`_ >= 3.5;
* `Django`_ >= 2.0;
* `django-crispy-forms`_ >= 1.8.1;
* `Foundation for sites`_ >= 6.3.x;
User’s Guide
************
.. toctree::
:maxdepth: 2
install.rst
settings.rst
usage.rst
layout/base.rst
layout/fields.rst
layout/buttons.rst
layout/grid.rst
layout/containers.rst
abide.rst
form_objects.rst
Developer’s Guide
*****************
.. toctree::
:maxdepth: 1
development.rst
changelog.rst
Contributors
............
.. _`@PhilipGarnero`: https://github.com/PhilipGarnero
.. _`@jrast`: https://github.com/jrast
.. _`@jayarnielsen`: https://github.com/jayarnielsen
.. _`@carsolcas`: https://github.com/carsolcas
.. _`@sbaechler`: https://github.com/sbaechler
.. _`@bionikspoon`: https://github.com/bionikspoon
.. _`@flesser`: https://github.com/flesser
.. _`@xbello`: https://github.com/xbello
.. _`@mpasternak`: https://github.com/mpasternak
* Philip Garnero (`@PhilipGarnero`_);
* Juerg Rast (`@jrast`_);
* JR (`@jayarnielsen`_);
* Carsolcas (`@carsolcas`_);
* Simon Bächler (`@sbaechler`_);
* Manu Phatak (`@bionikspoon`_);
* Florian Eßer (`@flesser`_);
* Xabier Bello (`@xbello`_);
* Michał Pasternak (`@mpasternak`_);
crispy-forms-foundation-0.8.0/docs/conf.py 0000644 0001750 0001750 00000021255 13661262315 020441 0 ustar carsten carsten # -*- coding: utf-8 -*-
#
# crispy-form-foundation documentation build configuration file, created by
# sphinx-quickstart on Sat Nov 15 20:21:48 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
from crispy_forms_foundation import __version__ as crispy_forms_foundation_version
# Push a dummy settings file required by Django that is imported in
# "crispy_forms_foundation.layout"
sys.path.append(os.path.join(os.path.dirname(__file__), '.'))
os.environ['DJANGO_SETTINGS_MODULE'] = 'dummy_settings'
from django.conf import settings
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'crispy-form-foundation'
copyright = u'2014, David THENON'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = crispy_forms_foundation_version
# The full version, including alpha/beta/rc tags.
release = crispy_forms_foundation_version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all
# documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# If true, keep warnings as "system message" paragraphs in the built documents.
#keep_warnings = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'alabaster'
try:
import sphinx_rtd_theme
except ImportError:
pass
else:
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
#html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'crispy-form-foundationdoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'crispy-form-foundation.tex', u'crispy-form-foundation Documentation',
u'David THENON', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'crispy-form-foundation', u'crispy-form-foundation Documentation',
[u'David THENON'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'crispy-form-foundation', u'crispy-form-foundation Documentation',
u'David THENON', 'crispy-form-foundation', 'One line description of project.',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False
crispy-forms-foundation-0.8.0/docs/changelog.rst 0000644 0001750 0001750 00000024341 13661262315 021622 0 ustar carsten carsten .. _crispy-forms-foundation-demo: https://github.com/sveetch/crispy-forms-foundation-demo
=========
Changelog
=========
Version 0.8.0 - 2020/05/20
**************************
**Major release to remove deprecated supports**
* Drop Python2 support, minimal Python version support is 3.5;
* Drop support for Django prior to 2.0;
* Drop support for django-crispy-forms prior to 1.8.1;
* Drop support for Foundation 5;
* Ensure support for Django 2.2 and 3.0;
* Ensure support for django-crispy-forms to 1.9.1;
* Removed everything about Foundation 5;
Version 0.7.1 - 2019/05/30
**************************
**Minor release to add support for Django 2.2**
**This will be the last release to support Django<1.11, Python2 and Foundation5**
* Updated tox configuration to cover Django 2.2;
* Updated sandbox demo to work with Django 2.2;
* Fixed changelog;
* Fixed package manifest for supported Django versions;
* Fixed README for supported Foundation versions;
Version 0.7.0 - 2018/10/08
**************************
**Add support for Django 2.0 and 2.1**
* Rewrite package to use ``setup.cfg``;
* Add support for Django 2.0 and Django 2.1, close #36;
* Django 1.11 support is the last one for Python2;
* Change old demo project to more cleaner sandbox;
* Included fix from django-crispy-forms#836 for
``FormHelper.field_template`` usage in uniform, close #39;
Version 0.6.4 - 2017/07/29
**************************
* Fixed ``layout.buttons.ButtonGroup`` for deprecated ``Context()`` usage;
* Fixed tests that performs comparison on html part using ``django.test.html.parse_html``;
Version 0.6.3 - 2017/07/16
**************************
This release adds some bugfixes with Abide, new button objects that will replace the old ones a release and Foundation5 support will be removed for the next (non bugfix) release.
* Removed ``is-visible`` class and added missing ``data-form-error-for`` attribute in Foundation6 field templates, close #33;
* Added new field ``layout.fields.FakeField``;
* Fixed tests to always compare rendered value to attempted value, so the test error output diffs are allways in the same order;
* Updated documentation;
* Adopted new settings structure in ``project/settings/``, removed ``db.sqlite3`` from repository;
* Enabled ``django-debug-toolbar`` in development environment and settings for demo only (not for tests);
* Moved ``layout.buttons.Hidden`` to ``layout.fields.Hidden``;
* Added ``layout.buttons.ButtonElement``, ``layout.buttons.ButtonSubmit`` and ``layout.buttons.ButtonReset`` to button input as real ```` element but keeping old input button behavior for now. **This is on the way to replace respectively** ``Button``, ``Submit`` and ``Reset``. Close #28;
* Added ``layout.buttons.InputButton``, ``layout.buttons.InputSubmit`` and ``layout.buttons.InputReset`` to maintain backward compatibility when the button objects will replace the old ones;
Version 0.6.2 - 2017/07/03
**************************
* Validated working with Django 1.11 from unittests;
* Dropped testing for Django >= 1.10 with Python 2.x in tox config;
Version 0.6.1 - 2017/07/03
**************************
* Cleaned tests structure so it runs everywhere;
* Fixed tests to pass with tox on every supported Django versions;
* Better Makefile;
* Upgraded dependancy ``django-crispy-forms`` to ``1.6.1`` since it backward compatible with Django 1.8;
* Updated documentation;
Version 0.6.0 - 2017/02/11
**************************
This release adds **Foundation for site version 6** support, version 5 support is still available for now.
* Added 'foundation-6' templates, copied from @flesser branch ``foundation-6``;
* Added ``layout.base.Callout`` element;
* Added ``crispy_forms_foundation.templatetags.crispy_forms_foundation_field`` to re-implement ``crispy_field`` filter so we can have the right input field error for Foundation-6;
* Added ``layout.buttons.ButtonHolderCallout``;
* Chanded ``.help-text`` that is allways a ``
`` in Foundation6 (does not have real meaning in Foundation5);
* Changed ``layout.containers.TabHolder`` so it build a random id for container if ``css_id`` is not given;
* Changed ``layout.containers.Container`` to be able to manage the *active* classname ``active_css_class`` Class attribute or its ``get_active_css_class`` method, and add it a condition to use another class name for Foundation-6 (``is-active`` instead of ``active``);
* Changed layout components to get template pack name from lazy object from ``crispy_forms.utils.TEMPLATE_PACK``;
* Changed documentation for better structure;
* Improved unittests to perform for both foundation-5 and foundation-6 template packs;
* Fixed demo views and forms so they can switch between template packs;
* Fixed layout elements so their template does not include ``TEMPLATE_PACK`` anymore in class defintions;
* Fixed switches for Foundation-6;
* Fixed button group for Foundation-6;
* Fixed ``InlineJustifiedField`` for Foundation-6;
* Fixed error messages for Foundation-6;
* Fixed Accordion for Foundation-6;
* Fixed Tabs for Foundation-6;
Version 0.5.5 - 2017/02/01
**************************
* Dropped support for Python 2.6 and Django<1.8;
* Added default app settings file;
* Added project test structure;
* Added pretty simple tests to cover layout elements which include some code;
* Added demo app taken from crispy-form-foundation-demo;
* Added dev and test requirements files;
* Updated setup.py;
* Added and enabled minified basic assets for Foundation 5 and 6 for test and demo;
* Finished demo urls/templates to work on every Foundation versions;
* Fixed Flake issues;
* Validated test with Tox for Python 2.7, Python 3.5 and Django>=1.8,<=1.10;
Backward compatibility change for foundation-5 template pack:
* Moved Tab link template ``tab-item.html`` to ``tab-link.html``;
* Added ``tab-item.html`` to build the Tab item instead of using the Div default template;
Everything should still work as with previous version.
Version 0.5.4 - 2016/02/26
**************************
* Fixed ``TabHolder`` and ``AccordionHolder`` to have the right *active* behavior on their items: activate the first item with a field error if any, else just activate the first item;
Version 0.5.3 - 2015/09/25
**************************
* Fixed bugs with button layout elements since django-crispy-forms==1.5.x, this is backward compatible with previous django-crispy-forms<1.5.x (with pull request #26 to close #25);
* Fixed package infos and README to be more explicit on Django compatibility (1.4 to 1.8 actually tested);
Version 0.5.2 - 2015/07/12
**************************
* Use relative imports and enforce absolute imports;
* Add german and french translation with i18n;
Version 0.5.1 - 2015/05/02
**************************
* Fix 'disable_csrf' option that was not honored in template forms;
Version 0.5.0 - 2015/04/02
**************************
* Better layout elements organization;
* Merged pull request #20 for *Added Foundation tabs and accordion components based on crispy-forms bootstrap3 implementation*;
* Removed all stuff for Foundation 3 that is not supported anymore;
* Fix TabItem and TabHolder so tab inputs errors are raised to the Tab item;
* Fix AccordionItem and AccordionHolder so accordion inputs errors are raised to the accordion item name;
* Add jquery plugin to add Abide support within tabs and accordions so the input errors are raised to their title name and not hided into contents;
* Update documentation;
Version 0.4.1 - 2015/02/22
**************************
* Added docs for submit button;
* Fixed bug where the class layout property was being used and modified by instances;
* Added Contributors to the doc;
Version 0.4 - 2014/11/29
************************
* Allow unicode characters in the form title in ``forms.FoundationFormMixin``;
* Extended ``forms.FoundationFormMixin.init_helper()`` to allow more customization:
* Renamed attribute input to submit as this is more descriptive
* Allow to give a string which is used as display text for the Submit button
* Allow to give a Submit instance wich is directly used
* Added ``forms.FoundationFormMixin.title_templatestring`` attribute to store template string used to display form title;
* Moved ``forms.FoundationFormMixin.id`` attribute name to ``forms.FoundationFormMixin.form_id``;
Version 0.3.9 - 2014/11/21
**************************
* Added ``FoundationFormMixin``, ``FoundationForm`` and ``FoundationModelForm`` in ``forms.py`` to quickly and automatically create a Foundation layout;
* Added ``InlineSwitchField`` layout element for better switches usage;
Version 0.3.8 - 2014/11/16
**************************
* Redesigned *non field errors*;
* Added abide error message on field;
* Added missing error message and help text on inline field;
Version 0.3.7 - 2014/11/15
**************************
* Added better documentation with Sphinx in 'docs/';
Version 0.3.6
*************
* Added ``ButtonGroup`` to use Foundation's Button groups instead of Button holder;
* Added ``Panel`` layout element that act like a ``Div`` but add a ``panel`` css class name;
Version 0.3.5
*************
* Added ``SwitchField`` field;
Version 0.3.3
*************
* Fix bad template includes in some templates;
Version 0.3.2
*************
* Fixed some css class in templates;
* Added documentation for ``Abide`` usage;
* Added ``ButtonHolderPanel`` layout object;
Version 0.3.1
*************
* Added ``InlineField`` and ``InlineJustifiedField``;
Version 0.3.0 - 2014/03/28
**************************
Some backward incompatible change have been done, be sure to check them before upgrading.
* Removed sample view, url and templates. If needed you can find a Django app sample on `crispy-forms-foundation-demo`_;
* Moved ``foundation`` template pack name and its directory to ``foundation-3``. You have to change your ``settings.CRISPY_TEMPLATE_PACK`` if you used the old one;
* Added ``foundation-5`` template pack, it is now the default template pack;
* Removed camelcase on some css classes :
* ``ctrlHolder`` has changed to ``holder``;
* ``buttonHolder`` has changed to ``button-holder``;
* ``asteriskField`` has changed to ``asterisk``;
* ``errorField`` has changed to ``error``;
* ``formHint`` has changed to ``hint``;
* ``inlineLabel`` has changed to ``inline-label``;
* ``multiField`` has changed to ``multiple-fields``;
Version 0.1.0 - 2012/12/23
**************************
First commit.
crispy-forms-foundation-0.8.0/docs/settings.rst 0000644 0001750 0001750 00000001362 13661262315 021531 0 ustar carsten carsten .. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
========
Settings
========
**crispy-forms-foundation** itself does not have its own settings but overrides some of `django-crispy-forms`_ settings:
CRISPY_ALLOWED_TEMPLATE_PACKS
To add ``foundation-5`` and ``foundation-6`` template pack names to allowed template packs.
CRISPY_TEMPLATE_PACK
To set default template pack to ``foundation-6``.
CRISPY_CLASS_CONVERTERS
To define some input class name converters required for ``foundation-6``.
These settings are defined in ``crispy_forms_foundation.settings`` you should have imported (as seen in :ref:`install-intro` document).
All other settings from `django-crispy-forms`_ still apply to change crispies behaviors.
crispy-forms-foundation-0.8.0/docs/form_objects.rst 0000644 0001750 0001750 00000000522 13661262315 022342 0 ustar carsten carsten ============
Form objects
============
There is some forms you can use to quickly and automatically create a Foundation layout for your forms. This is mostly for fast integration or prototyping because it will probably never totally fit to your design.
.. automodule:: crispy_forms_foundation.forms
:members:
:show-inheritance:
crispy-forms-foundation-0.8.0/docs/development.rst 0000644 0001750 0001750 00000003212 13661262315 022207 0 ustar carsten carsten .. _virtualenv: http://www.virtualenv.org
.. _pip: https://pip.pypa.io
.. _Pytest: http://pytest.org
.. _Napoleon: https://sphinxcontrib-napoleon.readthedocs.io
.. _Flake8: http://flake8.readthedocs.io
.. _Sphinx: http://www.sphinx-doc.org
.. _tox: http://tox.readthedocs.io
.. _sphinx-autobuild: https://github.com/GaretJax/sphinx-autobuild
===========
Development
===========
Development requirement
***********************
crispy-form-foundation is developed with:
* Unittests using `Pytest`_;
* Respecting flake and pip8 rules using `Flake8`_;
* `Sphinx`_ for documentation with enabled `Napoleon`_ extension (using only the *Google style*);
* `tox`_ to test again different Python and Django versions;
Install for development
***********************
Unittests
---------
Unittests are made to works on `Pytest`_, a shortcut in Makefile is available to start them on your current development install: ::
make tests
Tox
---
To ease development again multiple Python and Django versions, a tox configuration has been added. You are strongly encouraged to use it to test your pull requests.
Before using it you will need to install tox, it is recommended to install it at your system level so dependancy is not in tests requirements file: ::
sudo pip install tox
Then go in the crispy-form-foundation repository directory where live the ``setup.py`` and ``tox.ini`` files and execute tox: ::
tox
Documentation
-------------
You should see about `sphinx-autobuild`_ for a watcher which automatically rebuild HTML documentation when you change sources.
When installed you can use following command from ``docs/`` directory: ::
make livehtml
crispy-forms-foundation-0.8.0/docs/Makefile 0000644 0001750 0001750 00000015625 13661262315 020606 0 ustar carsten carsten # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext livehtml
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " livehtml to watch a Sphinx directory and rebuild the documentation when a change is detected (require sphinx-autobuild)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/crisp-form-foundation.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/crisp-form-foundation.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/crisp-form-foundation"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/crisp-form-foundation"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
livehtml:
sphinx-autobuild --host 0.0.0.0 --port 8002 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html crispy-forms-foundation-0.8.0/docs/.gitignore 0000644 0001750 0001750 00000000006 13661262315 021121 0 ustar carsten carsten _build crispy-forms-foundation-0.8.0/docs/requirements.txt 0000644 0001750 0001750 00000000044 13661262315 022417 0 ustar carsten carsten Django>=2.1
crispy-forms-foundation
crispy-forms-foundation-0.8.0/crispy_forms_foundation/ 0000755 0001750 0001750 00000000000 13661262315 023152 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/ 0000755 0001750 0001750 00000000000 13661262315 024411 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/de/ 0000755 0001750 0001750 00000000000 13661262315 025001 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/de/LC_MESSAGES/ 0000755 0001750 0001750 00000000000 13661262315 026566 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/de/LC_MESSAGES/django.mo 0000644 0001750 0001750 00000001063 13661262315 030365 0 ustar carsten carsten < \ p q z k Errors : Submit This field is required. Project-Id-Version: PACKAGE VERSION
Report-Msgid-Bugs-To:
POT-Creation-Date: 2015-07-07 18:17+0200
PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
Last-Translator: FULL NAME
Language-Team: LANGUAGE
Language:
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Plural-Forms: nplurals=2; plural=(n != 1);
Fehler : Absenden Dieses Feld wird benötigt. crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/de/LC_MESSAGES/django.po 0000644 0001750 0001750 00000001564 13661262315 030376 0 ustar carsten carsten # SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR , YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-07-07 18:17+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME \n"
"Language-Team: LANGUAGE \n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n != 1);\n"
#: crispy_forms_foundation/forms.py:24
msgid "Errors :"
msgstr "Fehler :"
#: crispy_forms_foundation/forms.py:40
msgid "This field is required."
msgstr "Dieses Feld wird benötigt."
#: crispy_forms_foundation/forms.py:81
msgid "Submit"
msgstr "Absenden"
crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/fr/ 0000755 0001750 0001750 00000000000 13661262315 025020 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/fr/LC_MESSAGES/ 0000755 0001750 0001750 00000000000 13661262315 026605 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/fr/LC_MESSAGES/django.mo 0000644 0001750 0001750 00000001062 13661262315 030403 0 ustar carsten carsten < \ p q z j Errors : Submit This field is required. Project-Id-Version: PACKAGE VERSION
Report-Msgid-Bugs-To:
POT-Creation-Date: 2015-07-12 12:27+0200
PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE
Last-Translator: FULL NAME
Language-Team: LANGUAGE
Language:
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Plural-Forms: nplurals=2; plural=(n > 1);
Erreurs : Soumettre Ce champ est obligatoire. crispy-forms-foundation-0.8.0/crispy_forms_foundation/locale/fr/LC_MESSAGES/django.po 0000644 0001750 0001750 00000001453 13661262315 030412 0 ustar carsten carsten # SOME DESCRIPTIVE TITLE.
# Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
# This file is distributed under the same license as the PACKAGE package.
# FIRST AUTHOR , YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2015-07-12 12:27+0200\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME \n"
"Language-Team: LANGUAGE \n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"
#: forms.py:24
msgid "Errors :"
msgstr "Erreurs :"
#: forms.py:40
msgid "This field is required."
msgstr "Ce champ est obligatoire."
#: forms.py:81
msgid "Submit"
msgstr "Soumettre"
crispy-forms-foundation-0.8.0/crispy_forms_foundation/static/ 0000755 0001750 0001750 00000000000 13661262315 024441 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/static/js/ 0000755 0001750 0001750 00000000000 13661262315 025055 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/static/js/crispy_forms_foundation/ 0000755 0001750 0001750 00000000000 13661262315 032022 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/static/js/crispy_forms_foundation/plugins.js 0000644 0001750 0001750 00000007172 13661262315 034050 0 ustar carsten carsten (function( $ ) {
/*
* jQuery plugin to add Foundation Abide support within tabs so errors are
* visible from tab names
*/
$.fn.abide_support_for_tabs = function(options) {
return this.each(function() {
var $form = $(this),
settings = $.extend({
'error_classname': 'error',
'error_mark_html': '!',
'error_mark_selector': 'span.mark',
'itemid_finder_selector': '.content',
'itemname_selector': '.tabs a',
}, options);
$form.on('invalid.fndtn.abide', function () {
var tabnames_error = [],
tabid;
// Find all input errors, find up their container id and store it
$(this).find('[data-invalid]').each(function( index ) {
// From input go back up to its content container to find its id
tabid = $(this).parents(settings.itemid_finder_selector).attr('id');
// Store unique ids
if( $.inArray(tabid, tabnames_error) == -1 ){
tabnames_error.push(tabid);
}
});
// Reset error marks from tabs
// TODO: Would be nice if it's used when inputs are changed, so the mark can
// be removed when the user fix input errors
$(settings.itemname_selector, $form).removeClass('error').find(settings.error_mark_selector).remove();
// Add error marks in container names that contains input errors from Abide
$.each(tabnames_error, function( index, value ) {
$(settings.itemname_selector+"[href='#"+value+"']", $form)
.addClass(settings.error_classname)
.append(settings.error_mark_html);
});
});
});
};
/*
* jQuery plugin to add Foundation Abide support within Accordion so errors are
* visible from their title
*/
$.fn.abide_support_for_accordions = function(options) {
return this.each(function() {
var $form = $(this),
settings = $.extend({
'error_classname': 'error',
'error_mark_html': '!',
'error_mark_selector': 'span.mark',
'itemid_finder_selector': '.content',
'itemname_selector': '.accordion .accordion-navigation a',
}, options);
$form.on('invalid.fndtn.abide', function () {
var item_errors = [],
itemid;
// Find all input errors, find up their container id and store it
$(this).find('[data-invalid]').each(function( index ) {
// From input go back up to its content container to find its id
itemid = $(this).parents(settings.itemid_finder_selector).attr('id');
// Store unique ids
if( $.inArray(itemid, item_errors) == -1 ){
item_errors.push(itemid);
}
});
// Reset error marks from tabs
$(settings.itemname_selector, $form).removeClass('error').find(settings.error_mark_selector).remove();
// Add error marks in container names that contains input errors from Abide
$.each(item_errors, function( index, value ) {
$("#"+value, $form).prev()
.addClass(settings.error_classname)
.append(settings.error_mark_html);
});
});
});
};
}( jQuery )); crispy-forms-foundation-0.8.0/crispy_forms_foundation/settings.py 0000644 0001750 0001750 00000000707 13661262315 025370 0 ustar carsten carsten #: -*- coding: utf-8 -*-
"""
Settings
========
Default required settings. You can override them in your project settings
file.
"""
# Allowed layout pack
CRISPY_ALLOWED_TEMPLATE_PACKS = (
'bootstrap',
'bootstrap4',
'foundation-6',
'uni_form',
)
# Default layout pack
CRISPY_TEMPLATE_PACK = 'foundation-6'
# Default class names on input
CRISPY_CLASS_CONVERTERS = {
'inputelement': None,
'errorcondition': 'is-invalid-input',
}
crispy-forms-foundation-0.8.0/crispy_forms_foundation/__init__.py 0000644 0001750 0001750 00000001416 13661262315 025265 0 ustar carsten carsten # -*- coding: utf-8 -*-
"""Django application to add 'django-crispy-forms' layout objects for 'Foundation for sites'""" # noqa: E501
from __future__ import absolute_import, unicode_literals
import os
from setuptools.config import read_configuration
import pkg_resources
PROJECT_DIR = os.path.join(os.path.dirname(__file__), "..")
def _extract_version(package_name):
"""
Get package version from installed distribution or configuration file if not
installed
"""
try:
return pkg_resources.get_distribution(package_name).version
except pkg_resources.DistributionNotFound:
_conf = read_configuration(os.path.join(PROJECT_DIR, "setup.cfg"))
return _conf["metadata"]["version"]
__version__ = _extract_version("crispy_forms_foundation")
crispy-forms-foundation-0.8.0/crispy_forms_foundation/layout/ 0000755 0001750 0001750 00000000000 13661262315 024467 5 ustar carsten carsten crispy-forms-foundation-0.8.0/crispy_forms_foundation/layout/grid.py 0000644 0001750 0001750 00000007166 13661262315 026000 0 ustar carsten carsten """
Grid
====
.. _django-crispy-forms: https://github.com/maraujop/django-crispy-forms
.. _Foundation: http://github.com/zurb/foundation
.. _crispy-forms-foundation-demo: https://github.com/sveetch/crispy-forms-foundation-demo
.. _Abide: http://foundation.zurb.com/docs/components/abide.html
References
* `Foundation 6 Grid `_;
""" # noqa: E501
from crispy_forms_foundation.layout.base import Div
__all__ = [
'Row', 'RowFluid', 'Column',
]
class Row(Div):
"""
Wrap fields in a div whose default class is ``row``. Example:
.. sourcecode:: python
Row('form_field_1', 'form_field_2', 'form_field_3')
Act as a div container row, it will embed its items in a div like that:
.. sourcecode:: html
Content
"""
css_class = 'row'
class RowFluid(Row):
"""
Wrap fields in a div whose default class is "row row-fluid". Example:
.. sourcecode:: python
RowFluid('form_field_1', 'form_field_2', 'form_field_3')
It has a same behaviour than *Row* but add a CSS class "row-fluid" that you
can use to have top level row that take all the container width. You have
to put the CSS for this class to your CSS stylesheets. It will embed its
items in a div like that:
.. sourcecode:: html
Content
The CSS to add should be something like that:
.. sourcecode:: css
/*
* Fluid row takes the full width but keep normal row and columns
* behaviors
*/
@mixin row-fluid-mixin {
max-width: 100%;
// Restore the initial behavior restrained to the grid
.row{
margin: auto;
@include grid-row;
// Preserve nested fluid behavior
&.row-fluid{
max-width: 100%;
}
}
}
.row.row-fluid{
@include row-fluid-mixin;
}
@media #{$small-up} {
.row.small-row-fluid{ @include row-fluid-mixin; }
}
@media #{$medium-up} {
.row.medium-row-fluid{ @include row-fluid-mixin; }
}
@media #{$large-up} {
.row.large-row-fluid{ @include row-fluid-mixin; }
}
@media #{$xlarge-up} {
.row.xlarge-row-fluid{ @include row-fluid-mixin; }
}
@media #{$xxlarge-up} {
.row.xxlarge-row-fluid{ @include row-fluid-mixin; }
}
It must be included after Foundation grid component is imported.
"""
css_class = 'row row-fluid'
class Column(Div):
"""
Wrap fields in a div. If not defined, CSS class will default to
``large-12 columns``. ``columns`` class is always appended, so you don't
need to specify it.
This is the column from the Foundation Grid component, all columns should
be contained in a **Row** or a **RowFluid** and you will have to define the
column type in the ``css_class`` attribute.
Example:
.. sourcecode:: python
Column('form_field_1', 'form_field_2', css_class='small-12 large-6')
Will render to something like that:
.. sourcecode:: html
...
``columns`` class is always appended, so you don't need to specify it.
If not defined, ``css_class`` will default to ``large-12``.
"""
css_class = 'columns'
def __init__(self, field, *args, **kwargs):
self.field = field
if 'css_class' not in kwargs:
kwargs['css_class'] = 'large-12'
super(Column, self).__init__(field, *args, **kwargs)
crispy-forms-foundation-0.8.0/crispy_forms_foundation/layout/__init__.py 0000644 0001750 0001750 00000003043 13661262315 026600 0 ustar carsten carsten """
Layout items for Foundation components.
Inherits from the default **crispy_forms** layout objects to force templates on
the right ``TEMPLATE_PACK`` (defined from ``settings.CRISPY_TEMPLATE_PACK``)
and implements Foundation components.
"""
from __future__ import absolute_import
from .base import Div, Callout, Layout, UneditableField, HTML
from .grid import Row, RowFluid, Column
from .fields import ( # noqa: F401
MultiWidgetField, Field, MultiField,
SplitDateTimeField, InlineField,
InlineJustifiedField, SwitchField,
InlineSwitchField, FakeField, Hidden
)
from .buttons import ( # noqa: F401
ButtonHolder, ButtonHolderCallout, ButtonGroup,
Button, Submit, Reset,
InputButton, InputSubmit, InputReset,
ButtonElement, ButtonSubmit, ButtonReset
)
from .containers import ( # noqa: F401
Container, ContainerHolder,
Fieldset, TabItem, TabHolder,
VerticalTabHolder, AccordionItem,
AccordionHolder
)
__all__ = [
'Div', 'Callout', 'Layout', 'UneditableField', 'HTML',
'Row', 'RowFluid', 'Column',
'Field', 'FakeField', 'Hidden',
'MultiWidgetField', 'MultiField',
'SplitDateTimeField',
'InlineField', 'InlineJustifiedField', 'SwitchField', 'InlineSwitchField'
'ButtonHolder', 'ButtonHolderCallout', 'ButtonGroup',
'Button', 'Submit', 'Reset',
'InputButton', 'InputSubmit', 'InputReset',
'ButtonElement', 'ButtonSubmit', 'ButtonReset',
'Container', 'ContainerHolder', 'Fieldset',
'TabItem', 'TabHolder', 'VerticalTabHolder',
'AccordionItem', 'AccordionHolder',
]
crispy-forms-foundation-0.8.0/crispy_forms_foundation/layout/buttons.py 0000644 0001750 0001750 00000015374 13661262315 026551 0 ustar carsten carsten """
Buttons
=======
.. _Foundation: http://github.com/zurb/foundation
References
* `Foundation 6 Button `_;
* `Foundation 6 Button Group `_;
""" # noqa: E501
from django.template.loader import render_to_string
from crispy_forms.utils import render_field, TEMPLATE_PACK
from crispy_forms import layout as crispy_forms_layout
__all__ = [
'ButtonHolder', 'ButtonHolderCallout', 'ButtonGroup',
'Button', 'Submit', 'Reset',
'InputButton', 'InputSubmit', 'InputReset',
'ButtonElement', 'ButtonSubmit', 'ButtonReset',
]
class ButtonHolder(crispy_forms_layout.ButtonHolder):
"""
It wraps fields in an element ``
``.
This is where you should put Layout objects that render to form buttons
like Submit. It should only hold ``HTML`` and ``BaseInput`` inherited
objects.
Example:
.. sourcecode:: python
ButtonHolder(
HTML(Information Saved),
Submit('Save', 'Save')
)
"""
template = "%s/layout/buttonholder.html"
class ButtonHolderCallout(ButtonHolder):
"""
Act like ``ButtonHolder`` but add a ``callout`` class name on the main
``div``.
"""
def __init__(self, field, *args, **kwargs):
kwargs['css_class'] = kwargs.get('css_class', '')+' callout'
super().__init__(field, *args, **kwargs)
class ButtonGroup(crispy_forms_layout.LayoutObject):
"""
It wraps fields in an element ``
``.
This is where you should put Layout objects that render to form buttons
like Submit. It should only hold `HTML` and `BaseInput` inherited objects.
Example:
.. sourcecode:: python
ButtonGroup(
Submit('Save', 'Save'),
Button('Cancel', 'Cancel'),
)
"""
template = "%s/layout/buttongroup.html"
def __init__(self, *fields, **kwargs):
self.fields = list(fields)
self.css_class = kwargs.get('css_class', None)
self.css_id = kwargs.get('css_id', None)
self.template = kwargs.get('template', self.template)
def render(self, form, form_style, context, template_pack=TEMPLATE_PACK):
field_list = []
template = self.get_template_name(template_pack)
for field in self.fields:
field_list.append(
render_field(field, form, form_style, context,
template_pack=template_pack)
)
buttons = render_to_string(template, {
'buttongroup': self,
'field_list': field_list,
})
return buttons
class InputButton(crispy_forms_layout.BaseInput):
"""
Used to create a Submit input descriptor for the {% crispy %} template tag:
.. sourcecode:: python
button = InputButton('Button 1', 'Press Me!')
.. note:: The first argument is also slugified and turned into the id for
the button.
"""
input_type = 'button'
field_classes = 'button'
class Button(InputButton):
"""
This is the old Button object that inherit from ``InputButton`` for
backward compatibility.
If you want to stand for an input button, you are invited to use
``InputButton`` instead to avoid problem when ``ButtonElement`` will
become the new ``Button`` object.
"""
pass
class InputSubmit(crispy_forms_layout.BaseInput):
"""
Used to create a Submit button descriptor for the {% crispy %} template
tag:
.. sourcecode:: python
submit = Submit('Search the Site', 'search this site')
"""
input_type = 'submit'
field_classes = 'submit button'
class Submit(InputSubmit):
"""
This is the old Button object that inherit from ``InputSubmit`` for
backward compatibility.
If you want to stand for an input button, you are invited to use
``InputSubmit`` instead to avoid problem when ``ButtonSubmit`` will
become the new ``Submit`` object.
"""
pass
class InputReset(crispy_forms_layout.BaseInput):
"""
Used to create a Reset button input descriptor for the ``{% crispy %}``
template tag:
.. sourcecode:: python
reset = Reset('Reset This Form', 'Revert Me!')
"""
input_type = 'reset'
field_classes = 'reset button'
class Reset(InputReset):
"""
This is the old Button object that inherit from ``InputReset`` for
backward compatibility.
If you want to stand for an input button, you are invited to use
``InputReset`` instead to avoid problem when ``ButtonReset`` will
become the new ``Reset`` object.
"""
pass
class ButtonElement(crispy_forms_layout.BaseInput):
"""
Contrary to ``Button``, ButtonElement purpose use a ``
crispy-forms-foundation-0.8.0/crispy_forms_foundation/templates/foundation-6/layout/multifield.html 0000644 0001750 0001750 00000002157 13661262315 034027 0 ustar carsten carsten
{% spaceless %}{% if form_show_errors %}
{% for field in multifield.bound_fields %}
{% if field.errors %}
{% for error in field.errors %}
{% if field|is_checkbox %}
{% crispy_field field %}
{% endif %}
{% if field.label %}
{% endif %}
{% if not field|is_checkbox %}
{% crispy_field field %}
{% endif %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% if field.help_text %}
{{ field.help_text|safe }}
{% endif %}
{% endif %}
crispy-forms-foundation-0.8.0/crispy_forms_foundation/templates/foundation-6/uni_formset.html 0000644 0001750 0001750 00000000365 13661262315 032705 0 ustar carsten carsten {% with formset.management_form as form %}
{% include 'foundation-6/uni_form.html' %}
{% endwith %}
{% for form in formset.forms %}
{% if field|is_checkbox %}
{% crispy_field field %}
{% endif %}
{% endif %}
{% if field|is_checkboxselectmultiple %}
{% include 'foundation-6/layout/checkboxselectmultiple.html' %}
{% endif %}
{% if not field|is_checkbox and not field|is_checkboxselectmultiple %}
{% crispy_field field %}
{% endif %}
{% if form_show_errors %}
{% for error in field.errors %}
{{ error }}
{% endfor %}
{% endif %}
{% if field.help_text %}