Skip to content

Commit 1d48c1f

Browse files
committed
📝 cleanup docs
1 parent 95137e0 commit 1d48c1f

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Refer to [Grid.js documentation](https://gridjs.io/docs/config/) for specific co
7575

7676
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

78-
#### `this.$gridjs.uuid`
78+
#### \$gridjs.uuid
7979

8080
Returns a unique identifier that can be used to reference the current cell.
8181

@@ -85,7 +85,7 @@ Usage:
8585
const ref = this.$gridjs.uuid()
8686
```
8787

88-
#### `this.$gridjs.h`
88+
#### \$gridjs.h
8989

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

@@ -107,7 +107,7 @@ this.cols = [
107107
]
108108
```
109109

110-
#### `this.$gridjs.html`
110+
#### \$gridjs.html
111111

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

@@ -116,23 +116,25 @@ Example:
116116
```js
117117
this.cols = [
118118
{
119-
name: 'Model',
120-
formatter: (cell) => this.$gridjs.html(`<b>${cell}</b>`)
119+
name: 'Model',
120+
formatter: (cell) => this.$gridjs.html(`<b>${cell}</b>`)
121121
},
122122
{ ... },
123123
{ ... }
124124
]
125125
```
126126

127-
#### `this.$gridjs.render`
127+
#### \$gridjs.render
128128

129129
Renders a Vue component. Refer to [Vue documentation](https://vuejs.org/v2/guide/render-function.html#createElement-Arguments) for advanced options.
130130

131+
Usage:
132+
131133
```js
132134
this.$gridjs.render(ref, component, { props }, { options })
133135
```
134136

135-
Usage:
137+
Example:
136138

137139
```js
138140
import FormatterComponent from './FormatterComponent.vue'

0 commit comments

Comments
 (0)