Skip to content

Commit

Permalink
feat: preparing v3
Browse files Browse the repository at this point in the history
  • Loading branch information
matteobruni committed Dec 21, 2023
1 parent 67a546f commit 7d7b0b9
Show file tree
Hide file tree
Showing 30 changed files with 380 additions and 1,508 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[![banner](https://particles.js.org/images/banner3.png)](https://particles.js.org)

# vue2-particles
# @tsparticles/vue2

[![npm](https://img.shields.io/npm/v/vue2-particles)](https://www.npmjs.com/package/vue2-particles) [![npm](https://img.shields.io/npm/dm/vue2-particles)](https://www.npmjs.com/package/vue2-particles) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)
[![npm](https://img.shields.io/npm/v/@tsparticles/vue)](https://www.npmjs.com/package/@tsparticles/vue) [![npm](https://img.shields.io/npm/dm/vue2-particles)](https://www.npmjs.com/package/vue2-particles) [![GitHub Sponsors](https://img.shields.io/github/sponsors/matteobruni)](https://github.com/sponsors/matteobruni)

Official [tsParticles](https://github.com/matteobruni/tsparticles) VueJS component

Expand All @@ -13,13 +13,13 @@ Official [tsParticles](https://github.com/matteobruni/tsparticles) VueJS compone
## Installation

```shell script
yarn add vue2-particles
yarn add @tsparticles/vue2
```

## Usage

```javascript
import Particles from "vue2-particles";
import Particles from "@tsparticles/vue2";

Vue.use(Particles);
```
Expand Down Expand Up @@ -122,7 +122,7 @@ Vue.use(Particles);

```javascript
//import { loadFull } from "tsparticles"; // if you are going to use `loadFull`, install the "tsparticles" package too.
import { loadSlim } from "tsparticles-slim"; // if you are going to use `loadSlim`, install the "tsparticles-slim" package too.
import { loadSlim } from "@tsparticles/slim"; // if you are going to use `loadSlim`, install the "@tsparticles/slim" package too.

const particlesInit = async engine => {
//await loadFull(engine);
Expand All @@ -140,7 +140,7 @@ If TypeScript returns error while importing/using Particles plugin try adding th
code:

```typescript
declare module "vue2-particles";
declare module "@tsparticles/vue2";
```

## Demos
Expand Down
2 changes: 1 addition & 1 deletion apps/nuxt2/components/Tutorial.vue
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
>. Have fun!
</p>
</div>
<Particles
<vue-particles
id="tsparticles"
:options="options"
:particles-init="particlesInit"
Expand Down
2 changes: 1 addition & 1 deletion apps/nuxt2/nuxt.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ export default {

// Build Configuration: https://go.nuxtjs.dev/config-build
build: {
transpile: ['tsparticles', 'tsparticles-engine'],
transpile: ['tsparticles', '@tsparticles/engine'],
},
}
6 changes: 3 additions & 3 deletions apps/nuxt2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
"dependencies": {
"core-js": "^3.32.2",
"nuxt": "^2.17.1",
"tsparticles": "^2.12.0",
"tsparticles-engine": "^2.12.0",
"tsparticles": "^3.0.2",
"@tsparticles/engine": "^3.0.2",
"vue": "^2.7.14",
"vue-server-renderer": "^2.7.14",
"vue-template-compiler": "^2.7.14",
"vue2-particles": "^2.12.0"
"@tsparticles/vue2": "^2.12.0"
},
"devDependencies": {
"@babel/core": "^7.22.19",
Expand Down
2 changes: 1 addition & 1 deletion apps/nuxt2/plugins/shim-vue.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ declare module '*.vue' {
export default Vue
}

declare module 'vue2-particles'
declare module '@tsparticles/vue2'
2 changes: 1 addition & 1 deletion apps/nuxt2/plugins/vue2-particles.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import Vue from 'vue'
import Particles from 'vue2-particles'
import Particles from '@tsparticles/vue2'

Vue.use(Particles)
10 changes: 5 additions & 5 deletions apps/vue2/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "vue2-particles-demo",
"name": "@tsparticles/vue2-demo",
"private": true,
"version": "2.12.0",
"description": "VueJS Demo",
Expand All @@ -21,13 +21,13 @@
"url": "https://github.com/tsparticles/vue2/issues"
},
"dependencies": {
"tsparticles": "^2.12.0",
"tsparticles-demo-configs": "^2.12.0",
"tsparticles-engine": "^2.12.0",
"tsparticles": "^3.0.2",
"@tsparticles/configs": "^3.0.2",
"@tsparticles/engine": "^3.0.2",
"vue": "^2.7.14",
"vue-class-component": "^7.2.6",
"vue-property-decorator": "^9.1.2",
"vue2-particles": "^2.12.0"
"@tsparticles/vue2": "^2.12.0"
},
"devDependencies": {
"@babel/core": "^7.22.19",
Expand Down
4 changes: 2 additions & 2 deletions apps/vue2/src/App.vue
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

<script lang="ts">
import { Vue } from "vue-property-decorator";
import type { Engine } from "tsparticles-engine";
import { type Engine } from "@tsparticles/engine";
import { loadFull } from "tsparticles";
import configs from "tsparticles-demo-configs";
import configs from "@tsparticles/configs";
export default class App extends Vue {
options = configs.basic;
Expand Down
2 changes: 1 addition & 1 deletion apps/vue2/src/main.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Vue from 'vue'
import App from './App.vue'
import Particles from "vue2-particles";
import Particles from "@tsparticles/vue2";

Vue.config.productionTip = false

Expand Down
2 changes: 1 addition & 1 deletion apps/vue2/src/shims-vue.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ declare module '*.vue' {
export default Vue
}

declare module "vue2-particles";
declare module "@tsparticles/vue2";
16 changes: 0 additions & 16 deletions components/vue2-alt/.babelrc

This file was deleted.

2 changes: 0 additions & 2 deletions components/vue2-alt/.browserslistrc

This file was deleted.

Loading

0 comments on commit 7d7b0b9

Please # to comment.