npm - aico-cli - Versions diffs - 2.1.1 → 2.1.23 - Mend

aico-cli 2.1.1 → 2.1.23

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 (549) hide show

package/templates/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/templates/skills/vueuse-functions/references/useSubject.md ADDED Viewed

@@ -0,0 +1,52 @@
+---
+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)
+```
+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/templates/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/templates/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/templates/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 declare function useSupported(
+  callback: () => unknown,
+): ComputedRef<boolean>
+export type UseSupportedReturn = ReturnType<typeof useSupported>
+```

package/templates/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/templates/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/templates/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/templates/skills/vueuse-functions/references/useTextSelection.md ADDED Viewed

@@ -0,0 +1,40 @@
+---
+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
+/**
+ * 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?: ConfigurableWindow): {
+  text: ComputedRef<string>
+  rects: ComputedRef<DOMRect[]>
+  ranges: ComputedRef<Range[]>
+  selection: ShallowRef<Selection | null, Selection | null>
+}
+export type UseTextSelectionReturn = ReturnType<typeof useTextSelection>
+```

package/templates/skills/vueuse-functions/references/useTextareaAutosize.md ADDED Viewed

@@ -0,0 +1,97 @@
+---
+category: Browser
+---
+# useTextareaAutosize
+Automatically update the height of a textarea depending on the content.
+## Usage
+### Simple example
+```vue
+<script setup lang="ts">
+import { useTextareaAutosize } from '@vueuse/core'
+const { textarea, input } = useTextareaAutosize()
+</script>
+<template>
+  <textarea
+    ref="textarea"
+    v-model="input"
+    class="resize-none"
+    placeholder="What's on your mind?"
+  />
+</template>
+```
+::: info
+It's recommended to reset the scrollbar styles for the textarea element to avoid incorrect height values for large amounts of text.
+```css
+textarea {
+  -ms-overflow-style: none;
+  scrollbar-width: none;
+}
+textarea::-webkit-scrollbar {
+  display: none;
+}
+```
+:::
+### With `rows` attribute
+If you need support for the rows attribute on a textarea element, then you should set the `styleProp` option to `minHeight`.
+```vue
+<script setup lang="ts">
+import { useTextareaAutosize } from '@vueuse/core'
+const { textarea, input } = useTextareaAutosize({ styleProp: 'minHeight' })
+</script>
+<template>
+  <textarea
+    ref="textarea"
+    v-model="input"
+    class="resize-none"
+    placeholder="What's on your mind?"
+    rows="3"
+  />
+</template>
+```
+## Type Declarations
+```ts
+export interface UseTextareaAutosizeOptions extends ConfigurableWindow {
+  /** Textarea element to autosize. */
+  element?: MaybeRef<HTMLTextAreaElement | undefined | null>
+  /** Textarea content. */
+  input?: MaybeRef<string>
+  /** Watch sources that should trigger a textarea resize. */
+  watch?: WatchSource | MultiWatchSources
+  /** Function called when the textarea size changes. */
+  onResize?: () => void
+  /** Specify style target to apply the height based on textarea content. If not provided it will use textarea it self.  */
+  styleTarget?: MaybeRef<HTMLElement | undefined>
+  /** Specify the style property that will be used to manipulate height. Can be `height | minHeight`. Default value is `height`. */
+  styleProp?: "height" | "minHeight"
+}
+export declare function useTextareaAutosize(
+  options?: UseTextareaAutosizeOptions,
+): {
+  textarea: Ref<
+    HTMLTextAreaElement | null | undefined,
+    HTMLTextAreaElement | null | undefined
+  >
+  input: Ref<string, string>
+  triggerResize: () => void
+}
+export type UseTextareaAutosizeReturn = ReturnType<typeof useTextareaAutosize>
+```

package/templates/skills/vueuse-functions/references/useThrottleFn.md ADDED Viewed

@@ -0,0 +1,57 @@
+---
+category: Utilities
+related: refThrottled, refDebounced, useDebounceFn
+---
+# useThrottleFn
+Throttle execution of a function. Especially useful for rate limiting execution of handlers on events like resize and scroll.
+> Throttle is a spring that throws balls: after a ball flies out it needs some time to shrink back, so it cannot throw any more balls unless it's ready.
+## Usage
+```ts
+import { useThrottleFn } from '@vueuse/core'
+const throttledFn = useThrottleFn(() => {
+  // do something, it will be called at most 1 time per second
+}, 1000)
+useEventListener(window, 'resize', throttledFn)
+```
+## Recommended Reading
+- [**Debounce vs Throttle**: Definitive Visual Guide](https://kettanaito.com/blog/debounce-vs-throttle)
+## Type Declarations
+```ts
+/**
+ * Throttle execution of a function. Especially useful for rate limiting
+ * execution of handlers on events like resize and scroll.
+ *
+ * @param   fn             A function to be executed after delay milliseconds. The `this` context and all arguments are passed through, as-is,
+ *                                    to `callback` when the throttled-function is executed.
+ * @param   ms             A zero-or-greater delay in milliseconds. For event callbacks, values around 100 or 250 (or even higher) are most useful.
+ *                                    (default value: 200)
+ *
+ * @param [trailing] if true, call fn again after the time is up (default value: false)
+ *
+ * @param [leading] if true, call fn on the leading edge of the ms timeout (default value: true)
+ *
+ * @param [rejectOnCancel] if true, reject the last call if it's been cancel (default value: false)
+ *
+ * @return  A new, throttled, function.
+ *
+ * @__NO_SIDE_EFFECTS__
+ */
+export declare function useThrottleFn<T extends FunctionArgs>(
+  fn: T,
+  ms?: MaybeRefOrGetter<number>,
+  trailing?: boolean,
+  leading?: boolean,
+  rejectOnCancel?: boolean,
+): PromisifyFn<T>
+```