1 line
9.2 KiB
JSON
1 line
9.2 KiB
JSON
|
{"type":"component","meta":{"docsUrl":"https://v2.quasar.dev/vue-components/editor"},"props":{"fullscreen":{"type":"Boolean","sync":true,"desc":"Fullscreen mode","examples":["# v-model:fullscreen=\"isFullscreen\""],"category":"behavior","syncable":true},"no-route-fullscreen-exit":{"type":"Boolean","desc":"Changing route app won't exit fullscreen","category":"behavior"},"model-value":{"desc":"Model of the component; Either use this property (along with a listener for 'update:modelValue' event) OR use v-model directive","required":true,"syncable":true,"category":"model","type":"String","examples":["# v-model=\"content\""]},"readonly":{"type":"Boolean","desc":"Put component in readonly mode","category":"state"},"square":{"type":"Boolean","desc":"Removes border-radius so borders are squared","category":"style"},"flat":{"type":"Boolean","desc":"Applies a 'flat' design (no borders)","category":"style"},"dense":{"type":"Boolean","desc":"Dense mode; toolbar buttons are shown on one-line only","category":"style"},"dark":{"type":["Boolean","null"],"default":"null","desc":"Notify the component that the background is a dark color","category":"style","required":false},"disable":{"type":"Boolean","desc":"Put component in disabled mode","category":"state"},"min-height":{"type":"String","desc":"CSS unit for the minimum height of the editable area","default":"'10rem'","examples":["'15rem'","'50vh'"],"category":"style","required":false},"max-height":{"type":"String","desc":"CSS unit for maximum height of the input area","examples":["'1000px'","'90vh'"],"category":"style"},"height":{"type":"String","desc":"CSS value to set the height of the editable area","examples":["'100px'","'50vh'"],"category":"style"},"definitions":{"type":"Object","desc":"Definition of commands and their buttons to be included in the 'toolbar' prop","examples":["{ save: { tip: 'Save your work', icon: 'save', label: 'Save', handler: saveWork }, upload: { tip: 'Upload to cloud', icon: 'cloud_upload', label: 'Upload', handler: uploadIt } }"],"definition":{"...commandName":{"type":"Object","tsType":"QEditorCommand","autoDefineTsType":true,"desc":"Command definition","definition":{"label":{"type":"String","desc":"Label of the button","examples":["'Addresses'"]},"tip":{"type":"String","desc":"Text to be displayed as a tooltip on hover","examples":["'Add a contact from the Address Book'"]},"htmlTip":{"type":"String","desc":"HTML formatted text to be displayed within a tooltip on hover","examples":["'Add a <span class=\"red\">user</span> from the address book'"]},"icon":{"type":"String","desc":"Icon of the button","examples":["'fas fa-address-book'"]},"key":{"type":"Number","desc":"Keycode of a key to be used together with the <ctrl> key for use as a shortcut to trigger this element","examples":["12","36"]},"handler":{"type":"Function","desc":"Either this or \"cmd\" is required. Function for when button gets clicked/tapped.","params":null,"returns":null,"examples":["() => this.uploadFile()"]},"cmd":{"type":"String","desc":"Either this or \"handler\" is required. This must be a valid execCommand method according to the designMode API.","examples":["'insertHTML'","'justifyFull'"]},"param":{"type":"String","desc":"Only set a param if using a \"cmd\". This is commonly text or HTML to inject, but is highly dependent upon the specific cmd being called.","examples":["'<img src=\"://uploads/001.jpg\" alt=\"nice pic\" />'"]},"disable":{"type":["Boolean","Function"],"desc":"Is button disabled?","returns":{"type":"Boolean","desc":"If true, the button will be disabled"},"examples":["true","() => !checkIfUserIsActive()"]},"type":{"type":["String","null"],"desc":"Pass the value \"no-state\" if the button should not have an \"active\" state","values":["null","'no-state'"],"examples":["'no-state'"]},"fixedLabel":{"type":"Boolean","desc":"Lock the button label, so it doesn't change based on the child option selected."},"fixedIcon":{"type":"Boolean","desc":"Lock the button icon, so it doesn't change based on the child option selected."},"highlight":{"type":"Boolean","desc":"Highlight the too
|