@wpeform/react

WPEForm React SDK for Headless Forms

www.wpeform.io

Next generation Drag and Drop Live Form Builder with payments, cost estimation, landing page, quizzes, personality tests, surveys, data collection and user feedback of all kinds. Create smarter & faster forms right inside WordPress.

WPEForm is the first of its kind, a WordPress Form Builder with Headless mode. The Plugin was written with JAMStack in mind. The backend is powered by a GraphQL API and the form itself is a TypeScript/React application.

So it is totally possible to create your form in your WordPress website and render it in some other React application.

This SDK includes all the necessary libraries needed to render WPEForms. All important libraries are kept as peer dependencies so you can use the same ones alongside your app.

The library comes with full typescript typings. So you get first-class editor support.

Installation

First follow the guidelines here to make sure you have enabled Headless Mode in WPEForm.

Now install this along with it's peer dependencies.

npx install-peerdeps @wpeform/react

This will install @wpeform/react along with needed peer dependencies. If you want to manually install, then here's the command:

npm install @wpeform/react \
  react \
  react-dom \
  react-is \
  react-latex-next \
  styled-components \
  query-string \
  @fortawesome/fontawesome-svg-core \
  @fortawesome/free-brands-svg-icons \
  @fortawesome/free-regular-svg-icons \
  @fortawesome/free-solid-svg-icons \
  @fortawesome/react-fontawesome \
  @apollo/client \
  @react-spring/web \
  zustand \
  @use-gesture/react

As you can see, react and react-dom are kept as peers along with important libraries which you are probably using yourself.

Usage

Please see our official documentation for updated instruction on usage.

License

All files included in this repository are licensed under GPL-3.0 license.

This cannot be changed because dependencies used by this repository are also GPL-2.0 or later, especially the packed @wordpress dependencies. I may in future release the components library with MIT, but for now, this is the only package with everything.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.