Git Product home page Git Product logo

cheetah-forms's Introduction

Cheetah forms

Contributors Forks Stargazers Issues MIT License Buy Me A Coffee


Logo

Cheetah Forms

An Json Based Form Generator for Vuetify!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

Cheetah Forms is a simple JSON form builder for generating a Vuetify Form with just a JSON. Cheetah Forms uses Vuetify to make you form a Material designed form

Fields Form

fields Form

Groups Form

groups Form

Features:

  • JSON based
  • Grid support
  • Default fields
  • Validation
  • Default style

Built With

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
npm install npm@latest -g

Installation

  1. Install NPM packages
npm install cheetah-form

Usage

Basic usage

    <cheetah-form :schema="schema" :model="model" @save="save"></cheetah-form>
with:
  • schema: the json configuration of the form (required)
  • model: the starting value of your model (required)
  • @save: event for handeling the save (returns edited model)

JSON FORM FORMAT

{
    "code": "profile-parent",
    "title": "title",
    "subtitle": "subtitle",
    "fields": [{
        "type": "text-field",
        "name": "Naam",
        "required": true,
        "model": "name",
        "cols": {...}
    },
    "groups": []
}

with:
  • code: the form unique code
  • title: the title of the form (optional)
  • subtitle: ths subtitle of the form (optional)
  • fields: array of fields for the form (is ignored is groups has a value)
  • groups: when you want to create a form of multiple parts use groups

JSON FIELD FORMAT

{
    "type": "text-field",
    "name": "Name",
    "required": true,
    "disabled": false,
    "placeholder": 'placeholder',
    "hint": 'hint',
    "model": "user.name",
    "prefix": "+32",
    "cols": 12
}

with:
  • type: the type of field (check suported types) (required)
  • name: the label of the field (required)
  • model: model in doted notation (required)
  • required: if the field is required or not (optional)
  • disabled: if the field is disabled or not (optional)
  • placeholder: the placeholder (optional)
  • hint: the hint (optional)
  • prefix: a prefix added before the field (optional)
  • cols: the width of the field (1-12, default: 12)

JSON GROUP FORMAT

{
    "id": 1,
    "title": "Name",
    "fields": [],
}

with:
  • id: id of the group (required)
  • title: the title of the group (required)
  • fields: array of fields (see Json Field format) (required)

SUPPORTED TYPES

  • text-field: a normal text field

    special additional options:
    • number field
      attributes: {
          type: 'number',
          min: 1000
          max: 1000
      }
      
  • textarea: a normal textarea

    special additional options:
  • select: a normal select

    special additional options:
    • string items

       items: ['Men', 'Woman']
      
    • object items

      itemValue: 'key',
      itemText: 'label',
      items: [{
        'label': 'label',
        'key': 'someKey',
      },{
        'label': 'label2',
        'key': 'someKey2',
      }]
      
  • combobox: a combobox

    special additional options:
    • string items

       items: ['Men', 'Woman']
      
    • object items

      itemValue: 'key',
      itemText: 'label',
      items: [{
        'label': 'label',
        'key': 'someKey',
      },{
        'label': 'label2',
        'key': 'someKey2',
      }]
      
  • toggler: a switch

    special additional options:
  • radio: radio

    special additional options:
    • object items
          options: [{
            'label': 'label',
            'value': 'someKey',
          },{
            'label': 'label2',
            'value': 'someKey2',
          }]
      
  • checkbox: a simple checkbox ###### special additional options:

  • password: a password input field with hide and reviel option ###### special additional options:

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Siebe Vander Henst - @vh_siebe - [email protected]

Project Link: https://github.com/siebevh/Cheetah-forms

Acknowledgements

cheetah-forms's People

Contributors

siebevh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.