quasar/ui/src/components/pull-to-refresh/QPullToRefresh.json at v1 · hipertracker/quasar · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/vue-components/pull-to-refresh"
  },

  "behavior": {
    "$listeners": true
  },

  "props": {
    "color": {
      "desc": "Color name for the icon from the Quasar Color Palette",
      "extends": "color"
    },

    "bg-color": {
      "desc": "Color name for background of the icon container from the Quasar Color Palette",
      "extends": "color",
      "addedIn": "v1.9.5"
    },

    "icon": {
      "extends": "icon",
      "desc": "Icon to display when refreshing the content"
    },

    "no-mouse": {
      "type": "Boolean",
      "desc": "Don't listen for mouse events",
      "category": "behavior"
    },

    "disable": {
      "extends": "disable"
    },

    "scroll-target": {
      "extends": "scroll-target"
    }
  },

  "slots": {
    "default": {
      "desc": "Content (area controlled by the component) goes here"
    }
  },

  "events": {
    "refresh": {
      "desc": "Called whenever a refresh is triggered; at this time, your function should load more data",
      "params": {
        "done": {
          "type": "Function",
          "desc": "Call the done() function when your data has been refreshed",
          "params": null,
          "returns": null
        }
      }
    }
  },

  "methods": {
    "trigger": {
      "desc": "Triggers a refresh"
    },

    "updateScrollTarget": {
      "desc": "Updates the scroll target; Useful when the parent elements change so that the scrolling target also changes"
    }
  }
}