SPEmailHandler - Contact Form Script

SPEmailHandler is a simple client-side contact form handler. It manages form validation, form submissions, and user feedback for server response errors via JavaScript.

Installation

Install SPEmailHandler from npm:

npm install spemailhandler

Then, in your JavaScript:

import { ContactForm } from "spemailhandler";

const formHandler = new ContactForm("/path/to/your-server-script.php");

Configuration

ContactForm reads default validation and error messages as well as HTML element selectors from config.ts. You must provide the submission endpoint when creating an instance. Messages and selectors can be overridden by passing objects to the constructor.

HTML Structure

The following HTML structure is required for SPEmailHandler to function correctly. Be sure to use the correct id and class attributes as the script depends on these identifiers.

Form Fields:

Name Input:

<input type="text" id="name" placeholder="Your Name" />

Email Input:

<input type="email" id="email" placeholder="Your Email" />

Message Input:

<textarea id="message" placeholder="Your Message"></textarea>

Submit Button:

<button id="sendmessage">Send Message</button>

Cancel Button (for modal)

<button id="contactCancel" data-bs-dismiss="modal">Cancel</button>

Alert and Modal

Alert for Displaying Errors

<div id="message-alert" style="display: none;"></div>

Success Modal

<div
  class="modal fade"
  id="success"
  tabindex="-1"
  aria-labelledby="successLabel"
  aria-hidden="true"
>
  Success Message
</div>

How to Use

Initialize the Contact Form

After including the necessary HTML elements, initialize ContactForm with the URL of your server-side script. This endpoint is required. You can optionally provide custom messages when creating the instance.

const formHandler = new ContactForm("/path/to/your-server-script.php");

Optionally, include:

• CSRF Token Input Name: If your server requires a CSRF token, specify the name attribute of the token input field.
• onSuccess Callback: A function to handle successful submissions (e.g., updating the UI or logging data).
• Custom Messages: Provide an object of message strings to override the defaults.
• Custom Selectors: Pass an object with CSS selectors if your HTML uses different IDs.

const formHandler = new ContactForm(
  "/path/to/your-server-script.php",
  "csrf_token", // Optional CSRF token input name
  (responseData) => {
    console.log("Form submitted successfully:", responseData);
  }, // Optional callback function
  {
    invalidEmail: "Email looks wrong",
    emptyMessage: "Message required",
    serverError: "Server error, try again",
    unexpectedError: "Something went wrong",
  },
  {
    successModal: "#successModal",
    messageAlert: "#alert",
    sendButton: "#submitBtn",
    loadingElement: "#submitLoading",
    nameInput: "#fullName",
    emailInput: "#userEmail",
    messageInput: "#userMessage",
    cancelButton: "#closeModal",
  },
);

Form Validation and Submission

• Email Validation: The script validates email format before submission.
• SPEmailHandler: Both the email and message fields must be filled out. If not, an alert displays prompting users to complete the fields.

Error Handling

• If there is an issue with the server response, a default error message is displayed in #message-alert.
• You can customize the error message by modifying the server-side response.

CSRF Token Support

If your server requires a CSRF token, ensure the corresponding hidden input field exists in your HTML:

<input type="hidden" name="csrf_token" value="your-csrf-token" />

Server-Side Script Requirements

The server script should return a JSON response in the following format:

{
  "status": "success", // or "error"
  "message": "Optional error message"
}

Example

<form id="contact-form">
  <input type="text" id="name" placeholder="Your Name" />
  <input type="email" id="email" placeholder="Your Email" />
  <textarea id="message" placeholder="Your Message"></textarea>
  <div id="message-alert" style="display: none;"></div>
  <button id="sendmessage">Send Message</button>
</form>

<div
  class="modal fade"
  id="success"
  tabindex="-1"
  aria-labelledby="successLabel"
  aria-hidden="true"
>
  <div class="modal-dialog">
    <div class="modal-content">
      <div class="modal-header">
        <h5 class="modal-title" id="successLabel">Success</h5>
        <button
          type="button"
          class="btn-close"
          data-bs-dismiss="modal"
          aria-label="Close"
        ></button>
      </div>
      <div class="modal-body">Your message has been sent successfully!</div>
      <div class="modal-footer">
        <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">
          Close
        </button>
      </div>
    </div>
  </div>
</div>