You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@murmurations/jsrfg

Package Overview
Dependencies
2
Maintainers
0
Versions
20
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@murmurations/jsrfg

JSON Schema React Form Generator (JSRFG)


Version published
Maintainers
0
Created

Readme

Source

JSON Schema React Form Generator (JSRFG)

This project is licensed under the terms of the GNU General Public License v3.0

Installation

Using npm:

npm install @murmurations/jsrfg

Setup css and customize css with tailwindcss

@layer components {
  .jsrfg-title {
    @apply text-xl mt-4 block font-bold;
  }
  .jsrfg-required {
    @apply text-red-500 dark:text-red-400;
  }
  .jsrfg-description {
    @apply mb-4 block text-sm;
  }
  .jsrfg-object-block {
    @apply my-4 border-4 border-dotted border-slate-300 p-4;
  }
  .jsrfg-array-block {
    @apply flex items-center justify-around;
  }
  .jsrfg-array-input {
    @apply form-input mr-2 w-full dark:bg-gray-700 focus:dark:bg-gray-500;
  }
  .jsrfg-add-btn {
    @apply my-4 rounded-full bg-red-500 px-4 py-2 font-bold text-white hover:scale-110 hover:bg-red-400 dark:bg-purple-200 dark:text-gray-800 dark:hover:bg-purple-100
  }
  .jsrfg-remove-btn {
    @apply my-4 rounded-full bg-yellow-500 px-4 py-2 font-bold text-white hover:bg-yellow-400 dark:bg-green-200 dark:text-gray-800 dark:hover:bg-green-100;
  }
  .jsrfg-enum-block {
    @apply my-2 block text-sm;
  }
  .jsrfg-enum-select {
    @apply form-select mt-2 w-full text-ellipsis dark:bg-gray-700;
  }
}

Examples

Basic Usage

import React from 'react'
import ReactDOM from 'react-dom'
import { generateForm } from '@murmurations/jsrfg'

const schema = {
  // Schema definition
}

const App = () => {
  return (
    <div>
      <h1>Form Generator Example</h1>
      <FormGenerator schema={schema} />
    </div>
  )
}

ReactDOM.render(<App />, document.getElementById('root'))

Providing Profile Data

import React from 'react';
import ReactDOM from 'react-dom';
import FormGenerator from 'your-package-name';

const schema = {
  // Schema definition
}

const profileData = {
  // Profile data in JSON format
}

const App = () => {
  return (
    <div>
      <h1>Form Generator Example</h1>
      <FormGenerator schema={schema} profileData={profileData} />
    </div>
  )
}

ReactDOM.render(<App />, document.getElementById('root'))

Local Development

Install dependencies

npm install

Prevent React package duplication

Replace <the-project-using-this-package> with the path to the project using this package. You can use a relative path, for example: ../MurmurationsTools.

npm install --no-save <the-project-using-this-package>/node_modules/react

Build the package

npm run build

Use package in another project (run command in that project's directory)

npm install --no-save ../JSONSchemaReactFormGenerator

Install latest pre-release version in another project (run command in that project's directory)

npm install @murmurations/jsrfg@pre

Reference

  1. ECMAScript Modules in Node.js
  2. Best practices for creating a modern npm package
  3. Gotchas in Remix
  4. Duplicate React

Keywords

FAQs

Package last updated on 06 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc