You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 24, 2019. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-10Lines changed: 4 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Explain the problem and include additional details to help maintainers reproduce
18
18
19
19
## Suggesting Enhancements
20
20
In case you want to suggest for TOAST UI Editor, please follow this guideline to help maintainers and the community understand your suggestion.
21
-
Before creating suggestions, please check [issue list](https://github.nhnent.com/fe/tui.editor/labels/feature%20request) if there's already a request.
21
+
Before creating suggestions, please check [issue list](https://github.com/nhnent/toast-ui.vue-grid/labels/feature%20request) if there's already a request.
22
22
23
23
Create an issue and provide the following information:
24
24
@@ -42,14 +42,13 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
42
42
### Development WorkFlow
43
43
- Set up your development environment
44
44
- Make change from a right branch
45
-
- Be sure the code passes `npm run lint`, `npm run test`
45
+
- Be sure the code passes `npm run lint`
46
46
- Make a pull request
47
47
48
48
### Development environment
49
49
- Prepare your machine node and it's packages installed.
50
50
- Checkout our repository
51
-
- Install dependencies by `npm install && bower install`
52
-
- Start webpack-dev-server by `npm run serve`
51
+
- Install dependencies by `npm install`
53
52
54
53
### Make changes
55
54
#### Checkout a branch
@@ -58,12 +57,7 @@ Unsure where to begin contributing to TOAST UI? You can start by looking through
58
57
-**gh-pages**: API docs, examples and demo
59
58
60
59
#### Check Code Style
61
-
Run `npm run eslint` and make sure all the tests pass.
62
-
63
-
#### Test
64
-
Run `npm run test` and verify all the tests pass.
65
-
If you are adding new commands or features, they must include tests.
66
-
If you are changing functionality, update the tests if you need to.
60
+
Run `npm run lint` and make sure all the tests pass.
[](https://github.com/nhnent)
10
+
[](https://github.com/nhnent)
11
11
12
12
## 🚩 Table of Contents
13
13
*[Collect statistics on the use of open source](#collect-statistics-on-the-use-of-open-source)
@@ -30,7 +30,16 @@
30
30
31
31
## Collect statistics on the use of open source
32
32
33
-
Vue Wrapper of TOAST UI Grid applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Grid is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, include tui-code-snippet.js and then immediately write the options as follows:
33
+
Vue Wrapper of TOAST UI Grid applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI Grid is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following `usageStatistics` option when declare Vue Wrapper compoent.
34
+
35
+
```js
36
+
var options = {
37
+
...
38
+
usageStatistics:false
39
+
}
40
+
```
41
+
42
+
Or, include include `tui-code-snippet.js` (**v1.4.0** or **later**) and then immediately write the options as follows:
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com).
49
-
50
-
You can use the CDN as below.
57
+
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com). When you load `toastui-vue-grid.js` using CDN, you should insert dependency modules `vue`, `tui-grid.js` and `tui-grid.css` in the html. Also you should insert `jquery`, `underscore`, `backbone`, `tui-code-snippet`, `tui-pagination`, `tui-date-picker` that dependency modules of `tui-grid`. For more information about dependency of `tui-grid`, see [Download Files of Toast UI Grid](https://github.com/nhnent/tui.grid/blob/master/docs/getting-started.md#downloading-files)
You can use Toast UI Grid for Vue as moudule format or namespace. Also you can use Single File Component (SFC of Vue). When using module format and SFC, you should load `tui-grid.css` in the script.
76
+
77
+
* Using Ecmascript module
61
78
62
79
```js
63
-
var Grid =toastui.Grid;
80
+
import'tui-grid/dist/tui-grid.css'
81
+
import { Grid } from'@toast-ui/vue-grid'
64
82
```
65
83
66
-
* Using module
84
+
* Using Commonjs module
67
85
68
86
```js
69
-
// es modules
70
-
import Grid from '@toast-ui/vue-grid'
71
-
// commonjs require
72
-
var Grid = require('@toast-ui/vue-grid');
87
+
require('tui-grid/dist/tui-grid.css');
88
+
var toastui = require('@toast-ui/vue-grid');
89
+
var Grid = toastui.Calendar;
73
90
```
74
91
75
-
* Using `<script>`
76
-
77
-
If you just add javascript file to your html, you use CDN or `vue-grid.js`downloaded. Insert`vue-grid.js`with`vue`in your html like this:
* Using only Vue wrapper component (Single File Component)
94
+
```js
95
+
import 'tui-grid/dist/tui-grid.css'
96
+
import Grid from '@toast-ui/vue-grid/src/Grid.vue'
97
+
```
85
98
86
-
`vue-grid.js` has all of the tui.grid. If you only need vue wrapper component, you can use `@toast-ui/vue-grid/src/Grid.vue` like this:
99
+
* Using namespace
87
100
88
101
```js
89
-
import Grid from '@toast-ui/vue-chart/src/Grid.vue'
102
+
var Grid = toastui.Grid;
90
103
```
91
104
92
105
### Implement
@@ -100,7 +113,8 @@ First insert `<grid>` in the template or html. `rowData` and `columnData` props
100
113
Load grid component and then add it to the `components`in your component or Vue instance.
101
114
102
115
```js
103
-
import Grid from '@toast-ui/vue-grid'
116
+
import 'tui-grid/dist/tui-grid.css'
117
+
import { Grid } from '@toast-ui/vue-grid'
104
118
105
119
export default {
106
120
components: {
@@ -159,7 +173,7 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props. Ex
159
173
|---|---|
160
174
| Strinf or Object|X|
161
175
162
-
This prop can change theme of the chart. We support `default`, `striped` and `clean`themes. Soin case you just set `String`of these themes.
176
+
This prop can change theme of the grid. We support `default`, `striped` and `clean`themes. Soin case you just set `String`of these themes.
163
177
164
178
If you want to use other theme, you set `Object` that is required `name` and `value`. For more information which properties of`value` are available, see `extOptions`of [applyTheme oftui.grid](https://nhnent.github.io/tui.grid/api/Grid.html#.applyTheme).
165
179
@@ -169,7 +183,7 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props. Ex
169
183
|---|---|
170
184
|String or Object|X|
171
185
172
-
This prop can change language of the chart. We support `en` and `ko`. Soin case you just set `String`of these languages.
186
+
This prop can change language of the grid. We support `en` and `ko`. Soin case you just set `String`of these languages.
173
187
174
188
If you want to use other languages, you set `Object` that is required `name` and `value`. For more infomation which properties of`value` are available, see `data`of [setLanguage oftui.grid](https://nhnent.github.io/tui.grid/api/Grid.html#.setLanguage).
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com).
30
-
31
-
You can use the CDN as below.
29
+
TOAST UI products are available over the CDN powered by [TOAST Cloud](https://www.toast.com). When you load `toastui-vue-grid.js` using CDN, you should insert dependency modules `vue`, `tui-grid.js` and `tui-grid.css` in the html. Also you should insert `jquery`, `underscore`, `backbone`, `tui-code-snippet`, `tui-pagination`, `tui-date-picker` that dependency modules of `tui-grid`. For more information about dependency of `tui-grid`, see [Download Files of Toast UI Grid](https://github.com/nhnent/tui.grid/blob/master/docs/getting-started.md#downloading-files)
You can use Toast UI Grid for Vue as moudule format or namespace. Also you can use Single File Component (SFC of Vue). When using module format and SFC, you should load `tui-grid.css` in the script.
49
+
50
+
* Using Ecmascript module
42
51
43
52
```js
44
-
var Grid =toastui.Grid;
53
+
import'tui-grid/dist/tui-grid.css'
54
+
import { Grid } from'@toast-ui/vue-grid'
45
55
```
46
56
47
-
* Using module
57
+
* Using Commonjs module
48
58
49
59
```js
50
-
// es modules
51
-
import Grid from '@toast-ui/vue-grid'
52
-
// commonjs require
53
-
var Grid = require('@toast-ui/vue-grid');
60
+
require('tui-grid/dist/tui-grid.css');
61
+
var toastui = require('@toast-ui/vue-grid');
62
+
var Grid = toastui.Calendar;
54
63
```
55
64
56
-
* Using `<script>`
57
-
58
-
If you just add javascript file to your html, you use CDN or `vue-grid.js`downloaded. Insert`vue-grid.js`with`vue`in your html like this:
@@ -251,7 +260,7 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props.
251
260
|---|---|
252
261
| Strinf or Object|X|
253
262
254
-
This prop can change theme of the chart. We support `default`, `striped` and `clean`themes. Soin case you just set `String`of these themes.
263
+
This prop can change theme of the grid. We support `default`, `striped` and `clean`themes. Soin case you just set `String`of these themes.
255
264
256
265
If you want to use other theme, you set `Object` that is required `name` and `value`. For more information which properties of`value` are available, see `extOptions`of [applyTheme oftui.grid](https://nhnent.github.io/tui.grid/api/Grid.html#.applyTheme).
257
266
@@ -262,7 +271,8 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props.
@@ -335,7 +346,7 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props.
335
346
|---|---|
336
347
|String or Object|X|
337
348
338
-
This prop can change language of the chart. We support `en` and `ko`. Soin case you just set `String`of these languages.
349
+
This prop can change language of the grid. We support `en` and `ko`. Soin case you just set `String`of these languages.
339
350
340
351
If you want to use other languages, you set `Object` that is required `name` and `value`. For more infomation which properties of`value` are available, see `data`of [setLanguage oftui.grid](https://nhnent.github.io/tui.grid/api/Grid.html#.setLanguage).
341
352
@@ -346,7 +357,8 @@ You can use `rowData`, `columnData`, `options`, `theme` and `language` props.
0 commit comments