1 line
15 KiB
JSON
1 line
15 KiB
JSON
|
{"type":"plugin","meta":{"docsUrl":"https://v2.quasar.dev/quasar-plugins/notify"},"injection":"$q.notify","quasarConfOptions":{"propName":"notify","type":"Object","definition":{"type":{"type":"String","desc":"Optional type (that has been previously registered) or one of the out of the box ones ('positive', 'negative', 'warning', 'info', 'ongoing')","examples":["'negative'","'custom-type'"]},"color":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"textColor":{"type":"String","tsType":"NamedColor","desc":"Overrides text color (if needed); Color name from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"message":{"type":"String","desc":"The content of your message","examples":["'John Doe pinged you'"]},"caption":{"type":"String","desc":"The content of your optional caption","examples":["'5 minutes ago'"]},"html":{"type":"Boolean","desc":"Render the message as HTML; This can lead to XSS attacks, so make sure that you sanitize the message first"},"icon":{"type":"String","desc":"Icon name following Quasar convention; Make sure you have the icon library installed unless you are using 'img:' prefix; If 'none' (String) is used as value then no icon is rendered (but screen real estate will still be used for it)","examples":["'map'","'ion-add'","'img:https://cdn.quasar.dev/logo-v2/svg/logo.svg'","'img:path/to/some_image.png'"],"category":"content"},"iconColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"iconSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"avatar":{"type":"String","desc":"URL to an avatar/image; Suggestion: use public folder","examples":["# (public folder) 'img/something.png'","# (relative path format) require('./my_img.jpg')","# (URL) https://some-site.net/some-img.gif"]},"spinner":{"type":["Boolean","Component"],"configFileType":["Boolean","String"],"desc":"Useful for notifications that are updated; Displays a Quasar spinner instead of an avatar or icon; If value is Boolean 'true' then the default QSpinner is shown","examples":["true","QSpinnerBars"]},"spinnerColor":{"type":"String","tsType":"NamedColor","desc":"Color name for component from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style","addedIn":"v2.5.5"},"spinnerSize":{"type":"String","desc":"Size in CSS units, including unit name","examples":["'16px'","'2rem'"],"category":"style","addedIn":"v2.5.5"},"position":{"type":"String","desc":"Window side/corner to stick to","default":"'bottom'","values":["'top-left'","'top-right'","'bottom-left'","'bottom-right'","'top'","'bottom'","'left'","'right'","'center'"],"required":false},"group":{"type":["Boolean","String","Number"],"desc":"Override the auto generated group with custom one; Grouped notifications cannot be updated; String or number value inform this is part of a specific group, regardless of its options; When a new notification is triggered with same group name, it replaces the old one and shows a badge with how many times the notification was triggered","default":"# message + caption + multiline + actions labels + position","examples":["'my-group'"],"required":false},"badgeColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgeTextColor":{"type":"String","tsType":"NamedColor","desc":"Color name for the badge text from the Quasar Color Palette","examples":["'primary'","'teal'","'teal-10'"],"category":"style"},"badgePosition":{"type":"String","desc":"Notification corner to stick badge to; If notification is on the left side then default is top-right otherwise it is top-left","default":"# top-left/top-right","values":["'top-left'","'top-right'","'b
|