readme

Author: xkam

README.md

@@ -1,2 +1,165 @@
-# html
-ActiveWidgets components (no framework)
+
+### 
+
+# ActiveWidgets/JS • Datagrid 
+
+[![npm version](https://img.shields.io/npm/v/@activewidgets/js)](https://www.npmjs.com/package/@activewidgets/js "View this project on npm")
+[![npm downloads](https://img.shields.io/npm/dm/@activewidgets/js)](https://www.npmjs.com/package/@activewidgets/js "npm package downloads/month")
+[![Github issues](https://img.shields.io/github/issues/activewidgets/js)](https://github.com/activewidgets/js/issues "See Github issues")
+[![Github repo](https://img.shields.io/github/stars/activewidgets/js?label=GitHub&style=social)](https://github.com/activewidgets/js "Open Github repo")
+
+ActiveWidgets is a multi-framework UI component library. This package provides **datagrid component** for **javascript** / **no-framework** environments.
+
+[Live demo](https://js.activewidgets.com) / [Developer guide](https://docs.activewidgets.com/guide/) / [API reference](https://docs.activewidgets.com/api/)
+
+[![Datagrid demo](https://cdn.activewidgets.com/assets/screens/demo.png)](https://js.activewidgets.com)
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [CDN links](#cdn-links)
+- [Data properties](#data-properties)
+- [User events](#user-events)
+
+
+## Installation
+
+Add [@activewidgets/js](https://docs.activewidgets.com/api/packages/js/) to your project dependencies -
+
+```sh
+> npm i --save @activewidgets/js
+```
+
+## Usage
+
+Import `mount` function into your app -
+
+```js
+import { mount } from "@activewidgets/js";
+```
+
+Now, assuming that you've added a placeholder `ax-datagrid` tag to the page
+
+```html
+<ax-datagrid>Loading...</ax-datagrid>
+```
+
+Mount an actual ActiveWidgets component at the placeholder position -
+
+```js
+const rows = [
+    { message: 'Hello, World!' }
+];
+
+mount('ax-datagrid', { rows });
+```
+
+[Live example](https://js.activewidgets.com/examples/local/hello-world/) | [Source on github](https://github.com/activewidgets/js/tree/master/examples/hello-world) | [Edit on Codesandbox](https://codesandbox.io/s/github/activewidgets/js/tree/master/examples/hello-world)
+
+## CDN links
+
+For quick prototyping the package is also available over ActiveWidgets CDN -
+
+```html
+<script src="https://cdn.activewidgets.com/js"></script>
+```
+
+In this case the `mount` function is available at `ActiveWidgets.JS` global namespace.
+
+```js
+var mount = ActiveWidgets.JS.mount;
+
+var rows = [
+    { framework: 'none', source: 'CDN', language: 'ES5'}
+];
+
+mount('ax-datagrid', { rows: rows });
+```
+
+[Live example](https://js.activewidgets.com/examples/local/cdn-es5/) | [Source on github](https://github.com/activewidgets/js/tree/master/examples/cdn-es5) | [Edit on Codesandbox](https://codesandbox.io/s/github/activewidgets/js/tree/master/examples/cdn-es5)
+
+## Mount function
+
+The first argument for the `mount` function should be the target element (or selector). 
+The second argument is a properties object. The target element tagName defines the component ID.
+
+```js
+mount('#grid1', { columns, rows });
+```
+
+The placeholder element tag must be `ax-datagrid`
+
+```html
+<ax-datagrid id="grid1"></ax-datagrid>
+```
+
+The mount function returns `update` and `destroy` methods.
+
+
+```js
+const { update } = mount('#my-grid', { columns, rows });
+
+//...
+
+update({ rows: newRows });
+
+```
+
+
+## Data properties
+
+You have to provide [columns](https://docs.activewidgets.com/api/datagrid/columns/) and [rows](https://docs.activewidgets.com/api/datagrid/rows/) properties to the datagrid to show some data. The properties of each `column` object define how the data will be rendered -
+
+- [field](https://docs.activewidgets.com/api/datagrid/columns/#field) - where the cell data comes from (string|function)
+- [header](https://docs.activewidgets.com/api/datagrid/columns/#header) - column header (string|object)
+- [width](https://docs.activewidgets.com/api/datagrid/columns/#width) - column width (number, in pixels)
+- [align](https://docs.activewidgets.com/api/datagrid/columns/#align) - cell text alignment (left|right|center)
+- [format](https://docs.activewidgets.com/api/datagrid/columns/#format) - number/date format (string|function)
+- [fixed](https://docs.activewidgets.com/api/datagrid/columns/#fixed) - fixed (true/false) for columns on the left or right side
+
+The `style` (string|object) or `className` properties allow to change the styling of the column and cell elements.
+
+```js
+const columns = [
+  { header: 'Code', field: 'customerID', width: 80, style: 'background:#def', fixed: true },
+  { header: 'Company Name', field: 'companyName', width: 160 },
+  { header: 'Contact', field: 'contactName', width: 120 },
+  { header: 'Title', field: 'contactTitle', width: 120 },
+  { header: 'Address', field: 'address', width: 120, align: 'right' }
+];
+
+const rows = northwind.customers;
+
+mount('ax-datagrid', { columns, rows });
+```
+
+[Live example](https://js.activewidgets.com/examples/local/columns/) | [Source on github](https://github.com/activewidgets/js/tree/master/examples/columns) | [Edit on Codesandbox](https://codesandbox.io/s/github/activewidgets/js/tree/master/examples/columns)
+
+
+## User events
+
+In addition to the standard DOM keyboard and mouse events the datagrid emits composite 
+[mouse](https://docs.activewidgets.com/api/datagrid/mouse-event/) event which makes it easier to find the elements affected by the user action -
+
+```js
+function onMouse({ row }){
+    alert(`row ${ row.key } clicked!`);
+}
+
+mount('ax-datagrid', { onMouse, columns, rows }); // put event handlers together with props
+```
+
+[Live example](https://js.activewidgets.com/examples/local/events/) | [Source on github](https://github.com/activewidgets/js/tree/master/examples/events) | [Edit on Codesandbox](https://codesandbox.io/s/github/activewidgets/js/tree/master/examples/events)
+
+
+## More info
+
+- [Live demo](https://react.activewidgets.com) 
+- [Developer guide](https://docs.activewidgets.com/guide/) 
+- [API reference](https://docs.activewidgets.com/api/)
+- [Licensing](https://activewidgets.com/licenses/)
+- [Support forum](https://activewidgets.com/messages/)
+
+
+---
+
+[![ActiveWidgets](https://activewidgets.com/include/logo/aw-logo-40.png)](https://activewidgets.com) 

package.json

@@ -66,10 +66,11 @@
     "url": "git+https://github.com/activewidgets/js.git"
   },
   "keywords": [
+    "activewidgets",
     "datagrid"
   ],
   "bugs": {
     "url": "https://github.com/activewidgets/js/issues"
   },
-  "homepage": "https://github.com/activewidgets/js#readme"
+  "homepage": "https://activewidgets.com"
 }