Skip to content

Latest commit

 

History

History
74 lines (59 loc) · 8.03 KB

README.md

File metadata and controls

74 lines (59 loc) · 8.03 KB

Ignite UI JS Blocks - Infragistics Angular2 Components

Build Status Coverage Status NPM version

Note: as of January 3rd 2017 the license for this project has changed from MIT to Apache 2.0. For more information about these licenses please click here

Components and supporting directives built with TypeScript and Angular 2 including samples and tests. Source files under the src folder.

Current list of controls include:

Components Status Docs Directives Status Docs
avatar Available Readme button Available Readme
badge Available Readme filter Available Readme
carousel Available Readme ripple Available Readme
list Available Readme input Available Readme
navbar Available Readme label Available Readme
tabbar Available Readme layout Available Readme
dialog Available Readme
snackbar Available Readme
toast Available Readme
navigation drawer Available Readme
radio Available Readme
checkbox Available Readme
switch Available Readme
scroll Planned Readme
linear progress Available Readme
circular progress Available Readme
icon Available Readme
card Available Readme
grid Planned Readme

Setup

From the root folder run:

npm install

Demos can be run using either the lite server:

npm start

or by pointing a server of your choosing to the root directory of the repo (e.g. Virtual Directory in IIS pointing to this folder). Either way works by simply opening html files from the samples folder (samples/index.html) afterwards. The start script will also build and watch TypeScript files. For other options use the commands below.

Build

In case your editor cannot auto-compile the TypeScript files (VS, VS Code, others with plugins) there's a configured npm command in place to run the compiler:

npm run build
/// OR in watch mode
npm run watch

This will compile all TypeScript files per the tsconfig.json setup and optionally continue watching for file changes and recompile accordingly.

NPM Package

You can include Ignite UI JS Blocks in your project as a depencency using the NPM package.

npm install igniteui-js-blocks --save-dev

Contributing

Coding Guidelines

General Naming Guidelines

Demo App

[Warehouse Picklist App] (https://github.com/IgniteUI/warehouse-js-blocks)