|
| 1 | +# IntegralUI Web for Angular 2 |
| 2 | + |
| 3 | +IntegralUI Web is a library built on top of Angular 2 framework. It consists of user interface components, directives and services that can help you create modern web applications. |
| 4 | + |
| 5 | +Here is a brief overview of what is included: |
| 6 | + |
| 7 | +## Components |
| 8 | + |
| 9 | +[Accordion](http://www.lidorsystems.com/support/articles/angular/accordion/accordion-component.aspx) - Displays a list of expandable groups in vertical layout |
| 10 | + |
| 11 | +[ComboBox](http://www.lidorsystems.com/support/articles/angular/combobox/combobox-component.aspx) - Advanced version of standard ComboBox element |
| 12 | + |
| 13 | +[GroupBox](http://www.lidorsystems.com/support/articles/angular/groupbox/groupbox-component.aspx) - An expandable container with header and content |
| 14 | + |
| 15 | +[ListBar](http://www.lidorsystems.com/support/articles/angular/listbar/listbar-component.aspx) - Displays a list of expandable groups with items |
| 16 | + |
| 17 | +[ListBox](http://www.lidorsystems.com/support/articles/angular/listbox/listbox-component.aspx) - Displays a collection of items with content in custom layouts |
| 18 | + |
| 19 | +[ListView](http://www.lidorsystems.com/support/articles/angular/listview/listview-component.aspx) - Displays a collection of items using several different views |
| 20 | + |
| 21 | +[Menu](http://www.lidorsystems.com/support/articles/angular/menu/menu-component.aspx) - Allows you to create static or dynamic menus |
| 22 | + |
| 23 | +[Paginator](http://www.lidorsystems.com/support/articles/angular/paginator/paginator-component.aspx) - Allows you to divide the content in multiple views in single page |
| 24 | + |
| 25 | +[SlideBar](http://www.lidorsystems.com/support/articles/angular/slidebar/slidebar-component.aspx) - Animates slides composed of custom content |
| 26 | + |
| 27 | +[TabStrip](http://www.lidorsystems.com/support/articles/angular/tabstrip/tabstrip-component.aspx) - Consists of multiple scrollable panels that share the same space |
| 28 | + |
| 29 | +[TreeList](http://www.lidorsystems.com/support/articles/angular/treelist/treelist-component.aspx) - Allows you to navigate through tree hierarchy showing only one list at a time |
| 30 | + |
| 31 | +[TreeView](http://www.lidorsystems.com/support/articles/angular/treeview/treeview-component.aspx) - Displays hierarchical data structures |
| 32 | + |
| 33 | + |
| 34 | +## Directives |
| 35 | + |
| 36 | +[ContextMenu](http://www.lidorsystems.com/support/articles/angular/contextmenu/contextmenu-component.aspx) - Represents a shortcut menu |
| 37 | + |
| 38 | +[Frame](http://www.lidorsystems.com/support/articles/angular/frame/frame-component.aspx) - Places a grip handle that allows you to resize a container during run-time |
| 39 | + |
| 40 | +[Range](http://www.lidorsystems.com/support/articles/angular/range/range-component.aspx) - Allows you to set limits in which an element can resize during run-time |
| 41 | + |
| 42 | +[Tooltip](http://www.lidorsystems.com/support/articles/angular/tooltip/tooltip-component.aspx) - Adds a tooltip to an element |
| 43 | + |
| 44 | +## Services |
| 45 | + |
| 46 | +<b>Common</b> - Includes a set of common functions usable in most applications |
| 47 | + |
| 48 | +<b>Data</b> - Includes a set of data related functions for different operations like: add/remove, search, etc. |
| 49 | + |
| 50 | +<b>DragDrop</b> - Provides a way to use drag drop operations between custom components or elements. |
| 51 | + |
| 52 | + |
| 53 | +All components are inheritable, you can further extend functionalities of specific component by simple create a subclass of component main class. To get access to a specific component, the best way is to import the IntegralUIModule in your application. |
| 54 | + |
| 55 | +## Dependencies |
| 56 | + |
| 57 | +IntegralUI Web requires only the following library: |
| 58 | + |
| 59 | +Angular - v2.0 and above |
| 60 | + |
| 61 | +## Installation |
| 62 | + |
| 63 | +Install the repository by running |
| 64 | + |
| 65 | +```bash |
| 66 | +npm install https://github.com/lidorsystems/integralui-web.git |
| 67 | +``` |
| 68 | + |
| 69 | +Open your application module and add a reference to IntegralUI module |
| 70 | + |
| 71 | +```bash |
| 72 | +import { IntegralUIModule } from 'integralui-web/integralui.module'; |
| 73 | + |
| 74 | +@NgModule({ |
| 75 | + imports: [ IntegralUIModule ], |
| 76 | + declarations: [ AppComponent ], |
| 77 | + bootstrap: [ AppComponent ] |
| 78 | +}) |
| 79 | +export class AppModule { } |
| 80 | +``` |
| 81 | +
|
| 82 | +If you are using SystemJS, make sure you have the following settings in systemjs.config.js file |
| 83 | +
|
| 84 | +```bash |
| 85 | + map: { |
| 86 | + 'integralui-web': 'npm:integralui-web' |
| 87 | + }, |
| 88 | + packages: { |
| 89 | + 'integralui-web': { |
| 90 | + defaultExtension: 'js' |
| 91 | + } |
| 92 | + } |
| 93 | +``` |
| 94 | +
|
| 95 | +<b>Note</b> In order to use a specific component or directive in your application, follow the guidelines from corresponding article. From above links, you can find a separate article available for each component or directive. |
| 96 | +
|
| 97 | +
|
| 98 | +## Release Notes |
| 99 | +
|
| 100 | +This is Trial version of the product, currently in BETA v0.5.0. All features are fully functional, except that each component displays a pop-up trial window. |
| 101 | +
|
| 102 | +## License Information |
| 103 | +
|
| 104 | +You may use this version for the limited purposes of demonstrations, trials or design-time evaluations. |
| 105 | +
|
| 106 | +This project has been released under the IntegralUI Web License, and may not be used except in compliance with the License. |
| 107 | +A copy of the License should have been installed in the product's root installation directory or it can be found here: [License Agreement](http://www.lidorsystems.com/products/web/iui-web-license-agreement.pdf). |
| 108 | +
|
| 109 | +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. |
0 commit comments