21.1

Author: Lidor-Systems

.npmrc

@@ -0,0 +1 @@
+package-lock=false

CHANGE_LOG.md

@@ -0,0 +1,2 @@
+v21.1 
+- Initial Release

LICENSE.md

@@ -0,0 +1,6 @@
+You may use this version for the limited purposes of demonstrations, trials or design-time evaluations.
+
+This project has been released under the IntegralUI Web - TreeGrid License, and may not be used except in compliance with the License.
+A copy of the License should have been installed in the product's root installation directory or it can be found here: [License Agreement](https://lidorsystems.com/products/web/treegrid/license-agreement.aspx).
+
+This SOFTWARE is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.

README.md

@@ -1 +1,114 @@
-# integralui-web-treegrid
+# IntegralUI Web - TreeGrid, v21.1
+
+IntegralUI Web - TreeGrid is a native Web Component that displays hierarchical data structures in multiple columns. You can use it in Angular, React, Vue or any other JavaScript framework.
+
+<b>Note</b> This component is also part of [IntegralUI Web](https://github.com/lidorsystems/integralui-web.git) product suite.
+
+![IntegralUI Web - TreeGrid 21.1 - Native Web Component](https://www.lidorsystems.com/products/web/studio/features/treegrid/integralui-web-treegrid.png)
+
+## Main Features
+
+- High Performance, loading and scrolling of thousands of records 
+- Built-in Editors
+- Advanced filtering and Sorting
+- Pagination
+- Fully customizable with column and row templates 
+
+A complete feature list is available here: [IntegralUI Web - TreeGrid features](https://lidorsystems.com/products/web/studio/features/treegrid/).
+
+
+## Dependencies
+
+IntegralUI Web - TreeGrid is built on top of [LitElement](https://github.com/Polymer/lit-element). All necessary files from that library are already included in the /external subfolder of this repository.
+
+
+## DEMO
+
+[Online QuickStart App](https://www.lidorsystems.com/products/web/studio/samples/) - An online demo of each component included
+
+
+## Installation
+
+Install the repository by running
+
+```bash
+npm install https://github.com/lidorsystems/integralui-web-treegrid.git
+```
+
+or directly from NPM
+
+```bash
+npm i integralui-web-treegrid
+```
+
+Open your application and add a reference to a component you want to use. For example, if you are using the IntegralUI TreeGrid component:</p>
+
+### Angular
+
+```bash
+import 'integralui-web-treegrid/components/integralui.treegrid.js';
+```
+
+### React
+
+```bash
+import IntegralUITreeGridComponent from 'integralui-web-treegrid/wrappers/react.integralui.treegrid.js';
+```
+
+<b>Note</b>   Currently [ReactJS doesn't have full support for Web Components](https://custom-elements-everywhere.com/#react). Mainly because of the way data is passed to the component via attributes and their own synthetic event system. For this reason, you can use available wrappers located under /wrappers directory, which are ReactJS components that provide all public API from an IntegralUI component.</p>
+
+### Vanilla JavaScript
+
+```bash
+<script type="module" src="integralui-web-treegrid/components/integralui.treegrid.js"></script>
+```
+
+
+## Icons
+
+Because of the web component specification that defines URLs to be always relative to the main document, the path that leads to the icons used by the IntegralUI Web components needs to be set. In addition you may also need to copy/paste the /icons folder in your application folder. Depending on the framework of your choosing this may differ.
+
+### Angular
+
+Follow these steps:
+1. Copy/Paste the content of the integralui-web-treegrid/icons folder under /assets/integralui-web-treegrid/icons subfolder in your React application. 
+2. Set the resourcePath property of IntegralUI Web components to point to the location set in your /assets folder. In this case, for TreeGrid for example:
+
+```bash
+<iui-treegrid [resourcePath]="'assets/integralui-web-treegrid/icons'"></iui-treegrid>
+```
+
+### React
+
+Follow these steps:
+1. Copy/Paste the content of the integralui-web-treegrid/icons folder under /public/integralui-web-treegrid/icons subfolder in your React application. 
+2. Set the resourcePath property of IntegralUI Web components to point to the location set in your /public folder. In this case, for TreeGrid for example:
+
+```bash
+<IntegralUITreeGridComponent resourcePath="integralui-web-treegrid/icons"></IntegralUITreeGridComponent>
+```
+
+### Vanilla JavaScript
+
+Set the resourcePath property of IntegralUI Web components to point to /integralui-web-treegrid/icons folder. In this case, for TreeGrid for example:
+
+```bash
+<iui-treegrid resource-path="../../integralui-web-treegrid/icons"></iui-treegrid>
+```
+
+
+## QuickStart App
+
+There is a demo application with source code that contains samples for each component included in the IntegralUI Web library. It can help you to get started quickly with learning about the components and write tests immediatelly. 
+
+From [IntegralUI Web - QuickStart](https://github.com/lidorsystems/integralui-web-quickstart) you can download a demo app for Angular, AngularJS, React and Vanilla JavaScript. A detailed information about each of these quick-start demos is available in ReadMe file, located in the root folder of the demo app.
+
+
+## License Information
+
+You may use this version for the limited purposes of demonstrations, trials or design-time evaluations.
+
+This project has been released under the IntegralUI Web - TreeGrid License, and may not be used except in compliance with the License.
+A copy of the License should have been installed in the product's root installation directory or it can be found here: [License Agreement](https://lidorsystems.com/products/web/treegrid/license-agreement.aspx).
+
+This SOFTWARE is provided "AS IS", WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License.