@oiij/use
Version:
Som Composable Functions for Vue 3
32 lines (31 loc) • 983 B
TypeScript
import * as _vueuse_core10 from "@vueuse/core";
import { ComputedRef, Ref } from "vue";
//#region src/composables/use-type-writer.d.ts
interface TypeWriterOptions {
step?: number;
interval?: number;
enabled?: boolean;
}
declare function useTypeWriter(value: Ref<string> | ComputedRef<string>, options?: TypeWriterOptions): {
typeIndex: Ref<number, number>;
paused: Ref<boolean, boolean>;
ended: Ref<boolean, boolean>;
isTyping: Ref<boolean, boolean>;
typedValue: ComputedRef<string>;
progress: ComputedRef<number>;
start: () => void;
pause: () => void;
resume: () => void;
restart: () => void;
stop: () => void;
destroy: () => void;
onStat: _vueuse_core10.EventHookOn<void>;
onStop: _vueuse_core10.EventHookOn<string>;
onUpdate: _vueuse_core10.EventHookOn<{
index: number;
value: string;
}>;
};
type UseTypeWriterReturns = ReturnType<typeof useTypeWriter>;
//#endregion
export { TypeWriterOptions, UseTypeWriterReturns, useTypeWriter };