Giter Club home page Giter Club logo

formbuilder-2-craft-cms's Introduction

Mou icon


FormBuilder 2 is a Craft CMS plugin that lets you create & manage forms for your front-end. Entries get stored to database so you can easily view your submission or export them.


Front-End Template Usage

Take a look at sampleForm.twig for required code. You will need to copy everything in that file and paste it to where you want to display your form.


Spam Protection

There are 2 options for spam protection, Time Submissions and Honeypot method.

1. Time Submission

Time submission will prevent spam bots for submitting the form too quickly. You need to enter a time (seconds) it should take a real person to submit a form. Typically 3 seconds is good enough.

2. Honeypot Method

With honeypot there is a hidden field that should be left blank. When spam bots run through the form they tend to fill out all the fields. If the honeypot field will get field the submission will fail. Real people will not be able to fill out this field so the form will submit successfully.


File Uploads

Create an Asset field and add it to your form. You need to select Has File Uploads box when creating your form to make sure files get submitted. If you have Email Notifications turned on, file uploads will be attached to the email.


Email Notifications

Set up your forms to send email notifications to any emails you like. Email notifications can be customized a little. You can choose between plain text or an HTML email template. For each option you can add an optional body and footer text. If you going with HTML template you can upload a custom logo, pick background color and add container width.


Creating Forms

Hit Create New Form to create a new form.

  • Form Settings
    • Form Name - Give your form a name
    • Handle - Will be autogenerated, you can change to a custom one
    • Use Custom Redirect - Select this option if you want a custom redirect page (thank-you page). Redirect URL is required and is relevant to your domain.
    • Has File Uploads - Select this if your form has file uploads
    • Use AJAX - Select this if you want your form to submit using javascript without page refresh. Note: You can't use Has Form Uploads and Ajax together yet (working on it).
  • Spam Protection
    • Timed Submissions - Select this and set time in seconds. Timed submissions will prevent quick spam robots from submitting too quickly.
    • Honeypot - Select this option to try and catch spam robots using a honeypot method. Hidden field in the form needs to be left empty, if filled the form will fail (most robots will fill this field).
  • Messages
    • Success Message - Enter form success message. If you form has custom redirect this is useless.
    • Error Message - Enter generic error message if submission has errors this will be displayed along with the field specific error message (Ex: Your Name cannot be empty).
  • Email Notifications
    • Notify Admin of Submission - Select this if you want to send email notification of submission.
    • Notification Email - Enter email where the notification should be sent to. you can enter multiple emails separated by a comma ,
    • Email Subject - Enter subject line for email notification
    • Include Submission Data - You can tick this option if you like the email to contain the submission content.
    • Email Template - You can pick if you want email to be Text Only or HTML Template.
    • Text Only - With this option you can enter optional Body Copy and Footer Copy.
    • HTML Template - With this option you can upload a custom logo, give email template a custom background color, give a container width as well as optional Body Copy and Footer Copy.
  • Fields
    • Add Fieldset Tab - Click this to add a fieldset. Then drag and drop fields into those fieldsets. You can also drag predefined fieldsets with fields form the Unused Fields section. If you don't see any fields you will need to head over to admin/settings/fields to create some fields.

Supported Fields

Here's a list of currently supported fields. Unlike FormBuilder there are no more custom fieldtypes, you only need to use Craft's predefined fields.

  • Plain Text
  • Checkboxes
  • Radio Buttons
  • Dropdowns (Select Options)
  • Multi Select
  • RichText (WYSIWYG)
  • Light Switch (Toggle)
  • Color (Color Picker)
  • Date
  • Number
  • Assets (Only local file uploads supported for now, no s3, no rackspace)

Custom Fields HTML Markup

If you want to have custom markup for your rendered fields follow these steps to achieve it.

  • Create a directory custom/inputs inside plugins templates folder.
  • Go to templates/inputs and copy over any available fieldtypes over to your custom folder and update markup.

Todo

  • Add more custom mark up options (like allow users to add any field by usind field handle)
  • Exporting entries
  • Update documentations
  • Visual data reporting

Changelog

  • 2.5.16 - Merged pull request, fixed required checkox not passing if only one checkbox #30
  • 1.21.16 - If you have files and email notifications turned on, you will now get file attachments to your email.
  • 1.14.16 - Fixed Dropdown FieldType from not submitting data. Fixed undefined error when adding Forms field to matrix.
  • 1.13.16 - added getFormById($id) functionality, if you need to render form on frontend based on form id use getFormHtmlById($id) instead
  • 1.8.16 - Updated plugin version number
  • 1.7.16 - Fix templates path, so that it reverts to original templates path after the plugin is run. (pull request #13)

Issue Tracking and Bug Reporting

If you have found a bug or would like to request a feature please use Github's Issues to report and track issues.

License

The MIT License (MIT)

Copyright (c) 2014 Roundhouse Agency 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.

formbuilder-2-craft-cms's People

Contributors

owldesign avatar adamdburton avatar hambrook avatar chrisg2g avatar davidwickman avatar jimmylorunning avatar

Watchers

James Cloos avatar  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.