@bigbinary/neeto-form-frontend v1.3.3

neeto-form-nano

The neeto-form-nano allows us to build forms within neeto applications. This nano exports @bigbinary/neeto-form-frontend NPM package and neeto-form-engine Rails engine.

Contents

1. Development with Host Application
   • Engine
   • Frontend package
     • Installation
     • Instructions for development
     • Usage
2. Instructions for Publishing

Development with Host Application

Engine

The engine adds setup for form on backend and allows us to attach forms to any model. It also stores submissions.

Installation

1. Add this line to your application's Gemfile:

   source "NEETO_GEM_SERVER_URL" do
     # ...existing gems
   
     gem 'neeto-form-engine'
   end

2. And then execute:

   bundle install

3. Install the migrations

   bundle exec rails neeto_form_engine:install:migrations

4. Run the migrations

   bundle exec rails db:migrate

5. Add this line to your application's config/routes.rb file (replace at to your desired route):

   mount NeetoFormEngine::Engine, at: "/neeto_form_engine"

6. Create file neeto_form_engine.rb under config/initializers to provide the owner_class information

   NeetoFormEngine.owner_class = "Organization"

7. Configure models to add below association to the provided owner class

   has_many :forms, class_name: "::NeetoFormEngine::Form", as: :owner

8. Configure models to add below association to scope submission records (optional)

   has_one :submission, class_name: "::NeetoFormEngine::Submission", as: :record

9. Configure model to add below association to attach form (optional)

   has_one :form, class_name: "::NeetoFormEngine::Form", as: :attachable

Customizability

The engine supports customizing the default behavior of Questions::UpdateService. The supported methods/constants can be overridden by defining them in the concern NeetoFormEngine::Customizable::Questions::Updateable

Available methods:

1. create_question!: This takes 2 arguments: params and question. The params argument contains the question parameters passed from the front-end, and the question argument contains the current question. This argument is required if you need translation support.

2. additional_question_params: If you want to include additional attributes while creating questions, you can specify them using this method. It takes one argument params which will be the question parameters passed from the front-end.

   Available constants:

3. EXCLUDED_UPDATE_PARAMS: If you have included extra parameters other than kind for additional use cases that are not valid entity attributes, they need to be specified as EXCLUDED_UPDATE_PARAMS.

Frontend package

The frontend package allows us to create forms across neeto products.

Installation

1. Install the NPM package

   yarn add @bigbinary/neeto-form-frontend

2. The frontend package has a few peer dependencies that are required for the proper functioning of the package. Install all the peer dependencies using the below command:

   yarn add @bigbinary/neetoui @bigbinary/neeto-icons ramda@^0.28.0 classnames@^2.3.1 formik@2.2.9 @bigbinary/neeto-commons-frontend

3. Import stylesheet from the following location:

   @import "@bigbinary/neeto-form-frontend/dist/main.css";

Instructions for development

Check the Frontend package development guide for step-by-step instructions to develop the frontend package.

Usage

You can learn more about the usage here: 1. Components 2. Hooks

Instructions for Publishing

Consult the building and releasing packages guide for details on how to publish.