integralui-web-listbar
v20.2.0
Published
IntegralUI Web Lite - ListBar is a native Web Component that displays a list of expandable groups with items.
Downloads
10
Maintainers
Readme
IntegralUI Web Lite - ListBar, v20.2
IntegralUI Web Lite - ListBar is a native Web Component that displays a list of expandable groups with items.
Note This component is part of IntegralUI Web Lite.
Here is a brief overview of what is included:
Components
GroupBox - An expandable container with header and content
ListBar - Displays a list of expandable groups with items
ListGroup - Represents a collapsible panel with list of items
Services
Common - Includes a set of common functions usable in most applications
Data - Includes a set of data related functions for different operations like: add/remove, search, etc.
DEMO
Online QuickStart App - An online demo of each component included
Installation
Install the repository by running
npm install https://github.com/lidorsystems/integralui-web-listbar.git
or directly from NPM
npm i integralui-web-listbar
Open your application and add a reference to a component you want to use. For example, if you are using the IntegralUI ListBar component:
Angular
import 'integralui-web-listbar/components/integralui.listbar.js';
React
import IntegralUIListBarComponent from 'integralui-web-listbar/wrappers/react.integralui.listbar.js';
Note Currently ReactJS doesn't have full support for Web Components. 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.
Vanilla JavaScript
<script type="module" src="integralui-web-listbar/components/integralui.listbar.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:
- Copy/Paste the content of the integralui-web-listbar/icons folder under /assets/integralui/icons subfolder in your React application.
- Set the resourcePath property of IntegralUI Web components to point to the location set in your /assets folder. In this case, for ListBar for example:
<iui-listbar [resourcePath]="'assets/integralui/icons'"></iui-listbar>
React
Follow these steps:
- Copy/Paste the content of the integralui-web-listbar/icons folder under /public/integralui/icons subfolder in your React application.
- Set the resourcePath property of IntegralUI Web components to point to the location set in your /public folder. In this case, for ListBar for example:
<IntegralUIListBarComponent resourcePath="integralui/icons"></IntegralUIListBarComponent>
Vanilla JavaScript
Set the resourcePath property of IntegralUI Web components to point to /integralui-web-listbar/icons folder. In this case, for ListBar for example:
<iui-listbar resource-path="../../integralui-web-listbar/icons"></iui-listbar>
QuickStart App
There is a demo application with source code that contains samples for ListBar component. It can help you to get started quickly with learning about the components and write tests immediatelly.
From IntegralUI Web Lite - QuickStart you can download a demo app for Angular, 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 are FREE to use this product to develop Internet and Intranet web sites, web applications and other products, with no-charge.
This project has been released under the IntegralUI Web Lite 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.
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.