{
  "meta": {
    "docsUrl": "https://quasarframework.github.io/quasar-ui-qmarkdown/docs"
  },
  "props": {
    "src": {
      "type": "String",
      "category": "model",
      "desc": "[optional] Pass markdown in as a property",
      "examples": [ "src=\"Classic markup: :wink: :joy: :cry: :angel: :heart: :beers: :laughing: :yum:\"" ]
    },
    "no-abbreviation": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable abbreviation conversion"
    },
    "no-blockquote": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable blockquote conversion"
    },
    "no-breaks": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable conversion of '\\n' into <br>"
    },
    "no-container": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable container conversion"
    },
    "no-deflist": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable definition list conversion"
    },
    "no-emoji": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable emojie conversion"
    },
    "no-footnote": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable footnote conversion"
    },
    "no-highlight": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable code highlighter"
    },
    "no-html": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable HTML tags in source"
    },
    "no-image": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable image conversion"
    },
    "no-insert": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable insert conversion"
    },
    "no-line-numbers": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable line numbers on code blocks"
    },
    "no-link": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable conversion of links"
    },
    "no-linkify": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable auto-convert URL-like text to links"
    },
    "no-heading-anchor-links": {
      "addedIn": "v1.4.0",
      "type": "Boolean",
      "category": "content",
      "desc": "Your headings will automatically be turned into anchor links, unless you use this property (default is H1-H3)"
    },
    "no-mark": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable mark conversion"
    },
    "no-subscript": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable subscript conversion"
    },
    "no-superscript": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable superscript conversion"
    },
    "no-tasklist": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable tasklist conversion"
    },
    "no-typographer": {
      "type": "Boolean",
      "category": "content",
      "desc": "Disable language-neutral replacement + quotes beautification"
    },
    "line-number-alt": {
      "type": "String",
      "category": "content",
      "desc": "Provide an alternative character to be used instead of line numbers - must be 1 char in length",
      "examples":[
        "line-number-alt=\"$\"",
        "line-number-alt=\">\""
      ]
    },
    "toc": {
      "type": "Boolean",
      "category": "behavior",
      "desc": "Set to true if you want a TOC automatically generated"
    },
    "toc-start": {
      "type": "Number",
      "category": "behavior",
      "desc": "The starting Header number for generating a TOC",
      "values": [ 1, 2, 3, 4, 5 ]
    },
    "toc-end": {
      "type": "Number",
      "category": "behavior",
      "desc": "The ending Header number for generating a TOC. Must be greater than tocStart",
      "values": [ 2, 3, 4, 5, 6 ]
    },
    "task-lists-enable": {
      "type": "Boolean",
      "category": "content",
      "desc": "Set to true to enable (not read-only) Task Lists"
    },
    "task-lists-label": {
      "type": "Boolean",
      "category": "style",
      "desc": "Set to true to wrap the rendered list items in a <label> element for UX purposes"
    },
    "task-lists-label-after": {
      "type": "Boolean",
      "category": "style",
      "desc": "To add the label after the checkbox (requires `task-lists-label` to be set to `true`)"
    },
    "extend": {
      "type": "Function",
      "category": "extend",
      "desc": "Used to extend the markdown processor. You can use any 'markdown-it' plugin or write your own",
      "params": {
        "md": {
          "type": "Object",
          "desc": "The `markdown-it` instance",
          "__exemption": [ "examples" ]
        }
      },
      "examples": [
        ":extend=\"extendMarkdownFn\"",
        ":extend=\"(md) => extendMarkdownFn(md)\""
      ],
      "returns": null
    },
    "extend-prism": {
      "type": "Function",
      "category": "extend",
      "addedIn": "v1.0.0",
      "desc": "Used to extend the [Prism](https://prismjs.com/extending.html) code highlighter",
      "params": {
        "Prism": {
          "type": "Object",
          "desc": "The `Prism` instance",
          "__exemption": [ "examples" ]
        }
      },
      "examples": [
        ":extendPrism=\"extendPrismFn\"",
        ":extendPrism=\"(Prism) => extendPrismFn(Prism)\""
      ],
      "returns": null
    },
    "content-class": {
      "type": [ "Array", "String", "Object" ],
      "category": "style",
      "desc": "Class definitions to be attributed to the markdown container",
      "examples": [
        "my-special-class",
        ":content-class=\"{ 'my-special-class': <condition> }\""
      ]
    },
    "content-style": {
      "type": [ "Array", "String", "Object" ],
      "category": "style",
      "desc": "Style definitions to be attributed to the markdown container",
      "examples": [
        "background-color: #ff0000",
        ":content-style=\"{ backgroundColor: '#ff0000' }\""
      ]
    },
    "no-noopener": {
      "addedIn": "v1.2.0",
      "type": "Boolean",
      "category": "behavior",
      "desc": "All external links will have the `rel=\"noopener\" applied if this is not set"
    },
    "no-noreferrer": {
      "addedIn": "v1.2.0",
      "type": "Boolean",
      "category": "behavior",
      "desc": "All external links will have the `rel=\"noreferrer\" applied if this is not set"
    },
    "show-copy": {
      "addedIn": "v1.3.0",
      "type": "Boolean",
      "category": "behavior",
      "desc": "Use this property to turn on \"Copy to Clipboard\" functionality"
    },
    "copy-icon": {
      "addedIn": "v1.3.0",
      "type": "String",
      "category": "behavior",
      "desc": "Change the default icon used for Copy to Clipboard",
      "examples": [
        "copy-icon=\"copy\"",
        ":copy-icon=\"matCopy\""
      ]
    },
    "no-copy-tooltip": {
      "addedIn": "v1.3.0",
      "type": "Boolean",
      "category": "behavior",
      "desc": "Turns off the tooltip associated with the **Copy to Clipboard** icon"
    },
    "copy-tooltip-text": {
      "addedIn": "v1.3.0",
      "type": "String",
      "category": "behavior",
      "desc": "Change the tooltip text associated with the **Copy to Clipboard** icon",
      "default": "Copy to clipboard",
      "examples": [
        "copy-tooltip-text=\"Click here for content to be copied to the clipboard\"",
        ":copy-tooltip-text=\"$t('copy-tooltip-text')\""
      ]
    },
    "copy-response-text": {
      "addedIn": "v1.3.0",
      "type": "String",
      "category": "behavior",
      "desc": "Change the response text associated with the **Copy to Clipboard** icon (note: you **must** have the `dialog` plugin added to your quasar.conf.js)",
      "default": "Copied to clipboard",
      "examples": [
        "copy-response-text=\"The content was copied to the clipboard\"",
        ":copy-response-text=\"$t('copy-response-text')\""
      ]
    }
  },
  "events": {
    "toc": {
      "desc": "If `toc` property is `true` then if a TOC is generated it is emitted via this event",
      "params": {
        "tocData": {
          "type": "Array",
          "tsType": "TocDefinitionArray",
          "desc": "Array of one or more TOC data objects",
          "definition": {
            "id": {
              "type": "String",
              "desc": "The id for the TOC header",
              "__exemption": [ "examples" ]
            },
            "label": {
              "type": "String",
              "desc": "The TOC header label",
              "__exemption": [ "examples" ]
            },
            "level": {
              "type": "Number",
              "desc": "The TOC header type (1=h1, 2=h2, etc)",
              "__exemption": [ "examples" ]
            },
            "children": {
              "type": "Array",
              "tsType": "TocDefinitionArray",
              "desc": "This is normally empty, unless you pass this toc array to the `makeTree` method",
              "__exemption": [ "examples" ]
            }
          }
        }
      }
    }
  },
  "slots": {
    "default": {
      "desc": "This is the default slot to be used for markdown"
    }
  },
  "methods": {
    "makeTree": {
      "type": "Function",
      "desc": "Pass into this function the results from the `@toc` event to have the data array transformed into a hierarchical tree",
      "params": {
        "data": {
          "type": "Array",
          "tsType": "TocDefinitionArray",
          "desc": "The results from the `@toc` event",
          "__exemption": [ "examples" ]
        }
      },
      "returns": {
        "type": "Array",
        "tsType": "TocDefinitionArray",
        "desc": "A modified version of the passed in data in a hierachical format",
        "definition": {
          "id": {
            "type": "String",
            "desc": "The slugified heading used for the html key",
            "examples": [
              "the-heading"
            ]
          },
          "label": {
            "type": "String",
            "desc": "The original label",
            "examples": [
              "The Heading"
            ]
          },
          "level": {
            "type": "Number",
            "desc": "The heading level: h1 == 1, h2 == 2m, etc.",
            "examples": [
              "1",
              "2"
            ]
          },
          "children": {
            "type": "Array",
            "tsType": "TocDefinitionArray",
            "desc": "If this object is level 1, then any level 2 objects will be in the `children` key and so on",
            "__exemption": [ "examples" ]
          }
        }
      }
    }
  }
}