https://github.com/glyad/au2-igc-web-components-plugin
Helps you build Aurelia 2 applications using Infragistics IgniteUI for Web Components.
https://github.com/glyad/au2-igc-web-components-plugin
aurelia aurelia-plugin aurelia2 igc igc-webcomponents ignite-ui ignite-ui-web-components infragistics web-components webcomponents
Last synced: 3 months ago
JSON representation
Helps you build Aurelia 2 applications using Infragistics IgniteUI for Web Components.
- Host: GitHub
- URL: https://github.com/glyad/au2-igc-web-components-plugin
- Owner: glyad
- License: mit
- Created: 2025-06-29T19:20:37.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-22T20:58:27.000Z (about 1 year ago)
- Last Synced: 2025-09-13T08:17:40.555Z (10 months ago)
- Topics: aurelia, aurelia-plugin, aurelia2, igc, igc-webcomponents, ignite-ui, ignite-ui-web-components, infragistics, web-components, webcomponents
- Language: TypeScript
- Homepage:
- Size: 882 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Aurelia Ignite UI for Web Components™ Adapter
Helps you build Aurelia 2 applications using Ignite UI for Web Components™. With it you can:
- have two-way binding on Ignite UI web-components.
## Install
1. Install dependencies:
```bash
npm install @aurelia/validation @aurelia/validation-html igniteui-webcomponents
```
2. Install optional dependencies for Aurelia Dialog integration:
```bash
npm install @aurelia/dialog
```
3. Install the plugin:
```bash
npm install aurelia-igc-web-components-adapter
```
or, if you want to directly use plugin's git repo,
```bash
npm install git@github.com:glyad/aurelia-igc-web-components-adapter.git
```
## Learn, How to Use
> See `dev-app/` folder for a working example of the plugin usage.
## Consume the plugin
In your `main.ts` , import the plugin and register it with Aurelia:
```ts
import Aurelia, { AppTask } from 'aurelia';
import { ValidationHtmlConfiguration, ValidationTrigger } from '@aurelia/validation-html';
import { defineAllComponents } from 'igniteui-webcomponents';
import { IgcAdapter } from 'aurelia-igc-web-components-adapter';
import { MyApp } from './my-app';
Aurelia
// Load all exports from the plugin
.register(IgcAdapter.customize((options) => {}))
.register(AppTask.activated(() => {
defineAllComponents();
// or register specific components:
// defineComponents(IgcInputComponent, IgcButtonComponent, ...);
}))
.register(ValidationHtmlConfiguration.customize((options) => {
options.DefaultTrigger = ValidationTrigger.change;
}))
// Rest of registrations goes here
.app(MyApp)
.start();
```
In your Aurelia component, you can now use Ignite UI for Web Components™ components with two-way binding:
```html
```
Use standard `validate` binding behavior and igcValidation attribute to the component to enable validation messages defined in your Aurelia validation rules:
```html
The text should be between 2 and 4 characters or less
${error.result.message}
```
## Recipes
### Using Ignite UI for Web Components™ Dialog component without Aurelia Dialog service
```html
Are you sure you want to delete the Annual_Report_2016.pdf and Annual_Report_2017.pdf files?
Cancel
OK
```
### Using Ignite UI for Web Components™ Dialog component with Aurelia Dialog service
- TBD
## Acknowledgements, Licenses, and Copyright Notices
This project is intended to be used with Ignite UI for Web Components™. The plugin is not affiliated with Infragistics, Inc. or its products and services. This project is licensed under the MIT License. The Ignite UI for Web Components™ library is licensed under the separate [Infragistics license](https://www.infragistics.com/products/ignite-ui-web-components/web-components/components/general-licensing#license-agreements-in-ignite-ui-for-web-components).
Copyright © 2025 David Kossoglyad