Skip to content

Commit 0c0795b

Browse files
committed
update documentation
1 parent 32c36a5 commit 0c0795b

File tree

4 files changed

+18
-3
lines changed

4 files changed

+18
-3
lines changed

.release-it.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
"requireBranch": "master",
55
"requireCleanWorkingDir": false
66
},
7+
"github": {
8+
"release": true,
9+
"assets": ["dist/*.js"]
10+
},
711
"gitlab": {
812
"release": true,
913
"assets": ["dist/*.js"]

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
All notable changes to this project will be documented in this file. Dates are displayed in UTC.
44

5+
## [0.4.1] - 2020-07-14
6+
7+
- Update documentation
8+
59
## [0.4.0] - 2020-07-14
610

7-
- 🤷🏻
11+
- Fix global import
12+
- Add createRef, h, html methods
813

914
## [0.3.5] - 28 June 2020
1015

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,14 @@ Refer to [Grid.js documentation](https://gridjs.io/docs/config/) for specific co
7373

7474
### Grid.js Helper Functions
7575

76-
If you install the component as a plugin, rather than importing it directly into your component, the following helpers are added to the Vue prototype and are available globally.
76+
If you install the component globally, rather than importing it locally, the following helpers are added to the Vue prototype and are available globally.
7777

7878
#### `this.$gridjs.createRef`
7979

8080
Returns a [reference to the Grid.js instance](https://gridjs.io/docs/examples/stock-market).
8181

82+
Example:
83+
8284
```js
8385
const ref = this.$gridjs.createRef
8486
```
@@ -87,6 +89,8 @@ const ref = this.$gridjs.createRef
8789

8890
Renders a [Preact virtual DOM instance](https://gridjs.io/docs/examples/virtual-dom).
8991

92+
Example:
93+
9094
```js
9195
{
9296
name: 'Actions',
@@ -103,6 +107,8 @@ Renders a [Preact virtual DOM instance](https://gridjs.io/docs/examples/virtual-
103107

104108
Renders [HTML in a formatter function](https://gridjs.io/docs/examples/html-cells).
105109

110+
Example:
111+
106112
```js
107113
{
108114
name: 'Name',

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "gridjs-vue",
33
"description": "A Vue.js wrapper component for Grid.js",
4-
"version": "0.4.0",
4+
"version": "0.4.1",
55
"license": "MIT",
66
"private": false,
77
"authors": [

0 commit comments

Comments
 (0)