npm - ads-fe - Versions diffs - 0.0.1 - Mend

ads-fe 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (608) hide show

package/skills/vueuse-functions/references/useStorageAsync.md ADDED Viewed

@@ -0,0 +1,136 @@
+---
+category: State
+---
+# useStorageAsync
+Reactive Storage with async support.
+## Usage
+The basic usage please refer to `useStorage`.
+## Wait First Loaded
+When user entering your app, `useStorageAsync()` will start loading value from an async storage,
+sometimes you may get the default initial value, not the real value stored in storage at the very
+beginning.
+```ts
+import { useStorageAsync } from '@vueuse/core'
+const accessToken = useStorageAsync('access.token', '', SomeAsyncStorage)
+// accessToken.value may be empty before the async storage is ready
+console.log(accessToken.value) // ""
+setTimeout(() => {
+  // After some time, the async storage is ready
+  console.log(accessToken.value) // "the real value stored in storage"
+}, 500)
+```
+In this case, you can wait the storage prepared, the returned value is also a `Promise`,
+so you can wait it resolved in your template or script.
+```ts
+// Use top-level await if your environment supports it
+const accessToken = await useStorageAsync('access.token', '', SomeAsyncStorage)
+console.log(accessToken.value) // "the real value stored in storage"
+```
+If you must wait multiple storages, put them into a `Promise.allSettled()`
+```ts
+router.onReady(async () => {
+  await Promise.allSettled([
+    accessToken,
+    refreshToken,
+    userData,
+  ])
+  app.mount('app')
+})
+```
+There is a callback named `onReady` in options:
+```ts
+import { useStorageAsync } from '@vueuse/core'
+// Use ES2024 Promise.withResolvers, you may use any Deferred object or EventBus to do same thing.
+const { promise, resolve } = Promise.withResolvers()
+const accessToken = useStorageAsync('access.token', '', SomeAsyncStorage, {
+  onReady(value) {
+    resolve(value)
+  }
+})
+// At main.ts
+router.onReady(async () => {
+  // Let's wait accessToken loaded
+  await promise
+  // Now accessToken has loaded, we can safely mount our app
+  app.mount('app')
+})
+```
+Simply use `resolve` as callback:
+```ts
+const accessToken = useStorageAsync('access.token', '', SomeAsyncStorage, {
+  onReady: resolve
+})
+```
+## Type Declarations
+```ts
+export interface UseStorageAsyncOptions<T> extends Omit<
+  UseStorageOptions<T>,
+  "serializer"
+> {
+  /**
+   * Custom data serialization
+   */
+  serializer?: SerializerAsync<T>
+  /**
+   * On first value loaded hook.
+   */
+  onReady?: (value: T) => void
+}
+export declare function useStorageAsync(
+  key: string,
+  initialValue: MaybeRefOrGetter<string>,
+  storage?: StorageLikeAsync,
+  options?: UseStorageAsyncOptions<string>,
+): RemovableRef<string> & Promise<RemovableRef<string>>
+export declare function useStorageAsync(
+  key: string,
+  initialValue: MaybeRefOrGetter<boolean>,
+  storage?: StorageLikeAsync,
+  options?: UseStorageAsyncOptions<boolean>,
+): RemovableRef<boolean> & Promise<RemovableRef<boolean>>
+export declare function useStorageAsync(
+  key: string,
+  initialValue: MaybeRefOrGetter<number>,
+  storage?: StorageLikeAsync,
+  options?: UseStorageAsyncOptions<number>,
+): RemovableRef<number> & Promise<RemovableRef<number>>
+export declare function useStorageAsync<T>(
+  key: string,
+  initialValue: MaybeRefOrGetter<T>,
+  storage?: StorageLikeAsync,
+  options?: UseStorageAsyncOptions<T>,
+): RemovableRef<T> & Promise<RemovableRef<T>>
+export declare function useStorageAsync<T = unknown>(
+  key: string,
+  initialValue: MaybeRefOrGetter<null>,
+  storage?: StorageLikeAsync,
+  options?: UseStorageAsyncOptions<T>,
+): RemovableRef<T> & Promise<RemovableRef<T>>
+```

package/skills/vueuse-functions/references/useStyleTag.md ADDED Viewed

@@ -0,0 +1,131 @@
+---
+category: Browser
+---
+# useStyleTag
+Inject reactive `style` element in head.
+## Usage
+### Basic usage
+Provide a CSS string, then `useStyleTag` will automatically generate an id and inject it in `<head>`.
+```ts
+import { useStyleTag } from '@vueuse/core'
+const {
+  id,
+  css,
+  load,
+  unload,
+  isLoaded,
+} = useStyleTag('.foo { margin-top: 32px; }')
+// Later you can modify styles
+css.value = '.foo { margin-top: 64px; }'
+```
+This code will be injected to `<head>`:
+```html
+<style id="vueuse_styletag_1">
+  .foo {
+    margin-top: 64px;
+  }
+</style>
+```
+### Custom ID
+If you need to define your own id, you can pass `id` as first argument.
+```ts
+import { useStyleTag } from '@vueuse/core'
+// ---cut---
+useStyleTag('.foo { margin-top: 32px; }', { id: 'custom-id' })
+```
+```html
+<!-- injected to <head> -->
+<style id="custom-id">
+  .foo {
+    margin-top: 32px;
+  }
+</style>
+```
+### Media query
+You can pass media attributes as last argument within object.
+```ts
+import { useStyleTag } from '@vueuse/core'
+// ---cut---
+useStyleTag('.foo { margin-top: 32px; }', { media: 'print' })
+```
+```html
+<!-- injected to <head> -->
+<style id="vueuse_styletag_1" media="print">
+  .foo {
+    margin-top: 32px;
+  }
+</style>
+```
+## Type Declarations
+```ts
+export interface UseStyleTagOptions extends ConfigurableDocument {
+  /**
+   * Media query for styles to apply
+   */
+  media?: string
+  /**
+   * Load the style immediately
+   *
+   * @default true
+   */
+  immediate?: boolean
+  /**
+   * Manual controls the timing of loading and unloading
+   *
+   * @default false
+   */
+  manual?: boolean
+  /**
+   * DOM id of the style tag
+   *
+   * @default auto-incremented
+   */
+  id?: string
+  /**
+   * Nonce value for CSP (Content Security Policy)
+   *
+   * @default undefined
+   */
+  nonce?: string
+}
+export interface UseStyleTagReturn {
+  id: string
+  css: ShallowRef<string>
+  load: () => void
+  unload: () => void
+  isLoaded: Readonly<ShallowRef<boolean>>
+}
+/**
+ * Inject <style> element in head.
+ *
+ * Overload: Omitted id
+ *
+ * @see https://vueuse.org/useStyleTag
+ * @param css
+ * @param options
+ */
+export declare function useStyleTag(
+  css: MaybeRef<string>,
+  options?: UseStyleTagOptions,
+): UseStyleTagReturn
+```

package/skills/vueuse-functions/references/useSubject.md ADDED Viewed

@@ -0,0 +1,77 @@
+---
+category: '@RxJS'
+---
+# useSubject
+Bind an RxJS [`Subject`](https://rxjs.dev/guide/subject) to a `ref` and propagate value changes both ways.
+## Usage
+<!-- TODO: import rxjs error if enable twoslash -->
+```ts no-twoslash
+import { useSubject } from '@vueuse/rxjs'
+import { Subject } from 'rxjs'
+const subject = new Subject()
+// setup()
+const subjectRef = useSubject(subject)
+// Changes to subjectRef.value will be pushed to the subject
+subjectRef.value = 'new value'
+// Values emitted by the subject will update subjectRef
+subject.next('from subject')
+```
+### With BehaviorSubject
+When using a `BehaviorSubject`, the returned ref is initialized with the subject's current value and the type does not include `undefined`:
+```ts no-twoslash
+import { useSubject } from '@vueuse/rxjs'
+import { BehaviorSubject } from 'rxjs'
+const subject = new BehaviorSubject('initial')
+// setup()
+const subjectRef = useSubject(subject) // Ref<string>, not Ref<string | undefined>
+console.log(subjectRef.value) // 'initial'
+```
+### Error Handling
+If you want to add custom error handling to a Subject that might error, you can supply an optional `onError` configuration. Without this, RxJS will treat any error in the supplied observable as an "unhandled error" and it will be thrown in a new call stack and reported to `window.onerror` (or `process.on('error')` if you happen to be in node).
+```ts no-twoslash
+import { useSubject } from '@vueuse/rxjs'
+import { Subject } from 'rxjs'
+const subject = new Subject()
+// setup()
+const subjectRef = useSubject(subject, {
+  onError: (err) => {
+    console.log(err.message) // "oops"
+  },
+},)
+```
+## Type Declarations
+```ts
+export interface UseSubjectOptions<I = undefined> extends Omit<
+  UseObservableOptions<I>,
+  "initialValue"
+> {}
+export declare function useSubject<H>(
+  subject: BehaviorSubject<H>,
+  options?: UseSubjectOptions,
+): Ref<H>
+export declare function useSubject<H>(
+  subject: Subject<H>,
+  options?: UseSubjectOptions,
+): Ref<H | undefined>
+```

package/skills/vueuse-functions/references/useSubscription.md ADDED Viewed

@@ -0,0 +1,33 @@
+---
+category: '@RxJS'
+---
+# useSubscription
+Use an RxJS [`Subscription`](https://rxjs.dev/guide/subscription) without worrying about unsubscribing from it or creating memory leaks.
+## Usage
+<!-- TODO: import rxjs error if enable twoslash -->
+```ts no-twoslash
+import { useSubscription } from '@vueuse/rxjs'
+import { interval } from 'rxjs'
+const count = ref(0)
+// useSubscription call unsubscribe method before unmount the component
+useSubscription(
+  interval(1000)
+    .subscribe(() => {
+      count.value++
+      console.log(count)
+    }),
+)
+```
+## Type Declarations
+```ts
+export declare function useSubscription(subscription: Unsubscribable): void
+```

package/skills/vueuse-functions/references/useSum.md ADDED Viewed

@@ -0,0 +1,36 @@
+---
+category: '@Math'
+---
+# useSum
+Get the sum of an array reactively
+## Usage
+```ts
+import { useSum } from '@vueuse/math'
+const array = ref([1, 2, 3, 4])
+const sum = useSum(array) // Ref<10>
+```
+```ts
+import { useSum } from '@vueuse/math'
+const a = ref(1)
+const b = ref(3)
+const sum = useSum(a, b, 2) // Ref<6>
+```
+## Type Declarations
+```ts
+export declare function useSum(
+  array: MaybeRefOrGetter<MaybeRefOrGetter<number>[]>,
+): ComputedRef<number>
+export declare function useSum(
+  ...args: MaybeRefOrGetter<number>[]
+): ComputedRef<number>
+```

package/skills/vueuse-functions/references/useSupported.md ADDED Viewed

@@ -0,0 +1,29 @@
+---
+category: Utilities
+---
+# useSupported
+SSR compatibility `isSupported`
+## Usage
+```ts
+import { useSupported } from '@vueuse/core'
+const isSupported = useSupported(() => navigator && 'getBattery' in navigator)
+if (isSupported.value) {
+  // do something
+  navigator.getBattery
+}
+```
+## Type Declarations
+```ts
+export type UseSupportedReturn = ComputedRef<boolean>
+export declare function useSupported(
+  callback: () => unknown,
+): UseSupportedReturn
+```

package/skills/vueuse-functions/references/useSwipe.md ADDED Viewed

@@ -0,0 +1,75 @@
+---
+category: Sensors
+---
+# useSwipe
+Reactive swipe detection based on [`TouchEvents`](https://developer.mozilla.org/en-US/docs/Web/API/TouchEvent).
+## Usage
+```vue
+<script setup lang="ts">
+import { useSwipe } from '@vueuse/core'
+import { useTemplateRef } from 'vue'
+const el = useTemplateRef('el')
+const { isSwiping, direction } = useSwipe(el)
+</script>
+<template>
+  <div ref="el">
+    Swipe here
+  </div>
+</template>
+```
+## Type Declarations
+```ts
+export type UseSwipeDirection = "up" | "down" | "left" | "right" | "none"
+export interface UseSwipeOptions extends ConfigurableWindow {
+  /**
+   * Register events as passive
+   *
+   * @default true
+   */
+  passive?: boolean
+  /**
+   * @default 50
+   */
+  threshold?: number
+  /**
+   * Callback on swipe start
+   */
+  onSwipeStart?: (e: TouchEvent) => void
+  /**
+   * Callback on swipe moves
+   */
+  onSwipe?: (e: TouchEvent) => void
+  /**
+   * Callback on swipe ends
+   */
+  onSwipeEnd?: (e: TouchEvent, direction: UseSwipeDirection) => void
+}
+export interface UseSwipeReturn {
+  isSwiping: ShallowRef<boolean>
+  direction: ComputedRef<UseSwipeDirection>
+  coordsStart: Readonly<Position>
+  coordsEnd: Readonly<Position>
+  lengthX: ComputedRef<number>
+  lengthY: ComputedRef<number>
+  stop: () => void
+}
+/**
+ * Reactive swipe detection.
+ *
+ * @see https://vueuse.org/useSwipe
+ * @param target
+ * @param options
+ */
+export declare function useSwipe(
+  target: MaybeRefOrGetter<EventTarget | null | undefined>,
+  options?: UseSwipeOptions,
+): UseSwipeReturn
+```

package/skills/vueuse-functions/references/useTemplateRefsList.md ADDED Viewed

@@ -0,0 +1,37 @@
+---
+category: Component
+---
+# useTemplateRefsList
+Shorthand for binding refs to template elements and components inside `v-for`.
+## Usage
+```vue
+<script setup lang="ts">
+import { useTemplateRefsList } from '@vueuse/core'
+import { onUpdated } from 'vue'
+const refs = useTemplateRefsList<HTMLDivElement>()
+onUpdated(() => {
+  console.log(refs)
+})
+</script>
+<template>
+  <div v-for="i of 5" :key="i" :ref="refs.set" />
+</template>
+```
+## Type Declarations
+```ts
+export type TemplateRefsList<T> = T[] & {
+  set: (el: object | null) => void
+}
+export declare function useTemplateRefsList<T = Element>(): Readonly<
+  Ref<Readonly<TemplateRefsList<T>>>
+>
+```

package/skills/vueuse-functions/references/useTextDirection.md ADDED Viewed

@@ -0,0 +1,75 @@
+---
+category: Browser
+---
+# useTextDirection
+Reactive [dir](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) of the element's text.
+## Usage
+```ts
+import { useTextDirection } from '@vueuse/core'
+const dir = useTextDirection() // Ref<'ltr' | 'rtl' | 'auto'>
+```
+By default, it returns `rtl` direction when dir `rtl` is applied to the `html` tag, for example:
+```html
+<!--ltr-->
+<html>
+  ...
+</html>
+<!--rtl-->
+<html dir="rtl">
+  ...
+</html>
+```
+## Options
+```ts
+import { useTextDirection } from '@vueuse/core'
+const mode = useTextDirection({
+  selector: 'body'
+}) // Ref<'ltr' | 'rtl' | 'auto'>
+```
+## Type Declarations
+```ts
+export type UseTextDirectionValue = "ltr" | "rtl" | "auto"
+export interface UseTextDirectionOptions extends ConfigurableDocument {
+  /**
+   * CSS Selector for the target element applying to
+   *
+   * @default 'html'
+   */
+  selector?: string
+  /**
+   * Observe `document.querySelector(selector)` changes using MutationObserve
+   *
+   * @default false
+   */
+  observe?: boolean
+  /**
+   * Initial value
+   *
+   * @default 'ltr'
+   */
+  initialValue?: UseTextDirectionValue
+}
+/**
+ * Reactive dir of the element's text.
+ *
+ * @see https://vueuse.org/useTextDirection
+ *
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function useTextDirection(
+  options?: UseTextDirectionOptions,
+): WritableComputedRef<UseTextDirectionValue, UseTextDirectionValue>
+```

package/skills/vueuse-functions/references/useTextSelection.md ADDED Viewed

@@ -0,0 +1,43 @@
+---
+category: Sensors
+---
+# useTextSelection
+Reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection).
+## Usage
+```vue
+<script setup lang="ts">
+import { useTextSelection } from '@vueuse/core'
+const state = useTextSelection()
+</script>
+<template>
+  <p>{{ state.text }}</p>
+</template>
+```
+## Type Declarations
+```ts
+export interface UseTextSelectionOptions extends ConfigurableWindow {}
+export interface UseTextSelectionReturn {
+  text: ComputedRef<string>
+  rects: ComputedRef<DOMRect[]>
+  ranges: ComputedRef<Range[]>
+  selection: ShallowRef<Selection | null>
+}
+/**
+ * Reactively track user text selection based on [`Window.getSelection`](https://developer.mozilla.org/en-US/docs/Web/API/Window/getSelection).
+ *
+ * @see https://vueuse.org/useTextSelection
+ *
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function useTextSelection(
+  options?: UseTextSelectionOptions,
+): UseTextSelectionReturn
+```