@svelte-use/core/indexes.json

Collection of essential Svelte Utilities

{
  "packages": {
    "shared": {
      "name": "shared",
      "display": "Shared utilities",
      "dir": "packages/shared"
    },
    "core": {
      "name": "core",
      "display": "SvelteUse",
      "description": "Collection of essential Svelte Utilities",
      "dir": "packages/core"
    }
  },
  "categories": [
    "Animation",
    "Browser",
    "Component",
    "Sensors",
    "State",
    "Store",
    "Utilities",
    "Watch"
  ],
  "functions": [
    {
      "name": "readable",
      "package": "shared",
      "docs": "/shared/readable/",
      "category": "Store",
      "description": "auto unsubscribe on destory for `readable`"
    },
    {
      "name": "tryOnDestroy",
      "package": "shared",
      "docs": "/shared/tryOnDestroy/",
      "category": "Component",
      "description": "safe `onDestroy`"
    },
    {
      "name": "tryOnMount",
      "package": "shared",
      "docs": "/shared/tryOnMount/",
      "category": "Component",
      "description": "safe `onMount`"
    },
    {
      "name": "useInterval",
      "package": "shared",
      "docs": "/shared/useInterval/",
      "category": "Animation",
      "description": "reactive counter increases on every interval"
    },
    {
      "name": "useIntervalFn",
      "package": "shared",
      "docs": "/shared/useIntervalFn/",
      "category": "Animation",
      "description": "wrapper for `setInterval` with controls"
    },
    {
      "name": "useTimeout",
      "package": "shared",
      "docs": "/shared/useTimeout/",
      "category": "Animation",
      "description": "update value after a given time with controls"
    },
    {
      "name": "useTimeoutFn",
      "package": "shared",
      "docs": "/shared/useTimeoutFn/",
      "category": "Animation",
      "description": "wrapper for `setTimeout` with controls"
    },
    {
      "name": "utils",
      "package": "shared",
      "internal": true
    },
    {
      "name": "whenever",
      "package": "shared",
      "docs": "/shared/whenever/",
      "category": "Watch",
      "description": "shorthand for watching value to be truthy"
    },
    {
      "name": "writable",
      "package": "shared",
      "docs": "/shared/writable/",
      "category": "Store",
      "description": "auto unsubscribe on destory for `writable`"
    },
    {
      "name": "onClickOutside",
      "package": "core",
      "docs": "/core/onClickOutside/",
      "category": "Sensors",
      "description": "list for clicks outside of an element"
    },
    {
      "name": "useAsyncState",
      "package": "core",
      "docs": "/core/useAsyncState/",
      "category": "Utilities",
      "description": "reactive async state"
    },
    {
      "name": "useEventListener",
      "package": "core",
      "docs": "/core/useEventListener/",
      "category": "Browser",
      "description": "use EventListener with ease"
    },
    {
      "name": "useLocalStorage",
      "package": "core",
      "docs": "/core/useLocalStorage/",
      "category": "State",
      "description": "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)"
    },
    {
      "name": "useMediaQuery",
      "package": "core",
      "docs": "/core/useMediaQuery/",
      "category": "Browser",
      "description": "reactive [Media Query](https://developer.mozilla.org/en-US/docs/Web/CSS/Media_Queries/Testing_media_queries)"
    },
    {
      "name": "useMutationObserver",
      "package": "core",
      "docs": "/core/useMutationObserver/",
      "category": "Sensors",
      "description": "watch for changes being made to the DOM tree"
    },
    {
      "name": "usePreferredDark",
      "package": "core",
      "docs": "/core/usePreferredDark/",
      "category": "Browser",
      "description": "reactive dark theme preference"
    },
    {
      "name": "useRafFn",
      "package": "core",
      "docs": "/core/useRafFn/",
      "category": "Animation",
      "description": "call function on every `requestAnimationFrame`"
    },
    {
      "name": "useSessionStorage",
      "package": "core",
      "docs": "/core/useSessionStorage/",
      "category": "State",
      "description": "reactive [SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)"
    },
    {
      "name": "useStorage",
      "package": "core",
      "docs": "/core/useStorage/",
      "category": "State",
      "description": "reactive [LocalStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage)/[SessionStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/sessionStorage)"
    },
    {
      "name": "useTitle",
      "package": "core",
      "docs": "/core/useTitle/",
      "category": "Browser",
      "description": "reactive document title"
    }
  ]
}