Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs for v0.4.0 #25

Closed
9 tasks done
icebob opened this issue Aug 8, 2016 · 64 comments
Closed
9 tasks done

update docs for v0.4.0 #25

icebob opened this issue Aug 8, 2016 · 64 comments
Milestone

Comments

@icebob
Copy link
Member

icebob commented Aug 8, 2016

@icebob icebob added this to the v0.4.0 milestone Aug 8, 2016
@lionel-bijaoui
Copy link
Member

Need help with the doc ?

@icebob
Copy link
Member Author

icebob commented Aug 11, 2016

Maybe 😃

@lionel-bijaoui
Copy link
Member

Go on, tell me: how can I help?

@icebob
Copy link
Member Author

icebob commented Aug 11, 2016

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
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 11, 2016

OK, I added.

@icebob
Copy link
Member Author

icebob commented Aug 22, 2016

Please check, can you modify the docs?

@lionel-bijaoui
Copy link
Member

YES ! 🎉

@icebob
Copy link
Member Author

icebob commented Aug 22, 2016

Great!

@lionel-bijaoui
Copy link
Member

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
Copy link
Member Author

icebob commented Aug 24, 2016

Yes we need specify dependencies for every each field

@lionel-bijaoui
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 24, 2016

Great! Thanks!

@lionel-bijaoui
Copy link
Member

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
Copy link
Member Author

icebob commented Aug 25, 2016

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
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 25, 2016

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
Copy link
Member

Ok I get it 🆒

@lionel-bijaoui
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 25, 2016

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.

Otherwise, good job! Thank you 👍

@lionel-bijaoui
Copy link
Member

lionel-bijaoui commented Aug 25, 2016

  • 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
Copy link
Member

@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
Copy link
Member Author

icebob commented Aug 26, 2016

Great!

@lionel-bijaoui
Copy link
Member

@icebob noUiSlider and cleave are finished. Example tested and everything 🎉

@icebob
Copy link
Member Author

icebob commented Aug 26, 2016

For #40 (comment) :

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
Copy link
Member Author

icebob commented Aug 26, 2016

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
Copy link
Member Author

icebob commented Aug 26, 2016

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
Copy link
Member

@icebob pikaday field done !

@icebob
Copy link
Member Author

icebob commented Aug 26, 2016

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

@icebob
Copy link
Member Author

icebob commented Aug 29, 2016

I added onPlaceChanged to googleAddress field.

@lionel-bijaoui
Copy link
Member

Why not call it text then ? Or textButton ?

@icebob
Copy link
Member Author

icebob commented Aug 29, 2016

text is too common. But change to buttonText

@lionel-bijaoui
Copy link
Member

lionel-bijaoui commented Aug 29, 2016

I have reorganize the build-in field alphabetically

@icebob
Copy link
Member Author

icebob commented Aug 29, 2016

Please do it on optional fields too.

@lionel-bijaoui
Copy link
Member

lionel-bijaoui commented Aug 29, 2016

Ok

EDIT: Done

@lionel-bijaoui
Copy link
Member

lionel-bijaoui commented Aug 30, 2016

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

@lionel-bijaoui
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

Ok, do it

@lionel-bijaoui
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

@lionel-bijaoui
Copy link
Member

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
Copy link
Member Author

icebob commented Aug 30, 2016

Ok :)

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

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

@lionel-bijaoui
Copy link
Member

Ok i'm done with schema example

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

Great! Thanks

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

So all tasks done?

@lionel-bijaoui
Copy link
Member

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

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

OK

@lionel-bijaoui
Copy link
Member

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
Copy link
Member Author

icebob commented Aug 30, 2016

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

@lionel-bijaoui
Copy link
Member

Roger that!
I think we are go :)

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

Thank you for your contribution!

@icebob icebob closed this as completed Aug 30, 2016
@lionel-bijaoui
Copy link
Member

You are welcome, thank you for your work on the plugin 👍

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

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

@lionel-bijaoui
Copy link
Member

Done

@icebob
Copy link
Member Author

icebob commented Aug 30, 2016

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

@lionel-bijaoui
Copy link
Member

That crazy list of changes :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants