Files
dash-api/lib/python3.11/site-packages/dash/dcc/metadata.json

1 line
116 KiB
JSON
Raw Normal View History

2025-09-07 22:09:54 +02:00
{"src/components/Checklist.react.js":{"description":"Checklist is a component that encapsulates several checkboxes.\nThe values and labels of the checklist are specified in the `options`\nproperty and the checked items are specified with the `value` property.\nEach checkbox is rendered as an input with a surrounding label.","displayName":"Checklist","methods":[],"props":{"options":{"type":{"name":"union","value":[{"name":"arrayOf","value":{"name":"union","value":[{"name":"string"},{"name":"number"},{"name":"bool"}]},"description":"Array of options where the label and the value are the same thing - [string|number|bool]"},{"name":"object","description":"Simpler `options` representation in dictionary format. The order is not guaranteed.\n{`value1`: `label1`, `value2`: `label2`, ... }\nwhich is equal to\n[{label: `label1`, value: `value1`}, {label: `label2`, value: `value2`}, ...]"},{"name":"arrayOf","value":{"name":"exact","value":{"label":{"name":"node","description":"The option's label","required":true},"value":{"name":"union","value":[{"name":"string"},{"name":"number"},{"name":"bool"}],"description":"The value of the option. This value\ncorresponds to the items specified in the\n`value` property.","required":true},"disabled":{"name":"bool","description":"If true, this option is disabled and cannot be selected.","required":false},"title":{"name":"string","description":"The HTML 'title' attribute for the option. Allows for\ninformation on hover. For more information on this attribute,\nsee https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/title","required":false}}},"description":"An array of options {label: [string|number], value: [string|number]},\nan optional disabled field can be used for each option"}]},"required":false,"description":"An array of options","defaultValue":{"value":"[]","computed":false}},"value":{"type":{"name":"arrayOf","value":{"name":"union","value":[{"name":"string"},{"name":"number"},{"name":"bool"}]}},"required":false,"description":"The currently selected value","defaultValue":{"value":"[]","computed":false}},"inline":{"type":{"name":"bool"},"required":false,"description":"Indicates whether the options labels should be displayed inline (true=horizontal)\nor in a block (false=vertical).","defaultValue":{"value":"false","computed":false}},"className":{"type":{"name":"string"},"required":false,"description":"The class of the container (div)"},"style":{"type":{"name":"object"},"required":false,"description":"The style of the container (div)"},"inputStyle":{"type":{"name":"object"},"required":false,"description":"The style of the <input> checkbox element","defaultValue":{"value":"{}","computed":false}},"inputClassName":{"type":{"name":"string"},"required":false,"description":"The class of the <input> checkbox element","defaultValue":{"value":"''","computed":false}},"labelStyle":{"type":{"name":"object"},"required":false,"description":"The style of the <label> that wraps the checkbox input\n and the option's label","defaultValue":{"value":"{}","computed":false}},"labelClassName":{"type":{"name":"string"},"required":false,"description":"The class of the <label> that wraps the checkbox input\n and the option's label","defaultValue":{"value":"''","computed":false}},"id":{"type":{"name":"string"},"required":false,"description":"The ID of this component, used to identify dash components\nin callbacks. The ID needs to be unique across all of the\ncomponents in an app."},"setProps":{"type":{"name":"func"},"required":false,"description":"Dash-assigned callback that gets fired when the value changes."},"persistence":{"type":{"name":"union","value":[{"name":"bool"},{"name":"string"},{"name":"number"}]},"required":false,"description":"Used to allow user interactions in this component to be persisted when\nthe component - or the page - is refreshed. If `persisted` is truthy and\nhasn't changed from its previous value, a `value` that the user has\nchanged while using the app will keep that change, as long as\nthe new `value` also matches what was given originally.\nUsed in conjunction with `persis