Documentation not well eexplaineed #37
Description
- Usage does not explain what values to those attributes
- Does not know what are the default values to those attributes
- loading is this string? or some sort of message?
- what are the available colors? does it accepts anything? such as rgba, hex or color names
- what are the available sizes? can we use sm, md, lg and so? or does the available codes are small, mediuim, large?
Activity
alidali96 commentedon Jun 30, 2021
I had the same questions until I viewed the source code of one of the components.
Here is an example of properties:
props: {
loading: {
type: Boolean,
default: true
},
color: {
type: String,
default: '#5dc596'
},
size: {
type: String,
default: '15px'
},
margin: {
type: String,
default: '2px'
},
radius: {
type: String,
default: '100%'
}
loading is a boolean and it will show/hide the spinner v-show="loading"
size is in 'px' width: parseFloat(this.size) * 3 + parseFloat(this.margin) * 6 + 'px'
Hope this helps you, if you want to explore more, you would have to check the component that you are implementing.
greyby commentedon Jun 6, 2026
Thanks for reporting this.
The documentation has been improved in
3.0.2to better explain installation, recommended usage, props, defaults, and which loaders useheight/widthinstead ofsize.Please check the updated README and let me know if anything is still unclear.