Skip to content

JSON for form builder #1632

Open
Open
@asvae

Description

@asvae

The idea is to have JSON that could be used in external form-builder.

‼️ Please don't work on this before nuxt switch is finished.

  • JSON Structure should look like this:

    • name - take from npm package
    • description - take from npm package
    • components[]
      • name - non-human readable component name, i.e. “VaInput”.
      • title - human readable component name. I.e. for VaInput it would be “input”
      • We want to add a special type of paragraph (component-description), which should be used for this.
        image
      • description - short component description
      • importIdentifier - import name i.e. “VaInput” for import {VaInput} from 'vuestic-ui'
      • props[]
        • name - prop name
        • title - human readable prop name
        • description - prop description (same as in docs)
        • type - use prop type from docs
        • required - take from docs
        • default - take from docs
      • slots[]
        • name - slot name
        • title - human readable slot name
        • type - expected type or category of slot components. If not specified then any component can be used
        • description - slot description
      • events[]
        • name - event name
        • title - human readable event name
        • type - first argument type
        • description - event description
      • methods[]
        • name - method name
        • title - human readable method name
        • returnType - type of value returned by method
        • description - method description
  • JSON has to be autogenerated on production build and included in NPM package. So user should be able to import vuesticFormBuilderDeclaration from 'vuestic-ui/form-builder-declaration'.

Metadata

Metadata

Assignees

No one assigned

    Labels

    d5: nightmare!Task for core contributors. Monsters attack more rapidly, demons and spectres move and fly faster.externalReported by external contributor and handled with priorityfeatureSomething useful to end userv1: minorThis might be helpful, but not really

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions