Code Monkey home page Code Monkey logo

wagtailstreamforms's Introduction

Wagtail StreamForms

tests Codecov pypi github

Allows you to build forms in the CMS admin area and add them to any StreamField in your site. You can add your own fields along with the vast array of default fields which include the likes of file fields. Form submissions are controlled by hooks that you can add that process the forms cleaned data. Templates can be created which will then appear as choices when you build your form, allowing you to display and submit a form however you want.

Backwards Compatibility

Please note that due to this package being virtually re-written for version 3, you cannot upgrade any existing older version of this package to version 3 and onwards. If you have an existing version installed less than 3 then you will need to completely remove it including tables and any migrations that were applied in the databases django_migrations table.

Older versions:

If you are using a version of wagtail 1.x, then the latest compatible version of this package is 1.6.3:

$ pip install wagtailstreamforms<2

Other wise you must install a version of this package from 2 onwards:

$ pip install wagtailstreamforms>=2

What else is included?

  • Each form is built using a StreamField.
  • Customise things like success and error messages, post submit redirects and more.
  • Forms are processed via a before_page_serve hook. Meaning there is no fuss like remembering to include a page mixin.
  • The hook can easily be disabled to provide the ability to create your own.
  • Form submissions are controlled via hooks meaning you can easily create things like emailing the submission which you can turn on and off on each form.
  • Fields can easily be added to the form from your own code such as Recaptcha or a Regex Field.
  • The default set of fields can easily be replaced to add things like widget attributes.
  • You can define a model that will allow you to save additional settings for each form.
  • Form submissions are also listed by their form which you can filter by date and are ordered by newest first.
  • Files can also be submitted to the forms that are shown with the form submissions.
  • A form and its fields can easily be copied to a new form.
  • There is a template tag that can be used to render a form, in case you want it to appear outside a StreamField.

Documentation

Can be found on readthedocs.

Screenshots

Example Front End

Example Front End

Form Fields Selection

Form Fields Selection

Example site with docker

Clone the repo

$ git clone https://github.com/labd/wagtailstreamforms.git

Run the docker container

$ cd wagtailstreamforms
$ docker-compose up

Create yourself a superuser

$ docker-compose exec app bash
$ python manage.py createsuperuser

Go to http://127.0.0.1:8000

wagtailstreamforms's People

Contributors

bigmassa avatar stuartaccent avatar nnist avatar leongraumans avatar tleguijt avatar vdejong avatar robmoorman avatar flipperpa avatar lingster avatar salahaddin avatar rgs258 avatar dbramwell avatar daveaccent avatar aramgutang avatar johnraz avatar gasman avatar pjstevns avatar dev-ptr avatar tomdyson avatar ababic avatar favoyang avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.