QScrollArea.json

{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/vue-components/scroll-area"
  },

  "props": {
    "dark": {
      "extends": "dark",
      "addedIn": "v1.9.0"
    },

    "bar-style": {
      "type": [ "Array", "String", "Object"],
      "desc": "Object with CSS properties and values for custom styling the scrollbars (both vertical and horizontal)",
      "examples": [ ":bar-style=\"{ borderRadius: '5px', background: 'red', opacity: 1 }\"" ],
      "category": "style",
      "addedIn": "v1.5.0"
    },

    "vertical-bar-style": {
      "type": [ "Array", "String", "Object"],
      "desc": "Object with CSS properties and values for custom styling the vertical scrollbar; Is applied on top of 'bar-style' prop",
      "examples": [ ":bar-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\"" ],
      "category": "style",
      "addedIn": "v1.17"
    },

    "horizontal-bar-style": {
      "type": [ "Array", "String", "Object"],
      "desc": "Object with CSS properties and values for custom styling the horizontal scrollbar; Is applied on top of 'bar-style' prop",
      "examples": [ ":bar-style=\"{ bottom: '4px', borderRadius: '5px', background: 'red', height: '10px', opacity: 1 }\"" ],
      "category": "style",
      "addedIn": "v1.17"
    },

    "thumb-style": {
      "type": "Object",
      "desc": "Object with CSS properties and values for custom styling the thumb of scrollbars (both vertical and horizontal)",
      "examples": [ ":thumb-style=\"{ borderRadius: '5px', background: 'red', opacity: 1 }\"" ],
      "category": "style"
    },

    "vertical-thumb-style": {
      "type": "Object",
      "desc": "Object with CSS properties and values for custom styling the thumb of the vertical scrollbar; Is applied on top of 'thumb-style' prop",
      "examples": [ ":thumb-style=\"{ right: '4px', borderRadius: '5px', background: 'red', width: '10px', opacity: 1 }\"" ],
      "category": "style",
      "addedIn": "v1.17"
    },

    "horizontal-thumb-style": {
      "type": "Object",
      "desc": "Object with CSS properties and values for custom styling the thumb of the horizontal scrollbar; Is applied on top of 'thumb-style' prop",
      "examples": [ ":thumb-style=\"{ bottom: '4px', borderRadius: '5px', background: 'red', height: '10px', opacity: 1 }\"" ],
      "category": "style",
      "addedIn": "v1.17"
    },

    "content-style": {
      "type": [ "Array", "String", "Object"],
      "desc": "Object with CSS properties and values for styling the container of QScrollArea",
      "examples": [ ":content-style=\"{ backgroundColor: '#C0C0C0' }\"" ],
      "category": "style"
    },

    "content-active-style": {
      "type": [ "Array", "String", "Object"],
      "desc": "Object with CSS properties and values for styling the container of QScrollArea when scroll area becomes active (is mouse hovered)",
      "examples": [ ":content-active-style=\"{ backgroundColor: 'white' }\"" ],
      "category": "style"
    },

    "visible": {
      "type": "Boolean",
      "desc": "Manually control the visibility of the scrollbar; Overrides default mouse over/leave behavior",
      "category": "behavior",
      "addedIn": "v1.3.0"
    },

    "delay": {
      "type": [ "Number", "String" ],
      "desc": "When content changes, the scrollbar appears; this delay defines the amount of time (in milliseconds) before scrollbars disappear again (if component is not hovered)",
      "default": 1000,
      "examples": [ 500, ":delay=\"550\"" ],
      "category": "behavior"
    },

    "horizontal": {
      "type": "Boolean",
      "desc": "Changes the default axis to horizontal instead of vertical (which is default) for getScrollPosition, getScrollPercentage, setScrollPosition, and setScrollPercentage",
      "category": "behavior"
    },

    "tabindex": {
      "extends": "tabindex",
      "addedIn": "v1.15.15"
    }
  },

  "slots": {
    "default": {
      "extends": "default"
    }
  },

  "events": {
    "scroll": {
      "desc": "Emitted when scroll information changes (and listener is configured)",
      "params": {
        "info": {
          "type": "Object",
          "__exemption": [ "examples" ],
          "definition": {
            "ref": {
              "type": "Object",
              "desc": "Vue reference to the QScrollArea which triggered the event",
              "__exemption": [ "examples" ]
            },
            "verticalPosition": {
              "type": "Number",
              "desc": "Vertical scroll position (in px)",
              "__exemption": [ "examples" ]
            },
            "verticalPercentage": {
              "type": "Number",
              "desc": "Vertical scroll percentage (0.0 <= x <= 1.0)",
              "__exemption": [ "examples" ]
            },
            "verticalSize": {
              "type": "Number",
              "desc": "Vertical scroll size (in px)",
              "__exemption": [ "examples" ]
            },
            "verticalContainerSize": {
              "type": "Number",
              "desc": "Height of the container (in px)",
              "__exemption": [ "examples" ]
            },

            "horizontalPosition": {
              "type": "Number",
              "desc": "Horizontal scroll position (in px)",
              "__exemption": [ "examples" ]
            },
            "horizontalPercentage": {
              "type": "Number",
              "desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)",
              "__exemption": [ "examples" ]
            },
            "horizontalSize": {
              "type": "Number",
              "desc": "Horizontal scroll size (in px)",
              "__exemption": [ "examples" ]
            },
            "horizontalContainerSize": {
              "type": "Number",
              "desc": "Width of the container (in px)",
              "__exemption": [ "examples" ]
            }
          }
        }
      },
      "addedIn": "v1.9.3"
    }
  },

  "methods": {
    "getScrollTarget": {
      "desc": "Get the scrolling DOM element target",
      "returns": {
        "type": "Object",
        "desc": "DOM element upon which scrolling takes place",
        "__exemption": [ "examples" ]
      }
    },

    "getScroll": {
      "desc": "Get the current scroll information",
      "returns": {
        "type": "Object",
        "desc": "Scroll information",
        "__exemption": [ "examples" ],
        "definition": {
          "verticalPosition": {
            "type": "Number",
            "desc": "Vertical scroll position (in px)",
            "__exemption": [ "examples" ]
          },
          "verticalPercentage": {
            "type": "Number",
            "desc": "Vertical scroll percentage (0.0 <= x <= 1.0)",
            "__exemption": [ "examples" ]
          },
          "verticalSize": {
            "type": "Number",
            "desc": "Vertical scroll size (in px)",
            "__exemption": [ "examples" ]
          },
          "verticalContainerSize": {
            "type": "Number",
            "desc": "Height of the container (in px)",
            "__exemption": [ "examples" ]
          },

          "horizontalPosition": {
            "type": "Number",
            "desc": "Horizontal scroll position (in px)",
            "__exemption": [ "examples" ]
          },
          "horizontalPercentage": {
            "type": "Number",
            "desc": "Horizontal scroll percentage (0.0 <= x <= 1.0)",
            "__exemption": [ "examples" ]
          },
          "horizontalSize": {
            "type": "Number",
            "desc": "Horizontal scroll size (in px)",
            "__exemption": [ "examples" ]
          },
          "horizontalContainerSize": {
            "type": "Number",
            "desc": "Width of the container (in px)",
            "__exemption": [ "examples" ]
          }
        }
      },
      "addedIn": "v1.17"
    },

    "getScrollPosition": {
      "desc": "Get current scroll position",
      "params": {
        "axis": {
          "type": "String",
          "desc": "Scroll axis - defaults to 'vertical' (or to 'horizontal' if horizontal prop is set)",
          "values": [ "vertical", "horizontal", "both" ]
        }
      },
      "returns": {
        "type": "Object",
        "definition": {
          "top": {
            "type": "Number",
            "desc": "Scroll offset from top (vertical)",
            "examples": [ 120 ]
          },
          "left": {
            "type": "Number",
            "desc": "Scroll offset from left (horizontal)",
            "examples": [ 10 ]
          }
        },
        "examples": [ "{ top: 10, left: 0 }" ]
      },
      "addedIn": "v1.17"
    },

    "getScrollPercentage": {
      "desc": "Get current scroll position in percentage (0.0 <= x <= 1.0)",
      "params": {
        "axis": {
          "type": "String",
          "desc": "Scroll axis - defaults to 'vertical' (or to 'horizontal' if horizontal prop is set)",
          "values": [ "vertical", "horizontal", "both" ]
        }
      },
      "returns": {
        "type": "Object",
        "definition": {
          "top": {
            "type": "Number",
            "desc": "Scroll percentage (0.0 <= x <= 1.0) offset from top (vertical)",
            "examples": [ 0.12 ]
          },
          "left": {
            "type": "Number",
            "desc": "Scroll percentage (0.0 <= x <= 1.0) offset from left (horizontal)",
            "examples": [ 0.92 ]
          }
        },
        "examples": [ "{ top: 0.212, left: 0 }" ]
      },
      "addedIn": "v1.17"
    },

    "setScrollPosition": {
      "desc": "Set scroll position to an offset; If a duration (in milliseconds) is specified then the scroll is animated",
      "params": {
        "axis": {
          "type": "String",
          "desc": "Scroll axis",
          "values": [ "vertical", "horizontal" ],
          "required": true
        },
        "offset": {
          "type": "Number",
          "desc": "Scroll position offset from top (in pixels)",
          "required": true,
          "examples": [ 220 ]
        },
        "duration": {
          "type": "Number",
          "desc": "Duration (in milliseconds) enabling animated scroll",
          "examples": [ 300 ]
        }
      }
    },

    "setScrollPercentage": {
      "desc": "Set scroll position to a percentage (0.0 <= x <= 1.0) of the total scrolling size; If a duration (in milliseconds) is specified then the scroll is animated",
      "params": {
        "axis": {
          "type": "String",
          "desc": "Scroll axis",
          "values": [ "vertical", "horizontal" ],
          "required": true
        },
        "offset": {
          "type": "Number",
          "desc": "Scroll percentage (0.0 <= x <= 1.0) of the total scrolling size",
          "required": true,
          "examples": [ 220 ]
        },
        "duration": {
          "type": "Number",
          "desc": "Duration (in milliseconds) enabling animated scroll",
          "examples": [ 300 ]
        }
      },
      "addedIn": "v1.17"
    }
  }
}