Vue-form-generator: update docs for v0.4.0

[icebob]

• [x] vue-multiselect field #20
• [x] fieldSubmit #26
• [x] customizable styles #29
• [x] fieldCleave #31
• [x] fieldPikaday #31
• [x] fieldNoUiSlider #31
• [x] fieldGoogleAddress #33
• [x] visible & disabled, values schema functions description
• [x] ES5 examples (change visible(model) {...} to visible: function(model) {...} )

[lionel-bijaoui]

Need help with the doc ?

[icebob]

Maybe :smiley:

[lionel-bijaoui]

Go on, tell me: how can I help?

[icebob]

The docs on gitbook.com. I don't know it enough good, I don't know the contribution is available.

https://www.gitbook.com/book/icebob/vueformgenerator/details

[lionel-bijaoui]

I just created an account on gitbook, please authorize me so I can try.

[icebob]

OK, I added.

[icebob]

Please check, can you modify the docs?

[lionel-bijaoui]

YES ! :tada:

[icebob]

Great!

[lionel-bijaoui]

Maybe we should specify "vanilla vs jQuery" in the installation.md? I fear the dependency list could be misunderstood and seem daunting. Maybe dependency should be specified only for each field ?

[icebob]

Yes we need specify dependencies for every each field

[lionel-bijaoui]

I'm going to create a branch on gitbook for the v0.4.0 and start modifying the doc

[icebob]

Great! Thanks!

[lionel-bijaoui]

I don't understand what multiple do, can you explain please ?
It is listed in component.md and fields/field_properties.md, is it two different options, or a mistake ?

[icebob]

You can test in in dev mode. Use CTRL key and select multiple rows in table. In this case you can edit fields for multiple models. And component shows fields where multi: true.

But currently it is not complete, because validator can't handle it correctly yet.

[lionel-bijaoui]

So the main multi activate the option, and field level multi activate each field to be part of it ?

[icebob]

Has multi and multiple. Both exists.
Field has property multi.
Component has multiple˛which activate this "multi mode".
See in dev example:

vue-form-generator(:schema='schema', :model='model', :multiple="selected.length > 1")

So if we select 2 or more rows we set multiple to true

[lionel-bijaoui]

Ok I get it :cool:

[lionel-bijaoui]

@icebob I just finished vueMultiselect documentation (on branch v0.4.0), I need your feedback.

[icebob]

Great!

I checked it.

• did you tried the usage examples? Because I think it is not working properly:

  values: [
    {
      "name": "Vue.js",
      "language": "JavaScript"
    },

VueFormGenerator is only handle {id: 1, name: ''} objects as item of values.
Because when you select the item, the component write the value of id field only to the model property.

• There is no link to the page. Missing from Fields page: https://www.gitbook.com/book/icebob/vueformgenerator/edit#/edit/v0.4.0/fields/README.md

Otherwise, good job! Thank you :+1:

[lionel-bijaoui]

• I haven't tested it, but with key and label allow for a total control on your object.
• Yes, I still have work to do. Have you checked this page ?

[lionel-bijaoui]

@icebob noUiSlider is almost done (need more examples)
I have checked and tested all examples for vueMultiselect and noUiSlider and fixed a few things.

[icebob]

Great!

[lionel-bijaoui]

@icebob noUiSlider and cleave are finished. Example tested and everything :tada:

[icebob]

For https://github.com/icebob/vue-form-generator/issues/40#issuecomment-242761754 :

fieldSubmit: only a simple input type=submit. There is a validateBeforeSubmit property in schema. If it is true, running validation after button click. If validation success, call the onSubmit callback from the schema

[icebob]

customizable styles: we can show with example that user can use custom styles for this component. You created a jsfiddle with a new style. You can link it to docs as an example.

[icebob]

visible & disabled, values schema functions description:

visible and disabled property in the schema can be a function too. Example
The function got the model as parameter.

values property in select* fields can be a function. In this case you can generate dynamically the items. Example. This function gets the model and schema as parameters.
You can use this example in docs too.

{
    type: "select",
    label: "Item",
    model: "item",
    values: function(model, schema) {
        switch(model.category) {
            case "Fruit": return ["Apple", "Peach", "Orange"];
            case "Vehicle": return ["Car", "Bicycle", "Ship"];
            case "Animals": return ["Lion", "Dog", "Cat"];
        }

        return [];
    }
}

[lionel-bijaoui]

@icebob pikaday field done !

[icebob]

1 observation: spectrum is a jQuery based field. Currently it is under "vanilla"

[lionel-bijaoui]

Sorry, I missed that. It is not very explicit.
EDIT: fixed

[icebob]

Thanks. Could you make all docs tasks? Because after it, I will release v0.4.0

[lionel-bijaoui]

I'm will do it when I'm at work

Le 29 août 2016 09:36, "Icebob" [email protected] a écrit :

Thanks. Could you make all docs tasks? Because after it, I will release
v0.4.0

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
https://github.com/icebob/vue-form-generator/issues/25#issuecomment-243053293,
or mute the thread
https://github.com/notifications/unsubscribe-auth/ADT81KMjENvBpAsjyABMBBAo6akQ0LTQks5qkowLgaJpZM4Je4ZU
.

[lionel-bijaoui]

Please check :

• fieldSubmit
• fieldGoogleAddress

EDIT:

• optional_fields

[icebob]

I added caption and onSubmit to fieldSubmit. Please check the typo.

[lionel-bijaoui]

What is really caption ? I don't get it. Is it the text on the button submit ?

[icebob]

yes

[icebob]

I added onPlaceChanged to googleAddress field.

[lionel-bijaoui]

Why not call it text then ? Or textButton ?

[icebob]

text is too common. But change to buttonText

[lionel-bijaoui]

I have reorganize the build-in field alphabetically

[icebob]

Please do it on optional fields too.

[lionel-bijaoui]

Ok

EDIT: Done

[lionel-bijaoui]

@icebob I think I'm done. Sorry for the delay, I was very busy at work yesterday.

[lionel-bijaoui]

The schema on this page is {...}. Should we not write what the schemalook like in details ?

[icebob]

Ok, do it

[lionel-bijaoui]

@icebob I have made some reorganization to the structure and properties here

[icebob]

I moved your screenshot to the assets, ok?
https://www.gitbook.com/book/icebob/vueformgenerator/edit#/edit/v0.4.0/assets/Capture%20d%E2%80%99%C3%A9cran%202016-08-29%20%C3%A0%2017.39.15.png

[lionel-bijaoui]

Oh sorry about that crappy screenshot (badly cropped), I was just a test to see if I could upload a photo to gitbook. You can delete it :)

[icebob]

Ok :)

[icebob]

I add a new tasks to this issue, but I'm doing. Done

[lionel-bijaoui]

Ok i'm done with schema example

[icebob]

Great! Thanks

[icebob]

So all tasks done?

[lionel-bijaoui]

I guess so, I looking at the documentation, trying to find problems

[icebob]

OK

[lionel-bijaoui]

Maybe there a thing, but it is more an improvement than a real problem.

For field like pikaday or noUiSlider, I have added default values. Most fields don't have that information.
I guess it can be improved later and is non blocking for the merge.

What do you think ?

[icebob]

Yes, it is a good idea. But for this open a new issue and we do it later.

[lionel-bijaoui]

Roger that!
I think we are go :)

[icebob]

Thank you for your contribution!

[lionel-bijaoui]

You are welcome, thank you for your work on the plugin :+1:

[icebob]

I'm making the new release. Could you merge the docs v0.4.0 branch to the master?

[lionel-bijaoui]

Done

[icebob]

New version released: https://github.com/icebob/vue-form-generator/releases/tag/v0.4.0

[lionel-bijaoui]

That crazy list of changes :D