https://github.com/duskmoon314/vue3-typed-js

https://github.com/duskmoon314/vue3-typed-js

Last synced: 12 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/duskmoon314/vue3-typed-js
• Owner: duskmoon314
• License: mit
• Created: 2021-07-04T03:21:52.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-23T06:24:34.000Z (16 days ago)
• Last Synced: 2024-10-24T17:23:29.722Z (15 days ago)
• Language: TypeScript
• Size: 343 KB
• Stars: 18
• Watchers: 2
• Forks: 2
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue3-typed-js

## About

This is a vue3 component of Typed.js, build with vite.

This repo is based on Orlandster's great work vue-typed-js. Because the name is similar, npm suggest me to name this module @duskmoon/vue3-typed-js.

I'm a newbie of vue and creating component library. Please point out my mistake and feel free to create PR.

## Usage

### Install

```

npm install @duskmoon/vue3-typed-js

```

### Demo

```ts

  

  

    


  


import { Typed } from "@duskmoon/vue3-typed-js";

import type { TypedOptions } from "@duskmoon/vue3-typed-js";

const options: TypedOptions = {

  strings: ["Hello", "World", "This is vue3-typed-js"],

  loop: true,

  typeSpeed: 30,

};

```

### Options

I export `TypedOptions` from Typed.js

Please check [Typed.js](http://mattboldt.github.io/typed.js/docs/)

## Contribute

### `dev`

`vite`

Start vite dev server

### `build`

`vite build`

Build into `dist/`

### `serve`

`vite preview`

### `lint`

`eslint --ext .js,.vue src`

Check if any code does not comply with the rules

### `lint:fix`

`eslint --ext .js,.vue src --fix`

Not only check, but also fix

### `format`

`prettier --write .`

Use prettier to format