benmanu/silverstripe-userforms-faqsearchfield

FAQ search field for SilverStripe userforms module

UserForms - SearchField

Overview

This is a custom https://github.com/silverstripe/silverstripe-userforms form field that can be added to provide a field that searches for FAQ articles that already exist within the website., _(*1)

The use case for this field is where an enquiry form exists on the website for users to ask a question. It can be used to indicate that a similar question already has an FAQ article to answer it before they submit their enquiry., _(*2)

Installation

This can be installed via:, _(*3)

composer require benmanu/silverstripe-userforms-faqsearchfield, _(*4)

Javascript Development

This module has https://github.com/JeffreyWay/laravel-mix as an npm dependency which makes it easy to do future javascript development for the module., _(*5)

To get everything setup you just need to run:, _(*6)

yarn install, _(*7)

Once all the npm packages have been installed you can start javascript development using either:, _(*8)

yarn run dev: which will start a watch task that rebundles the src files when files in the javascript/src/ folder are updated., _(*9)

yarn run prod: which you will want to run when finished to produce a production ready build of the javascript src files., _(*10)

TODO:

• Add ajax loader icon to indicate request is being made on field blur