Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
AureliaUI
✓ import { AureliaUI } from 'aurelia-ui-framework';
✗ const AureliaUI = require('aurelia-ui-framework');
ESM-only; commonjs require will not work. Use ES modules.
configure
✓ import { configure } from 'aurelia-ui-framework';
Function to register plugin with Aurelia's configure() in main.ts.
default
✓ import AureliaUI from 'aurelia-ui-framework';
✗ import { default } from 'aurelia-ui-framework';
Default export is the plugin class; you can use named import 'AureliaUI' or default.
Shows how to register the aurelia-ui-framework plugin in an Aurelia application's main.ts, with optional configuration.
// main.ts
import { Aurelia } from 'aurelia-framework';
import { configure } from 'aurelia-ui-framework';
export function configure(aurelia: Aurelia): void {
aurelia.use
.standardConfiguration()
.developmentLogging();
// Register the UI framework plugin
aurelia.use.plugin('aurelia-ui-framework', (config) => {
// Optional: configure date format, locale, etc.
config.dateFormat = 'yyyy-MM-dd';
config.locale = 'en-US';
});
aurelia.start().then(() => aurelia.setRoot());
}
Errors
Common errors & fixes
Cannot find module 'aurelia-ui-framework'
Package not installed or incorrect import path.
fixRun 'npm install aurelia-ui-framework' and ensure import path is correct.
Module not found: Error: Can't resolve 'aurelia-binding'
Missing resolve alias for linked local dependency.
fixAdd resolve.alias for 'aurelia-binding' in webpack.config.js.
TypeError: aurelia.use.plugin is not a function
Trying to call plugin registration without proper Aurelia instance.
fixEnsure you are inside the Aurelia configure function and aurelia.use is available.
Upgrade
Version history
5.0.0-beta.4latest on npm
Audit
Dependencies
aurelia-frameworkrequiredCore dependency for Aurelia plugin integration
aurelia-bindingrequiredRequired for binding engine
aurelia-templatingrequiredRequired for template compilation
aurelia-palrequiredPlatform abstraction layer for Aurelia
date-fnsrequiredDate manipulation and formatting
numeralrequiredNumber formatting
kramedrequiredMarkdown parsing
libphonenumber-jsrequiredPhone number validation and formatting
resize-observer-polyfillrequiredResizeObserver polyfill for browser compatibility
@mdi/fontoptionalMaterial Design Icons for UI
zxcvbnoptionalPassword strength estimation