| 1 | {
|
| 2 | "src/components/Accordion.react.js": {
|
| 3 | "description": "Accordion is a component to show/hide a set of components\nI takes an optional id, the label of the accordion, whether it's collapsed\nor not, plus other custom classNames.\nThe components to show/hide should be in children",
|
| 4 | "displayName": "Accordion",
|
| 5 | "methods": [
|
| 6 | {
|
| 7 | "name": "handleClick",
|
| 8 | "docblock": null,
|
| 9 | "modifiers": [],
|
| 10 | "params": [],
|
| 11 | "returns": null
|
| 12 | }
|
| 13 | ],
|
| 14 | "props": {
|
| 15 | "children": {
|
| 16 | "type": {
|
| 17 | "name": "union",
|
| 18 | "value": [
|
| 19 | {
|
| 20 | "name": "arrayOf",
|
| 21 | "value": {
|
| 22 | "name": "node"
|
| 23 | }
|
| 24 | },
|
| 25 | {
|
| 26 | "name": "node"
|
| 27 | }
|
| 28 | ]
|
| 29 | },
|
| 30 | "required": false,
|
| 31 | "description": "The components to wrap in the accordion."
|
| 32 | },
|
| 33 | "label": {
|
| 34 | "type": {
|
| 35 | "name": "string"
|
| 36 | },
|
| 37 | "required": true,
|
| 38 | "description": "A header label for the accordion."
|
| 39 | },
|
| 40 | "defaultCollapsed": {
|
| 41 | "type": {
|
| 42 | "name": "bool"
|
| 43 | },
|
| 44 | "required": false,
|
| 45 | "description": "The initial collapsed state for the accordion."
|
| 46 | },
|
| 47 | "collapsed": {
|
| 48 | "type": {
|
| 49 | "name": "bool"
|
| 50 | },
|
| 51 | "required": false,
|
| 52 | "description": "Whether the accordion is collapsed or not for a controlled component.\n (use only if you want to control this component externally)"
|
| 53 | },
|
| 54 | "id": {
|
| 55 | "type": {
|
| 56 | "name": "string"
|
| 57 | },
|
| 58 | "required": false,
|
| 59 | "description": "The ID used to identify this component in Dash callbacks"
|
| 60 | },
|
| 61 | "className": {
|
| 62 | "type": {
|
| 63 | "name": "string"
|
| 64 | },
|
| 65 | "required": false,
|
| 66 | "description": "className for this component"
|
| 67 | },
|
| 68 | "buttonClassName": {
|
| 69 | "type": {
|
| 70 | "name": "string"
|
| 71 | },
|
| 72 | "required": false,
|
| 73 | "description": "className for the 'arrow', toggle button"
|
| 74 | },
|
| 75 | "itemClassName": {
|
| 76 | "type": {
|
| 77 | "name": "string"
|
| 78 | },
|
| 79 | "required": false,
|
| 80 | "description": "className for the header of the accordion"
|
| 81 | },
|
| 82 | "childrenClassName": {
|
| 83 | "type": {
|
| 84 | "name": "string"
|
| 85 | },
|
| 86 | "required": false,
|
| 87 | "description": "className for the container of the accordion wrapped components"
|
| 88 | },
|
| 89 | "accordionFixedWidth": {
|
| 90 | "type": {
|
| 91 | "name": "number"
|
| 92 | },
|
| 93 | "required": false,
|
| 94 | "description": "Set a fixed width in pixels for the accordion and the children.\nIf you don't set this, the width of the accordion will vary depending on\n whether it's collapsed or not and on the width of the content."
|
| 95 | },
|
| 96 | "style": {
|
| 97 | "type": {
|
| 98 | "name": "object"
|
| 99 | },
|
| 100 | "required": false,
|
| 101 | "description": "Style objecto to override default style"
|
| 102 | },
|
| 103 | "setProps": {
|
| 104 | "type": {
|
| 105 | "name": "func"
|
| 106 | },
|
| 107 | "required": false,
|
| 108 | "description": "Dash-assigned callback that should be called whenever any of the\nproperties change"
|
| 109 | }
|
| 110 | }
|
| 111 | },
|
| 112 | "src/components/Card.react.js": {
|
| 113 | "description": "Card is a component to display an image alongside some information.\nI takes an img url, a list of items of text + number or just text,\n a description and an url link.\nIt renders a component that show all that info structured and beautified.",
|
| 114 | "displayName": "Card",
|
| 115 | "methods": [],
|
| 116 | "props": {
|
| 117 | "id": {
|
| 118 | "type": {
|
| 119 | "name": "string"
|
| 120 | },
|
| 121 | "required": false,
|
| 122 | "description": "The ID used to identify this compnent in Dash callbacks"
|
| 123 | },
|
| 124 | "img": {
|
| 125 | "type": {
|
| 126 | "name": "string"
|
| 127 | },
|
| 128 | "required": false,
|
| 129 | "description": "The img source for the card"
|
| 130 | },
|
| 131 | "data": {
|
| 132 | "type": {
|
| 133 | "name": "arrayOf",
|
| 134 | "value": {
|
| 135 | "name": "shape",
|
| 136 | "value": {
|
| 137 | "label": {
|
| 138 | "name": "string",
|
| 139 | "description": "The item's label",
|
| 140 | "required": false
|
| 141 | },
|
| 142 | "data": {
|
| 143 | "name": "string",
|
| 144 | "description": "The items's data to display (usually a number)",
|
| 145 | "required": false
|
| 146 | }
|
| 147 | }
|
| 148 | }
|
| 149 | },
|
| 150 | "required": false,
|
| 151 | "description": "An array of data items to list"
|
| 152 | },
|
| 153 | "url": {
|
| 154 | "type": {
|
| 155 | "name": "string"
|
| 156 | },
|
| 157 | "required": false,
|
| 158 | "description": "An url to link to"
|
| 159 | },
|
| 160 | "description": {
|
| 161 | "type": {
|
| 162 | "name": "string"
|
| 163 | },
|
| 164 | "required": false,
|
| 165 | "description": "A description of the card content"
|
| 166 | },
|
| 167 | "style": {
|
| 168 | "type": {
|
| 169 | "name": "object"
|
| 170 | },
|
| 171 | "required": false,
|
| 172 | "description": "Style objecto to override default style"
|
| 173 | },
|
| 174 | "setProps": {
|
| 175 | "type": {
|
| 176 | "name": "func"
|
| 177 | },
|
| 178 | "required": false,
|
| 179 | "description": "Dash-assigned callback that should be called whenever any of the\nproperties change"
|
| 180 | }
|
| 181 | }
|
| 182 | },
|
| 183 | "src/components/ExampleComponent.react.js": {
|
| 184 | "description": "ExampleComponent is an example component.\nIt takes a property, `label`, and\ndisplays it.\nIt renders an input with the property `value`\nwhich is editable by the user.",
|
| 185 | "displayName": "ExampleComponent",
|
| 186 | "methods": [],
|
| 187 | "props": {
|
| 188 | "id": {
|
| 189 | "type": {
|
| 190 | "name": "string"
|
| 191 | },
|
| 192 | "required": false,
|
| 193 | "description": "The ID used to identify this compnent in Dash callbacks"
|
| 194 | },
|
| 195 | "label": {
|
| 196 | "type": {
|
| 197 | "name": "string"
|
| 198 | },
|
| 199 | "required": true,
|
| 200 | "description": "A label that will be printed when this component is rendered."
|
| 201 | },
|
| 202 | "value": {
|
| 203 | "type": {
|
| 204 | "name": "string"
|
| 205 | },
|
| 206 | "required": false,
|
| 207 | "description": "The value displayed in the input"
|
| 208 | },
|
| 209 | "setProps": {
|
| 210 | "type": {
|
| 211 | "name": "func"
|
| 212 | },
|
| 213 | "required": false,
|
| 214 | "description": "Dash-assigned callback that should be called whenever any of the\nproperties change"
|
| 215 | }
|
| 216 | }
|
| 217 | },
|
| 218 | "src/components/Import.react.js": {
|
| 219 | "description": "Import serves for the only purpose to force Dash to load grasia-dash-components.\nThis is useful when you want to use grasia components that are going to be\nadded dynamically to the Dash app layout.",
|
| 220 | "displayName": "Import",
|
| 221 | "methods": [],
|
| 222 | "props": {
|
| 223 | "id": {
|
| 224 | "type": {
|
| 225 | "name": "string"
|
| 226 | },
|
| 227 | "required": false,
|
| 228 | "description": "The ID used to identify this component in Dash callbacks"
|
| 229 | },
|
| 230 | "src": {
|
| 231 | "type": {
|
| 232 | "name": "string"
|
| 233 | },
|
| 234 | "required": false,
|
| 235 | "description": "local or external source of the javascript to import"
|
| 236 | }
|
| 237 | }
|
| 238 | },
|
| 239 | "src/components/LoadingDialog.react.js": {
|
| 240 | "description": "LoadingDialog is dialog that prompts and block the user interface\nIt shows a fancy loading icon as well as some optional desctiptive text.",
|
| 241 | "displayName": "LoadingDialog",
|
| 242 | "methods": [],
|
| 243 | "props": {
|
| 244 | "id": {
|
| 245 | "type": {
|
| 246 | "name": "string"
|
| 247 | },
|
| 248 | "required": false,
|
| 249 | "description": "The ID used to identify this component in Dash callbacks"
|
| 250 | },
|
| 251 | "text": {
|
| 252 | "type": {
|
| 253 | "name": "string"
|
| 254 | },
|
| 255 | "required": false,
|
| 256 | "description": "A descriptive text of what is being loaded"
|
| 257 | },
|
| 258 | "show": {
|
| 259 | "type": {
|
| 260 | "name": "bool"
|
| 261 | },
|
| 262 | "required": false,
|
| 263 | "description": "Show or hide this dialog"
|
| 264 | },
|
| 265 | "setProps": {
|
| 266 | "type": {
|
| 267 | "name": "func"
|
| 268 | },
|
| 269 | "required": false,
|
| 270 | "description": "Dash-assigned callback that should be called whenever any of the\nproperties change"
|
| 271 | }
|
| 272 | }
|
| 273 | },
|
| 274 | "src/components/Tabs.react.js": {
|
| 275 | "description": "",
|
| 276 | "displayName": "Tabs",
|
| 277 | "methods": [],
|
| 278 | "props": {
|
| 279 | "id": {
|
| 280 | "type": {
|
| 281 | "name": "string"
|
| 282 | },
|
| 283 | "required": false,
|
| 284 | "description": ""
|
| 285 | },
|
| 286 | "style": {
|
| 287 | "type": {
|
| 288 | "name": "object"
|
| 289 | },
|
| 290 | "required": false,
|
| 291 | "description": "Style object to be merged in with the parent level tabs"
|
| 292 | },
|
| 293 | "className": {
|
| 294 | "type": {
|
| 295 | "name": "string"
|
| 296 | },
|
| 297 | "required": false,
|
| 298 | "description": "ClassName for external css styling"
|
| 299 | },
|
| 300 | "tabsStyle": {
|
| 301 | "type": {
|
| 302 | "name": "object"
|
| 303 | },
|
| 304 | "required": false,
|
| 305 | "description": "Style object for each tab element"
|
| 306 | },
|
| 307 | "tabsClassName": {
|
| 308 | "type": {
|
| 309 | "name": "string"
|
| 310 | },
|
| 311 | "required": false,
|
| 312 | "description": "ClassName for each tab for external css styling"
|
| 313 | },
|
| 314 | "selectedTabStyle": {
|
| 315 | "type": {
|
| 316 | "name": "object"
|
| 317 | },
|
| 318 | "required": false,
|
| 319 | "description": "Style object for currently selected tab element"
|
| 320 | },
|
| 321 | "selectedTabClassName": {
|
| 322 | "type": {
|
| 323 | "name": "string"
|
| 324 | },
|
| 325 | "required": false,
|
| 326 | "description": "ClassName for currently selected tab only for external css styling"
|
| 327 | },
|
| 328 | "tabs": {
|
| 329 | "type": {
|
| 330 | "name": "arrayOf",
|
| 331 | "value": {
|
| 332 | "name": "shape",
|
| 333 | "value": {
|
| 334 | "label": {
|
| 335 | "name": "string",
|
| 336 | "description": "The checkbox's label",
|
| 337 | "required": false
|
| 338 | },
|
| 339 | "icon": {
|
| 340 | "name": "string",
|
| 341 | "description": "The tab's icon src",
|
| 342 | "required": false
|
| 343 | },
|
| 344 | "value": {
|
| 345 | "name": "string",
|
| 346 | "description": "The value of the tab. This value\ncorresponds to the items specified in the\n`values` property.",
|
| 347 | "required": false
|
| 348 | }
|
| 349 | }
|
| 350 | }
|
| 351 | },
|
| 352 | "required": false,
|
| 353 | "description": "An array of options"
|
| 354 | },
|
| 355 | "value": {
|
| 356 | "type": {
|
| 357 | "name": "string"
|
| 358 | },
|
| 359 | "required": false,
|
| 360 | "description": "The currently selected tab"
|
| 361 | },
|
| 362 | "vertical": {
|
| 363 | "type": {
|
| 364 | "name": "bool"
|
| 365 | },
|
| 366 | "required": false,
|
| 367 | "description": "Whether or not the tabs are rendered vertically",
|
| 368 | "defaultValue": {
|
| 369 | "value": "false",
|
| 370 | "computed": false
|
| 371 | }
|
| 372 | },
|
| 373 | "setProps": {
|
| 374 | "type": {
|
| 375 | "name": "func"
|
| 376 | },
|
| 377 | "required": false,
|
| 378 | "description": "Dash-assigned callback that gets fired when the value changes."
|
| 379 | }
|
| 380 | }
|
| 381 | }
|
| 382 | } |
| \ | No newline at end of file |