Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ota-meshi committed Sep 6, 2024
1 parent cb22b96 commit 810bb2c
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions packages/vue-cheetah-grid/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
[![npm](https://img.shields.io/npm/dy/vue-cheetah-grid.svg)](http://www.npmtrends.com/vue-cheetah-grid)
[![npm](https://img.shields.io/npm/dt/vue-cheetah-grid.svg)](http://www.npmtrends.com/vue-cheetah-grid)
[![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)
[![NPM](https://nodei.co/npm/vue-cheetah-grid.png?downloads=true&stars=true)](https://www.npmjs.com/package/vue-cheetah-grid)

It supports Vue 2 and Vue 3.

## Install using npm

Expand Down Expand Up @@ -41,15 +42,29 @@ npm install -S vue-cheetah-grid
</template>
```

### `<script>` use global
### Use Components Globally

Vue3:

```js
import { createApp } from "vue";
import CGrid from "vue-cheetah-grid";

const app = createApp(App);

app.use(CGrid);
```

Vue2:

```js
import Vue from "vue";
import CGrid from "vue-cheetah-grid";

Vue.use(CGrid);
```

### `<script>` use local
### Use Components Locally

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

There are other components available as well.

Please refer also to the [Available Vue Components](https://future-architect.github.io/cheetah-grid/documents/api/vue/components/)

---
Expand Down

0 comments on commit 810bb2c

Please sign in to comment.