@quasar/quasar-ui-qcalendar/src/composables/private.useScheduler.json

QCalendar - Day/Month/Week Calendars, Popups, Date Pickers, Schedules, Agendas, Planners and Tasks for your Vue Apps

{
  "props": {
    "model-resources": {
      "type": "Array",
      "tsType": "ResourceObjectArray",
      "category": "model",
      "required": true,
      "desc": "An array of objects with a single key of label. You can add other keys if you like, which will be passed back on the appropriate scoped slots",
      "applicable": [
        "scheduler"
      ],
      "examples": [
        "[{ label: 'John' },{ label: 'Susan' }]"
      ]
    },
    "resource-key": {
      "type": "String",
      "category": "model",
      "desc": "The key from the `resources` object that will be displayed",
      "default": "'label'",
      "applicable": [
        "scheduler"
      ],
      "examples": [
        "'label'",
        "'name'"
      ]
    },
    "resource-height": {
      "type": [
        "Number",
        "String"
      ],
      "category": "behavior",
      "desc": "The maximum height in pixels for the resource height",
      "default": "70",
      "applicable": [
        "scheduler",
        "resource",
        "day-resource"
      ],
      "examples": [
        "80",
        "'100'"
      ]
    },
    "resource-class": {
      "type": "Function",
      "desc": "A function that returns a class name for a resource",
      "category": "style",
      "default": "# null",
      "params": {
        "data": {
          "type": "Object",
          "desc": "The data passed to the function",
          "definition": {
            "scope": {
              "type": "Object",
              "desc": "The scope object",
              "definition": {
                "resource": {
                  "type": "Object",
                  "desc": "The resource object"
                },
                "resourceIndex": {
                  "type": "Number",
                  "desc": "The index of the resource in the model-resources array"
                },
                "timestamps": {
                  "type": "Array",
                  "tsType": "TimestampArray",
                  "desc": "The array of timestamps for the intervals"
                },
                "indentLevel": {
                  "type": "Number",
                  "desc": "The indent level of the resource"
                },
                "label": {
                  "type": "String",
                  "desc": "The label of the resource"
                }
              }
            }
          }
        }
      },
      "returns": {
        "type": "String",
        "desc": "The class name to apply to the resource"
      }
    },
    "resource-style": {
      "type": "Function",
      "category": "style",
      "desc": "Gets called to provide custom styling of a resource",
      "params": {
        "data": {
          "type": "Object",
          "desc": "The data passed to the function",
          "__exemption": [
            "examples"
          ],
          "definition": {
            "timestamp": {
              "type": "Timestamp",
              "tsType": "Timestamp",
              "desc": "A timestamp object associated with the interval",
              "__exemption": [
                "examples"
              ]
            },
            "index": {
              "type": "Number",
              "desc": "The resource index",
              "__exemption": [
                "examples"
              ]
            },
            "resource": {
              "type": "Object",
              "tsType": "ResourceObject",
              "desc": "The resource object",
              "__exemption": [
                "examples"
              ]
            }
          }
        }
      },
      "returns": {
        "type": [
          "Array",
          "Object",
          "String"
        ],
        "desc": "A Vue style object",
        "examples": [
          "{ color: '#ccc' }"
        ]
      },
      "default": "(data) => { return {} }",
      "applicable": [
        "scheduler",
        "resource",
        "day-resource"
      ],
      "examples": [
        "(data) => { return { 'background-color': '#c0c0c0' } }",
        "(data) => resourceStyle(data)"
      ]
    },
    "resource-min-height": {
      "type": [
        "Number",
        "String"
      ],
      "default": "0",
      "desc": "The minimum height of a resource",
      "category": "behavior"
    }
  },
  "events": {}
}