Skip to content

Commit c482a27

Browse files
committed
feat(json): Add json for describe command
1 parent c600f7d commit c482a27

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

src/component/QMarkdown.json

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
{
2+
"type": "component",
3+
"props": {
4+
"src": {
5+
"type": "String",
6+
"desc": "[optional] Pass markdown in as a property",
7+
"examples": [ "Classic markup: :wink: :joy: :cry: :angel: :heart: :beers: :laughing: :yum:\n\nShortcuts (emoticons): :-) :-( 8-) ;)" ]
8+
},
9+
"toc": {
10+
"type": "Boolean",
11+
"desc": "Set to true if you want a TOC automatically generated"
12+
},
13+
"toc-start": {
14+
"type": "Number",
15+
"desc": "The starting Header number for generating a TOC",
16+
"values": [ 1, 2, 3, 4, 5 ]
17+
},
18+
"toc-end": {
19+
"type": "Number",
20+
"desc": "The ending Header number for generating a TOC. Must be greater than tocStart",
21+
"values": [ 2, 3, 4, 5, 6 ]
22+
},
23+
"task-lists-enable": {
24+
"type": "Boolean",
25+
"desc": "Set to true to enable (not read-only) Task Lists"
26+
},
27+
"task-lists-label": {
28+
"type": "Boolean",
29+
"desc": "Set to true to wrap the rendered list items in a <label> element for UX purposes"
30+
},
31+
"task-lists-label-after": {
32+
"type": "Boolean",
33+
"desc": "to add the label after the checkbox (requires `task-lists-label` to be set to `true`)"
34+
}
35+
},
36+
"events": {
37+
"toc": {
38+
"desc": "If `toc` property is `true` then if a TOC is generated it is emitted via this event",
39+
"params": {
40+
"tocData": {
41+
"type": "Array",
42+
"desc": "Array of one or more TOC data objects",
43+
"definition": {
44+
"id": {
45+
"type": "String",
46+
"desc": "The id for the TOC header"
47+
},
48+
"title": {
49+
"type": "String",
50+
"desc": "The TOC header title"
51+
},
52+
"level": {
53+
"type": "Number",
54+
"desc": "The TOC header type (1=h1, 2=h2, etc)"
55+
}
56+
}
57+
}
58+
}
59+
}
60+
},
61+
"slots": {
62+
"default": {
63+
"desc": "This is the default slot to be used for markdown"
64+
}
65+
}
66+
}

0 commit comments

Comments
 (0)