@manojadams/metaforms-core - npm Package Compare versions

Comparing version 2.0.8 to 2.0.9

package.json

 {
   "name": "@manojadams/metaforms-core",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "React Library for rendering dynamic forms from json schema",
@@ -27,3 +27,3 @@ "author": "manojgetwealthy",
     "deploy": "gh-pages -d example/build",
-    "doc": "typedoc src/index.ts --excludeInternal"
+    "doc": "typedoc src/index.ts --excludeInternal --exclude './src/__tests__/**'"
   },
@@ -30,0 +30,0 @@ "peerDependencies": {

README.md

 # metaform-core
-This is a simple react library core for rendering json forms.
+This is core library engine that dynamically creates forms from json based metaforms schema.
 
+## Introduction
+This library reads the json based metaforms schema and layouts beautiful forms.
+It acts as a base for creating a dynamic form library which needs to implement the core components from this library.  
+
+## Main features
+- Layouting configuration
+- Support for multiple page forms
+- Support for field dependencies
+- Support custom components
+
+## Core components/concepts
+- Form control (BaseFormControl)
+- Form group (BaseFormGroup)
+- Form stepper (BaseFormStepper)
+
+### Form control (BaseFormControl)
+  This is a class containing declarations of basic form controls as well as some other advanced form controls. 
+  
+### Form group (BaseFormGroup)
+  Contains declarations of basic form grouping controls.
+
+### Form stepper (BasicFormStepper)
+  This is another type of form grouping that contains declartions to implement stepper functionalities for your form.
+
+## How to use
+  This library contains abstract declarations and requires the user to implement his own core components.
+  - BasicFormControl - for basic components
+  - BasicFormGroup - for basic form grouping
+  - BasicFormStepper = for stepper functionalities
+  - Write your own classes (typescript) and extend the above controls.
+  - To know details, check the documentation.
+  
+## Sample for implementing basic `email` control
+````typescript
+class BootstrapFormControl extends CoreFormControl {
+  /**
+   * Implement email
+   */
+  email() {
+    return (
+      <div className="form-group">
+        <label forName="exampleInputEmail1">Email address</label>
+        <input type="email" className="form-control" id="exampleInputEmail1" aria-describedby="emailHelp" placeholder="Enter email">
+        <small id="emailHelp" class="form-text text-muted">We'll never share your email with anyone else.</small>
+      </div>
+    )
+  }
+}
+````
+  
 ## Install
@@ -10,9 +60,9 @@
 
-## Basic usage
+## Basic usage of the library
 ```tsx
 import CoreFormRenderer, { IFormRenderer } from "@manojadams/metaforms-core";
 import React from "react";
-import FormControl from "./forms/FormControl";
-import FormGroup from "./forms/FormGroup";
-import { FormStepper } from "./forms/FormStepper";
+import FormControl from "./forms/FormControl";      // your form control implementation
+import FormGroup from "./forms/FormGroup";          // your form group implementation
+import { FormStepper } from "./forms/FormStepper";  // your form stepper implementation
 
@@ -19,0 +69,0 @@ class FormRenderer extends React.Component<IFormRenderer> {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

846877

increased by0.23%

Number of lines in readme file

91

increased by121.95%

Worsened metrics

Lines of code

7779

decreased by-0.03%

No dependency changes