View 1llest-waveform-vue on Snyk Open Source Advisor

Package Health Score

53 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.2.0	\|	12/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.0	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.0.11	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (46)

GitHub Stars: 31
Forks: 2
Contributors: 2

Direct Usage Popularity

The npm package 1llest-waveform-vue receives a total of 46 downloads a week. As such, we scored 1llest-waveform-vue popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package 1llest-waveform-vue, we found that it has been starred 31 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like 1llest-waveform-vue is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 0
Last Release: 11 months ago
Last Commit: 11 months ago

Further analysis of the maintenance status of 1llest-waveform-vue based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that 1llest-waveform-vue demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 1 Direct
Versions: 15
Install Size: 43.4 kB
Dist-tags: 1
# of Files: 16
Maintainers: 1
TS Typings: No

1llest-waveform-vue has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

`1llest-waveform-vue`

A lightweight and controllable audio visualization vue3 plugin

Description

English ｜简写中文

This component is written using the native Web Audio API, and does not use any dependencies other than vue3 in the production environment. Of course, this means: if your target browser does not support the features of the web audio api, then my Plugins will also not apply. You can go to Browser compatibility to see the AudioContext line to check whether it is compatible with the target browser

Example - Live Demo

Start

Install

npm install 1llest-waveform-vue

Usage

Global component

// main.ts
import { createApp } from "vue"
import App from "./App.vue"

import IllestWaveform from "1llest-waveform-vue"
import "1llest-waveform-vue/lib/style.css"

const app = createApp(App)

app.use(IllestWaveform)
app.mount("#app")

Local component

// example.vue
import { IllestWaveform } from "1llest-waveform-vue"
import "1llest-waveform-vue/lib/style.css"

Component

<template>
  
  <div>{{ currentTime }} - {{ durationTime }}</div>
</template>

Documentation

Component Props

prop	description	type	default
url	the url of the audio file	`String`	-
requestOptions	the object passed to the `fetch` request function	`RequestInit`	-
lineWidth	the width of each vertical line that makes up the waveform	`Number`	`0.5`
lineCap	the style at the end of each vertical line that makes up the waveform	`CanvasLineCap`	`round`
lineColor	the color of each vertical line that makes up the waveform	`String`	`#5e5e5e`
samplingRate	indicates your audio sampling rate. The larger the value, the more lines the waveform will present and the higher the accuracy. But this value is not recommended to be too large, because too large a value will slow down rendering efficiency, the recommended value is between `8000 - 44100`	`Number`	`22050`
cursorWidth	indicates your cursor width	`Number`	`2`
cursorColor	the color of your cursor	`String`	`#fff`
maskColor	the color of the waveform mask layer	`String`	`#fff`
lazy	whether to enable lazy loading mode, if you want to display multiple waveforms as a list, this property is very useful	`Boolean`	`true`
skeleton	whether to enable the skeleton during waveform loading	`Boolean`	`true`
skeletonColor	the color of the skeleton	`String`	`#232323`
interact	indicates whether you want the user to interact with the waveform	`Boolean`	`true`
fade	achieve fade-in and fade-out effects when playing and pausing audio, this can give the user a smoother listening experience	`Boolean`	`true`

Events

> When using the following events, you need to add the on- prefix in front, such as @on-init="initHandler"

event	description	params
init	the hook event before the waveform starts to initialize	`Boolean`
fetched	the hook event after accepting the audio file	`Boolean`
ready	the hook event triggered after the waveform completes all initialization and rendering to the page	`Boolean`
play	event fired when playback starts	`Boolean`
pause	event fired when playback is paused	`Boolean`
finish	the event triggered when the playback is completed (the playback completion refers to the completion of the entire audio)	`Boolean`
click	event triggered when waveform is clicked	`Ref`

Methods

> You can call these methods directly on the waveform component instance, such like waveform_ref.value.play()

method	description	return
play	trigger the playback method of the waveform so that it starts playing the current audio	-
pause	trigger the pause method of the waveform to make it pause playback	-
replay	this method can restart playing the current audio again	-
getCurrentTime	this method can get the current playing time. If you want to get the current playback time in real time, you can wrap it in the `watchEffect` hook	`string`
getDuration	this method can get the duration of the current audio, but this method must be placed after the `ready` hook event is triggered to get the correct duration	`string`

Contributing

Contributions to the project are welcome! If you find a bug or have an idea for a new feature, please submit an issue or pull request.

License

1llest-waveform-vue dependencies

vue

1llest-waveform-vue development dependencies

@babel/core @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser @vitejs/plugin-vue @vue/eslint-config-standard @vue/eslint-config-typescript eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-vue husky prettier typescript vite vue-tsc

FAQs

What is 1llest-waveform-vue?

A lightweight and controllable audio visualization vue3 plugin. Visit Snyk Advisor to see a full health score report for 1llest-waveform-vue, including popularity, security, maintenance & community analysis.

Is 1llest-waveform-vue popular?

The npm package 1llest-waveform-vue receives a total of 46 weekly downloads. As such, 1llest-waveform-vue popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is 1llest-waveform-vue well maintained?

We found indications that 1llest-waveform-vue is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is 1llest-waveform-vue safe to use?

The npm package 1llest-waveform-vue was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 5 November-2024, at 04:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (46)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

1llest-waveform-vue

Description

Start

Install

Usage

Component

Documentation

Component Props

Events

Methods

Contributing

License

1llest-waveform-vue dependencies

1llest-waveform-vue development dependencies

FAQs

What is 1llest-waveform-vue?

Is 1llest-waveform-vue popular?

Is 1llest-waveform-vue well maintained?

Is 1llest-waveform-vue safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`1llest-waveform-vue`