quasar/dist/api/Dark.json

Build high-performance VueJS user interfaces (SPA, PWA, SSR, Mobile and Desktop) in record time

{
  "type": "plugin",
  "meta": {
    "docsUrl": "https://v2.quasar.dev/quasar-plugins/dark"
  },
  "injection": "$q.dark",
  "quasarConfOptions": {
    "propName": "dark",
    "type": [
      "Boolean",
      "String"
    ],
    "desc": "\"'auto'\" uses the OS/browser preference. \"true\" forces dark mode. \"false\" forces light mode.",
    "values": [
      "auto",
      "(Boolean) true",
      "(Boolean) false"
    ]
  },
  "props": {
    "isActive": {
      "type": "Boolean",
      "desc": "Is Dark mode active?",
      "reactive": true
    },
    "mode": {
      "type": [
        "Boolean",
        "String"
      ],
      "desc": "Dark mode configuration (not status)",
      "values": [
        "auto",
        "(Boolean) true",
        "(Boolean) false"
      ],
      "reactive": true
    }
  },
  "methods": {
    "set": {
      "desc": "Set dark mode status",
      "params": {
        "status": {
          "type": [
            "Boolean",
            "String"
          ],
          "desc": "Dark mode status",
          "values": [
            "(Boolean) true",
            "(Boolean) false",
            "auto"
          ],
          "required": true
        }
      }
    },
    "toggle": {
      "desc": "Toggle dark mode status"
    }
  }
}