Skip to content

Commit 810bb2c

Browse files
committed
chore: update docs
1 parent cb22b96 commit 810bb2c

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

packages/vue-cheetah-grid/README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
[![npm](https://img.shields.io/npm/dy/vue-cheetah-grid.svg)](http://www.npmtrends.com/vue-cheetah-grid)
88
[![npm](https://img.shields.io/npm/dt/vue-cheetah-grid.svg)](http://www.npmtrends.com/vue-cheetah-grid)
99
[![Build Status](https://github.com/future-architect/cheetah-grid/workflows/CI/badge.svg?branch=master)](https://github.com/future-architect/cheetah-grid/actions?query=workflow%3ACI)
10-
[![NPM](https://nodei.co/npm/vue-cheetah-grid.png?downloads=true&stars=true)](https://www.npmjs.com/package/vue-cheetah-grid)
10+
11+
It supports Vue 2 and Vue 3.
1112

1213
## Install using npm
1314

@@ -41,15 +42,29 @@ npm install -S vue-cheetah-grid
4142
</template>
4243
```
4344

44-
### `<script>` use global
45+
### Use Components Globally
46+
47+
Vue3:
48+
49+
```js
50+
import { createApp } from "vue";
51+
import CGrid from "vue-cheetah-grid";
52+
53+
const app = createApp(App);
54+
55+
app.use(CGrid);
56+
```
57+
58+
Vue2:
4559

4660
```js
61+
import Vue from "vue";
4762
import CGrid from "vue-cheetah-grid";
4863

4964
Vue.use(CGrid);
5065
```
5166

52-
### `<script>` use local
67+
### Use Components Locally
5368

5469
```vue
5570
<script>
@@ -82,6 +97,8 @@ Please refer to the [documents](https://future-architect.github.io/cheetah-grid/
8297
| `<c-grid-icon-column>` | Icon column definition | component for icon column definition |
8398
| `<c-grid-percent-complete-bar-column>` | Percent complete bar column definition | component for Percent complete bar column definition |
8499

100+
There are other components available as well.
101+
85102
Please refer also to the [Available Vue Components](https://future-architect.github.io/cheetah-grid/documents/api/vue/components/)
86103

87104
---

0 commit comments

Comments
 (0)