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.

Sign up for GitHub

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

Jump to bottom

Lack of documentation #162

Closed
BeardScript opened this issue Sep 28, 2018 · 6 comments · Fixed by #170 · May be fixed by BeardScript/vue-color#1
Closed

Lack of documentation #162

BeardScript opened this issue Sep 28, 2018 · 6 comments · Fixed by #170 · May be fixed by BeardScript/vue-color#1

Comments

@BeardScript
Copy link
Contributor

Hi, I'm Paul. First of all, I'd like to thank the creators of this plugin. It's really nice. But I'd like to point out that the lack of documentation makes it hard to understand the product's capabilities. I needed to expand the preset colors of the Sketch component and I had to go to the source code to check if there was a property I could use, and there was one indeed (:predefinedColors). This could be a drag for newcomers whom would wrongly assume that vue-color won't let them load their own predefined colors.

I offer myself to help adding this to the docs.
@linx4200
Copy link
Collaborator

Documentation need to be improved, for sure.
Feel free to submit pull requests.

@LeonSkrilec
Copy link

I think it is actually :presetColors and it accepts array of HEX values. Maybe helps anyone...

@BeardScript
Copy link
Contributor Author

I think it is actually :presetColors and it accepts array of HEX values. Maybe helps anyone...

Yes indeed, that's the right property and it does take an array, although, you can fill it with either HEX values and as far as I know also an rgb/rgba like this: 'rgba(0,0,0,0)'. I'll send a PR to update the docs as soon as I have time. This is a good thread to throw in any other details that might be missing from the docs.

@LeonSkrilec
Copy link

That would be great @BeardScript . I also found myself digging the source code to find appropriate settings. Thanks for your effort.

@RaymondAtivie
Copy link

Has this been documented? Any link to a documentation?

@BeardScript
Copy link
Contributor Author

I'm sorry I got caught up on work and completely forgot about this. I'll fork and send PR ASAP.

BeardScript added a commit to BeardScript/vue-color that referenced this issue Jan 17, 2019
@BeardScript
Explained :presetColors prop in docs
782d2f9 
This closes xiaokaike#162
@BeardScript BeardScript mentioned this issue Jan 17, 2019
Open
BeardScript added a commit to BeardScript/vue-color that referenced this issue Jan 28, 2019
@BeardScript
Explained :presetColors and :palette props in docs
24e0296 
This closes xiaokaike#162
@BeardScript BeardScript mentioned this issue Jan 28, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
4 participants
@RaymondAtivie @linx4200 @LeonSkrilec @BeardScript