Skip to content

Commit ceab816

Browse files
committed
first release
1 parent 59e5470 commit ceab816

23 files changed

+1978
-257
lines changed

.eslintrc.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"extends": [
3+
"prettier",
4+
"plugin:prettier/recommended",
5+
"plugin:vue/recommended",
6+
"plugin:vue/base"
7+
],
8+
9+
"plugins": ["prettier"],
10+
11+
"rules": {
12+
"prettier/prettier": [
13+
"error",
14+
{
15+
"endOfLine": "auto"
16+
}
17+
]
18+
},
19+
"parserOptions": {
20+
"parser": "babel-eslint",
21+
"ecmaFeatures": {
22+
"jsx": true,
23+
"modules": true
24+
}
25+
}
26+
}
27+

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
//npm.pkg.github.com/:_authToken=5d959888-9595-458b-bb05-1844cfa40707

.prettierrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"semi": false,
3+
"singleQuote": true,
4+
"endOfLine": "auto"
5+
}

.tsconfig.json

Whitespace-only changes.

README.md

Lines changed: 77 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,98 @@
1-
# vue-yakoue
1+
# Yakoue Email Editor
22

3-
## Project setup
3+
## Install
4+
5+
### CDN
6+
7+
```html
8+
<script src="https://unpkg.com/@yakoue/vue-email-builder"></script>
49
```
5-
yarn install
10+
11+
### NPM
12+
13+
```
14+
$ npm install @yakoue/vue-email-builder --save
15+
or
16+
$ yarn @yakoue/vue-email-builder
17+
18+
```
19+
20+
## component
21+
22+
```vue
23+
<template>
24+
<div id="example">
25+
<div class="container">
26+
<div id="bar">
27+
<h1>Vue Email Editor (Demo)</h1>
28+
29+
<button @click="saveDesign">Save Design</button>
30+
<button @click="exportHtml">Export HTML</button>
31+
</div>
32+
33+
<YakoueEditor ref="emailbuilder" :config="config" @init="editorLoaded" />
34+
</div>
35+
</div>
36+
</template>
37+
38+
<script>
39+
import { YakoueEditor } from '../components'
40+
import templateData from '../data/template1.js'
41+
export default {
42+
name: 'Example',
43+
components: {
44+
YakoueEditor,
45+
},
46+
data() {
47+
return {
48+
config: {},
49+
/* template: templateData, */
50+
}
51+
},
52+
mounted() {
53+
this.$nextTick(() => {})
54+
},
55+
methods: {
56+
editorLoaded() {
57+
// this.$refs.emailbuilder.instance.setTemplate(templateData)
58+
59+
this.$refs.emailbuilder.instance.addEvent('onExport', (data) => {
60+
console.log('exportHtml', data)
61+
})
62+
},
63+
saveDesign() {
64+
// console.log(' template ' + JSON.stringify(templateData, null, 2))
65+
this.$refs.emailbuilder.instance.addEvent('onSave', (design) => {
66+
console.log('saveDesign', JSON.stringify(design, null, 2))
67+
})
68+
this.$refs.emailbuilder.instance.save()
69+
},
70+
exportHtml() {
71+
this.$refs.emailbuilder.instance.export()
72+
},
73+
},
74+
}
75+
</script>
676
```
777

878
### Compiles and hot-reloads for development
79+
980
```
1081
yarn serve
1182
```
1283

1384
### Compiles and minifies for production
85+
1486
```
1587
yarn build
1688
```
1789

1890
### Lints and fixes files
91+
1992
```
2093
yarn lint
2194
```
2295

2396
### Customize configuration
97+
2498
See [Configuration Reference](https://cli.vuejs.org/config/).

babel.config.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
11
module.exports = {
2-
presets: [
3-
'@vue/cli-plugin-babel/preset'
4-
]
2+
presets: ['@vue/cli-plugin-babel/preset'],
53
}

eslintignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
{
3+
"ignorePatterns": ["**/yakoueintegrationscommon/*.js"],
4+
"rules": {
5+
}
6+
}

package.json

Lines changed: 47 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,44 @@
11
{
2-
"name": "vue-yakoue",
3-
"version": "0.1.0",
4-
"private": true,
2+
"name": "@yakoue/vue-email-builder",
3+
"version": "0.0.1",
4+
"private": false,
5+
"main": "./dist/vue-email-builder.umd.js",
56
"scripts": {
67
"serve": "vue-cli-service serve",
78
"build": "vue-cli-service build",
8-
"lint": "vue-cli-service lint"
9+
"lint": "vue-cli-service lint",
10+
"build-bundle": "vue-cli-service build --target lib --name vue-email-builder ./src/components/index.js",
11+
"release": "npm run build-bundle && npm publish --acces public"
912
},
10-
"dependencies": {
11-
"core-js": "^3.6.5",
12-
"vue": "^2.6.11"
13+
"peerDependencies": {
14+
"load-script": "^1.0.0",
15+
"vue": ">=2"
1316
},
17+
"files": [
18+
"dist/*",
19+
"src/*",
20+
"public/*",
21+
"*.json",
22+
"*.js"
23+
],
1424
"devDependencies": {
25+
"@rollup/plugin-commonjs": "11.1.0",
1526
"@vue/cli-plugin-babel": "~4.5.0",
1627
"@vue/cli-plugin-eslint": "~4.5.0",
1728
"@vue/cli-service": "~4.5.0",
1829
"babel-eslint": "^10.1.0",
19-
"eslint": "^6.7.2",
20-
"eslint-plugin-vue": "^6.2.2",
21-
"vue-template-compiler": "^2.6.11"
30+
"core-js": "3.6.5",
31+
"eslint": "^7.24.0",
32+
"eslint-config-prettier": "^8.2.0",
33+
"eslint-plugin-prettier": "^3.4.0",
34+
"eslint-plugin-vue": "^7.9.0",
35+
"prettier": "^2.2.1",
36+
"prettier-linter-helpers": "^1.0.0",
37+
"stylelint": "^13.12.0",
38+
"stylelint-config-prettier": "^8.0.2",
39+
"stylelint-config-standard": "^21.0.0",
40+
"vue-eslint-parser": "7.6.0",
41+
"vue-template-compiler": "2.6.12"
2242
},
2343
"eslintConfig": {
2444
"root": true,
@@ -34,9 +54,25 @@
3454
},
3555
"rules": {}
3656
},
57+
"license": "MIT",
3758
"browserslist": [
3859
"> 1%",
3960
"last 2 versions",
4061
"not dead"
41-
]
62+
],
63+
"dependencies": {
64+
"bootstrap": "^5.0.0",
65+
"bootstrap-vue": "^2.21.2",
66+
"load-script": "^1.0.0",
67+
"vue": "^2.6.12"
68+
},
69+
"description": "## Project setup ``` yarn install ```",
70+
"keywords": [
71+
"vue",
72+
"email",
73+
"mjml",
74+
"editor",
75+
"builder"
76+
],
77+
"author": "Yakoue"
4278
}

src/App.vue

Lines changed: 0 additions & 28 deletions
This file was deleted.

src/assets/favico.svg

Lines changed: 74 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)