Skip to content

Commit 62145fc

Browse files
ota-meshiota-meshi
authored
update readme (#1)
* [update] README * [update] jsdoc top page
1 parent eff72ac commit 62145fc

File tree

5 files changed

+82
-6
lines changed

5 files changed

+82
-6
lines changed

‎README.md

+55-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,62 @@
11
# Cheetah Grid
22

3-
The fastest open-source web component of data table.
3+
[![npm](https://img.shields.io/npm/l/cheetah-grid.svg)](https://www.npmjs.com/package/cheetah-grid)
4+
[![npm](https://img.shields.io/npm/v/cheetah-grid.svg)](https://www.npmjs.com/package/cheetah-grid)
45

56
<img src="https://future-architect.github.io/cheetah-grid/logo.png" style="max-width: 600px;" alt="Cheetah Grid" />
67

8+
The fastest open-source web component of data table.
9+
10+
[![capture.png](https://github.com/future-architect/cheetah-grid/raw/dev/readme_update/images/capture.png)](https://future-architect.github.io/cheetah-grid/)
11+
712
[DEMO & Documents](https://future-architect.github.io/cheetah-grid/)
813

14+
## Downloading Cheetah Grid
15+
16+
### Using Cheetah Grid with a CDN
17+
18+
```html
19+
<script src="https://unpkg.com/[email protected]"></script>
20+
```
21+
22+
### Downloading Cheetah Grid using npm
23+
[![npm](https://img.shields.io/npm/v/cheetah-grid.svg)](https://www.npmjs.com/package/cheetah-grid)
24+
25+
```sh
26+
$ npm install cheetah-grid
27+
```
28+
29+
```js
30+
const cheetahGrid = require("cheetah-grid")
31+
```
32+
33+
### Downloading Cheetah Grid source code
34+
35+
[cheetahGrid.es5.min.js](https://unpkg.com/[email protected]/dist/cheetahGrid.es5.min.js)
36+
37+
SourceMap
38+
[cheetahGrid.es5.min.js.map](https://unpkg.com/[email protected]/dist/cheetahGrid.es5.min.js.map)
39+
40+
## Usage
41+
42+
```js
43+
grid = new cheetahGrid.ListGrid({
44+
// Parent element on which to place the grid
45+
parentElement: document.querySelector('#parent'),
46+
// Header definition
47+
header: [
48+
{field: 'check', caption: '', width: 50, columnType: 'check', action: 'check'},
49+
{field: 'personid', caption: 'ID', width: 100, columnType: 'center'},
50+
{field: 'fname', caption: 'First Name', width: 200},
51+
{field: 'lname', caption: 'Last Name', width: 200},
52+
{field: 'email', caption: 'Email', width: 250},
53+
],
54+
// Array data to be displayed on the grid
55+
records,
56+
// Column fixed position
57+
frozenColCount: 2,
58+
});
59+
```
60+
61+
Please refer to the [documents](https://future-architect.github.io/cheetah-grid/) for details
62+

‎docs/0.0.1/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ <h1 id="sample-demo-amp-documents">SAMPLE DEMO &amp; DOCUMENTS</h1>
7070
</ul>
7171
</li>
7272
<li><strong>FAQ</strong><ul>
73-
<li><a href="demos\faq\jump.html">Jump</a></li>
7473
<li><a href="demos\faq\filter.html">Filter</a></li>
74+
<li><a href="demos\faq\jump.html">Jump</a></li>
7575
<li><a href="demos\faq\auto_paging.html">Auto Paging</a></li>
7676
</ul>
7777
</li>

‎docs/0.0.1/jsdoc/index.html

+25-3
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,31 @@ <h3> </h3>
4343

4444

4545
<section>
46-
<article><h1>Cheetah Grid</h1><p>The fastest open-source web component of data table.</p>
46+
<article><h1>Cheetah Grid</h1><p><a href="https://www.npmjs.com/package/cheetah-grid"><img src="https://img.shields.io/npm/l/cheetah-grid.svg" alt="npm"></a>
47+
<a href="https://www.npmjs.com/package/cheetah-grid"><img src="https://img.shields.io/npm/v/cheetah-grid.svg" alt="npm"></a></p>
4748
<p><img src="https://future-architect.github.io/cheetah-grid/logo.png" style="max-width: 600px;" alt="Cheetah Grid" /></p>
48-
<p><a href="https://future-architect.github.io/cheetah-grid/">DEMO &amp; Documents</a></p></article>
49+
<p>The fastest open-source web component of data table.</p>
50+
<p><a href="https://future-architect.github.io/cheetah-grid/"><img src="https://github.com/future-architect/cheetah-grid/raw/dev/readme_update/images/capture.png" alt="capture.png"></a></p>
51+
<p><a href="https://future-architect.github.io/cheetah-grid/">DEMO &amp; Documents</a></p>
52+
<h2>Downloading Cheetah Grid</h2><h3>Using Cheetah Grid with a CDN</h3><pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://unpkg.com/[email protected]&quot;>&lt;/script></code></pre><h3>Downloading Cheetah Grid using npm</h3><p><a href="https://www.npmjs.com/package/cheetah-grid"><img src="https://img.shields.io/npm/v/cheetah-grid.svg" alt="npm"></a></p>
53+
<pre class="prettyprint source lang-sh"><code>$ npm install cheetah-grid</code></pre><pre class="prettyprint source lang-js"><code>const cheetahGrid = require(&quot;cheetah-grid&quot;)</code></pre><h3>Downloading Cheetah Grid source code</h3><p><a href="https://unpkg.com/[email protected]/dist/cheetahGrid.es5.min.js">cheetahGrid.es5.min.js</a> </p>
54+
<p>SourceMap<br><a href="https://unpkg.com/[email protected]/dist/cheetahGrid.es5.min.js.map">cheetahGrid.es5.min.js.map</a> </p>
55+
<h2>Usage</h2><pre class="prettyprint source lang-js"><code> grid = new cheetahGrid.ListGrid({
56+
// Parent element on which to place the grid
57+
parentElement: document.querySelector('#parent'),
58+
// Header definition
59+
header: [
60+
{field: 'check', caption: '', width: 50, columnType: 'check', action: 'check'},
61+
{field: 'personid', caption: 'ID', width: 100, columnType: 'center'},
62+
{field: 'fname', caption: 'First Name', width: 200},
63+
{field: 'lname', caption: 'Last Name', width: 200},
64+
{field: 'email', caption: 'Email', width: 250},
65+
],
66+
// Array data to be displayed on the grid
67+
records,
68+
// Column fixed position
69+
frozenColCount: 2,
70+
});</code></pre><p>Please refer to the <a href="https://future-architect.github.io/cheetah-grid/">documents</a> for details</p></article>
4971
</section>
5072

5173

@@ -62,7 +84,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="cheetahGr
6284
<br class="clear">
6385

6486
<footer>
65-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 02 2017 13:33:35 GMT+0900 (東京 (標準時))
87+
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 02 2017 16:33:12 GMT+0900 (東京 (標準時))
6688
</footer>
6789

6890
<script> prettyPrint(); </script>

‎docs/src/demos/faq/filter.html.hbs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
category: FAQ
33
title: Filter
44
layout: demo.html
5-
order: 115
5+
order: 110
66
---
77

88
{{#marked}}

‎images/capture.png

72.1 KB
Loading

0 commit comments

Comments
 (0)