Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

aurelia-framework

aurelia52kMIT1.4.1TypeScript support: included

The aurelia framework brings together all the required core aurelia libraries into a ready-to-go application-building platform.

aurelia, framework, spa

readme

Aurelia

License: MIT npm Version ci Discourse status Twitter Discord Chat

aurelia-framework

Aurelia is a modern, front-end JavaScript framework for building browser, mobile, and desktop applications. It focuses on aligning closely with web platform specifications, using convention over configuration, and having minimal framework intrusion. Basically, we want you to just write your code without the framework getting in your way. :wink:

This library is part of the Aurelia platform. It contains the aurelia-framework library, which brings together all the required core aurelia libraries into a ready-to-go application-building platform.

Aurelia applications are built by composing a series of simple components. By convention, components are made up of a vanilla JavaScript or Typescript class, with a corresponding HTML template.

//app.js
export class App {
  welcome = "Welcome to Aurelia";

  quests = [
    "To seek the holy grail",
    "To take the ring to Mordor",
    "To rescue princess Leia"
  ];
}
<!-- app.html -->
<template>
  <form>
    <label for="name-field">What is your name?</label>
    <input id="name-field" value.bind="name & debounce:500">

    <label for="quest-field">What is your quest?</label>
    <select id="quest-field" value.bind="quest">
      <option></option>
      <option repeat.for="q of quests">${q}</option>
    </select>
  </form>

  <p if.bind="name">${welcome}, ${name}!</p>
  <p if.bind="quest">Now set forth ${quest.toLowerCase()}!</p>
</template>

Check out the interactive version of this example on Code Sandbox.

This example shows you some of the powerful features of the aurelia binding syntax. To see further examples, online playgrounds, guides, and detailed API documentation, head on over to aurelia.io.

Feeling excited? To quickly get started building your project with aurelia, you can use the aurelia CLI.

Documentation

You can read the documentation for the aurelia framework here. It's divided into the following sections:

  • Overview : Discover what Aurelia is along with its business and technical advantages.
  • Tutorials : Step-by-step tutorials teaching you how to build your first Aurelia applications.
  • Fundamentals : After you've completed the quick starts, learn more about Aurelia's app model, components, dependency injection and more.
  • Binding: Learn all about Aurelia's powerful, reactive binding engine.
  • Templating: Learn all about Aurelia's powerful templating engine.
  • Routing: Learn how to setup and configure Aurelia's router.
  • Plugins: Learn about Aurelia's officially supported plugins and how to use them, including validation, i18n, http, dialog and state management.
  • Integration: Learn how to integrate Aurelia with various other libraries and frameworks.
  • Testing: Learn all about testing Aurelia apps, including component testing and e2e testing.
  • Server Side Rendering: Learn about Server Side Rendering with Aurelia and how to configure your project.
  • CLI: Learn how to create, build, bundle and test your apps using all your favorite tools, facilitated by the Aurelia CLI.
  • Build Systems: Learn how to use Webpack or JSPM directly for building apps without the Aurelia CLI.

You can improve the documentation by contributing to this repository.

Staying Up-to-Date

To keep up to date on Aurelia, please visit and subscribe to the official blog and our email list. We also invite you to follow us on twitter.

Questions

If you have questions, join us in our dedicated discourse forum or submit questions on stack overflow.

Contributing

We'd love for you to contribute and help make Aurelia even better than it is today! You can start by checking out our contributing guide, which has everything you need to get up and running.

License

Aurelia is MIT licensed. You can find out more and read the license document here.

changelog

1.4.1 (2022-03-31)

Bug Fixes

  • dep: use latest templating to resolve chain dep vul issue (#1001) (1930cf1)

1.4.0 (2022-03-31)

Bug Fixes

  • all: point package.json module from dist/es2015 back to dist/native-modules (0e59359)
  • dep: resolve vulnerable dep issue (#1000) (78102fd)

1.3.0-rc.2 (2018-06-21)

Bug Fixes

  • FrameworkConfiguration: use private info (5a51394)

1.3.0-rc.1 (2018-06-21)

Features

  • Aurelia: ability to define root with constructor (15fc9dd)
  • config: accepts classes beside module id string (80a3d39)

1.2.0 (2018-03-29)

Bug Fixes

  • doc: clarify when detached() is called (6eee2b9)
  • doc: updated contact detail screenshot to bootstrap 4 styles (5cdfe26)
  • doc: updated screenshots to bootstrap 4 styles (88f0210)
  • doc: updated the form layout in the contact manager tutorial (19a5dbe)
  • doc: upgrade contacts tutorial to bootstrap 4 (2bb2f55)

Features

  • log: support optional log level param to developmentLogging(). (7962912)

1.1.3 (2017-07-11)

  • Documentation updates.

1.1.2 (2017-04-05)

  • Documentation update.

1.1.0 (2017-02-27)

Bug Fixes

  • startup: start() incorrectly returns a resolved promise (4ef49e6)

Features

  • config: .feature() accepts explicit /index. (890f8d5)

1.0.2 (2016-08-26)

Bug Fixes

  • doc: fix typo (c0daf1b)
  • doc: fixed escaping variable (fc354e3)
  • doc: rename view file (1553006)
  • doc: s/sting/string in quick start (1f6deb9)

Features

  • doc: note about style vs css attribute (78f4cd9)

1.0.0 (2016-07-27)

Bug Fixes

  • aurelia: resolve promise in Aurelia.enhance (741fa22), closes #480

1.0.0-rc.1.0.3 (2016-07-21)

  • documentation update

1.0.0-rc.1.0.2 (2016-07-12)

Bug Fixes

  • framework-configuration: bug in path joining for resources (b462a79), closes #434

1.0.0-rc.1.0.1 (2016-06-30)

Features

  • aurelia: make default root load relative to config module if defined (8c2334e)
  • framework-configuration: add basicConfiguration helper (6329fc9)

1.0.0-rc.1.0.0 (2016-06-22)

1.0.0-beta.1.2.5 (2016-05-17)

  • Add d.ts update to include host property on the Aurelia object.

1.0.0-beta.1.2.4 (2016-05-12)

1.0.0-beta.1.2.3 (2016-05-10)

1.0.0-beta.1.2.2 (2016-04-13)

1.0.0-beta.1.2.1 (2016-03-29)

Bug Fixes

  • feature: use proper parameter to check extension (c179a3e9)
  • framework-configuration: getExt return invalid extension when relative path is supplied (335f8559)
  • global resource: load resources other than .ts or .js (b57f290a)

1.0.0-beta.1.2.0 (2016-03-22)

Bug Fixes

  • feature configuration (8d5eaa17)
  • feature: check extension. (4bfd6c47)
  • test: fix loadGlobalResource related tests (8fbd24d5)

Features

  • enhance: use document.body as fallback (e1cbfcc2)

1.0.0-beta.1.1.4 (2016-03-01)

Bug Fixes

Features

  • aurelia: integrate composition transaction (38851185)

1.0.0-beta.1.1.3 (2016-02-09)

1.0.0-beta.1.1.2 (2016-02-08)

1.0.0-beta.1.1.0 (2016-01-29)

Bug Fixes

Features

  • all: update jspm meta; core-js; aurelia deps (be9776e3)

1.0.0-beta.1.0.8 (2016-01-08)

Features

  • all: switch normalizeSync to normalize api (4d5b1f6b)
  • aurelia: detect router on successive setRoot calls (0f83b9b3)

1.0.0-beta.1.0.7 (2015-12-29)

  • docs update

1.0.0-beta.1.0.6 (2015-12-22)

  • docs update

1.0.0-beta.1.0.3 (2015-12-03)

  • docs update

1.0.0-beta.1 (2015-11-16)

0.18.0 (2015-11-10)

Bug Fixes

  • all: update to work with latest TemplatingEngine (edf2b5f8)

0.17.0 (2015-10-13)

Bug Fixes

  • all:
    • create a property framework configuration object (bab4c776)
    • update compiler and metadata plugin (50e3afe0)
    • load resources by module id only (655192b2)
  • aurelia:
    • switch window loader check to platform loader check (471d8c51)
    • enable multiple calls to setRoot (10708cae)
    • update to use ViewResources instead of ResourceRegistry (f458a193)
    • throw a descriptive error when globalizeResources is called with non-strings (09038c83)
    • update to use latest animator default config api (5dea25b5)
    • update to use new view engine (e6d20c42)
    • update to load global resources through new resource pipeline (bdbca554)
    • global resources left out (4bb098a3)
    • custom event undefined in local scope (c3594bf9)
    • ensure plugin resources are loaded first (bffcd614)
    • ensure all start code paths return a promise (02752512)
    • load groups of resources in order (2d936e5f)
    • directly use app container to create root view model (d86665b3)
    • remove dependency on event aggregator (424fa2bf)
    • plugin loading module id fix (ba79cb93)
  • build:
    • update linting, testing and tools (ed65edc6)
    • add missing bower bump (111797ae)
  • dts: update promise-based apis (94548514)
  • framework: Use correct import for core-js (da0756fd)
  • framework-configuration:
    • add public properties (a5b32853, closes #199)
    • parameter config in feature and plugin method is optional (b07c4817)
    • improve standardConfiguration (c91ea2b9)
    • correct type information (f1fc9987)
  • index: ensure export of path module api (17cf46cd)
  • package:
    • change jspm directories (37f2670b)
    • update dependencies (79feec43)
    • update deps and fix bower semver ranges (3f05b27e)
    • update dependencies (b52b1b05)
    • update Aurelia dependencies (f9df6e55)
    • update dependencies to latest (bfcd292e)
    • update templating to latest version (63d4c5f6)
    • update templating to latest version (5d1305e6)
    • update templating to latest version (1e981956)
    • update dependencies to latest versions (12f0f9a8)
    • update dependencies to latest versions (5ca82ad1)
    • update dependencies to their latest versions (fe83ef37)
  • plugin:
    • add feature api and prepare for jspm beta (5f0b7cf3)
    • make api use configure like other apis in framework (cbfdaad7, closes #96)
  • plugins:
    • preserve built-in plugin load order (25a35297)
    • address changes in jspm/system.js beta (90afee4d)
    • removed unnecessary es5 helper support (710499a8)
    • set es5 computed properties correctly (f1b140d9)
    • enable relative path plugins (7cbe4d22)
    • language helpers should return this for chaining (d8817425)
    • install sequentially (cc78f9a0)
    • ensure plugin installation can only happen once (9b37c848)

Features

  • all:
    • incorporate pal (4bc75161)
    • update to new loader apis to remove global System (07bd2982)
  • aurelia:
    • initialize new templatingEngine api (e60e5163)
    • initialize the binding system (d6f569f7)
    • add preliminary enhance api (f970c65c)
    • configure host as root dom boundary (5a99ab02)
    • update to use composition host instruction value (bd456bc5)
    • take advantage of previously configured host (0c5bbcd7)
    • add parameter default to setRoot (f3955d22)
    • ensure animator implementation (e3ab3ab0)
    • raise DOM events for start and compose (feed2a3a)
    • enable splash screen swaps on load (c2135d41)
    • set root sets element in container and uses composition engine (9f6fa60d)
  • build:
    • add command line argument for semver bump. resolve #28 (39652c80)
    • update compiler and switch to register module format (63c5d367)
  • docs:
    • generate api.json from .d.ts file (38c06e2c)
    • generate api.json from .d.ts file (1e2af71b)
    • generate api.json from .d.ts file (a6960cbc)
  • framework:
    • prevent forms without [action] from submiting (a5805257)
    • enable plugin loading and config (f3b02ea9)
  • index: export all from pal (10ca62bb)
  • plugins:
    • better api by moving some bootstrapper code directly into aurelia (f76baf08)
    • remove AtScript support (f1adb01a)
    • update to use new metadata locator function (4b09490d)
    • support legacy atscript annotation location (37463681)
    • update atscript helper to use new metadata api (c9b4fb99)
    • enable loading after bootstrapped (790c9da2)
    • new plugin api including explicit support for es5 and at script (b5c588bc)
    • track plugin id for relative resource loading without system hack (3465e849)

Breaking Changes

  • If you were using ES5 and used the computed helper on function, this will affect you as that is no longer present.

    (710499a8)

0.16.0 (2015-09-05)

Bug Fixes

  • build: update linting, testing and tools (ed65edc6)
  • framework-configuration:
    • add public properties (a5b32853, closes #199)
    • parameter config in feature and plugin method is optional (b07c4817)
    • improve standardConfiguration (c91ea2b9)

0.15.0 (2015-08-14)

Bug Fixes

  • all: create a property framework configuration object (bab4c776)
  • aurelia:
    • enable multiple calls to setRoot (10708cae)
    • update to use ViewResources instead of ResourceRegistry (f458a193)
  • framework: Use correct import for core-js (da0756fd)
  • framework-configuration: correct type information (f1fc9987)

Features

  • docs:
    • generate api.json from .d.ts file (38c06e2c)
    • generate api.json from .d.ts file (1e2af71b)
    • generate api.json from .d.ts file (a6960cbc)

0.14.1 (2015-08-08)

Bug Fixes

  • plugins: preserve built-in plugin load order (25a35297)

0.14.0 (2015-08-05)

Bug Fixes

  • plugin: add feature api and prepare for jspm beta (5f0b7cf3)

Features

  • aurelia: add preliminary enhance api (f970c65c)
  • plugins: better api by moving some bootstrapper code directly into aurelia (f76baf08)

0.13.4 (2015-07-29)

Features

  • aurelia: configure host as root dom boundary (5a99ab02)

0.13.3 (2015-07-13)

Bug Fixes

  • dts: update promise-based apis (94548514)

0.13.2 (2015-07-07)

0.13.1 (2015-07-03)

Bug Fixes

  • plugins: address changes in jspm/system.js beta (90afee4d)

0.13.0 (2015-07-02)

0.12.0 (2015-06-08)

Bug Fixes

  • index: ensure export of path module api (17cf46cd)

Features

  • aurelia: update to use composition host instruction value (bd456bc5)

0.11.0 (2015-05-01)

Bug Fixes

  • aurelia: throw a descriptive error when globalizeResources is called with non-strings (09038c83)
  • plugin: make api use configure like other apis in framework (cbfdaad7, closes #96)
  • plugins: removed unnecessary es5 helper support (710499a8)

Features

  • aurelia: take advantage of previously configured host (0c5bbcd7)

Breaking Changes

  • If you were using ES5 and used the computed helper on function, this will affect you as that is no longer present.

    (710499a8)

0.10.0 (2015-04-09)

Bug Fixes

  • all: update compiler and metadata plugin (50e3afe0)

Features

  • plugins:
    • remove AtScript support (f1adb01a)
    • update to use new metadata locator function (4b09490d)

0.9.0 (2015-03-25)

Bug Fixes

  • all: load resources by module id only (655192b2)
  • aurelia:
    • update to use latest animator default config api (5dea25b5)
    • update to use new view engine (e6d20c42)
    • update to load global resources through new resource pipeline (bdbca554)

Features

  • aurelia: add parameter default to setRoot (f3955d22)

0.8.8 (2015-02-28)

Bug Fixes

  • package: change jspm directories (37f2670b)

0.8.7 (2015-02-28)

Bug Fixes

  • aurelia: global resources left out (4bb098a3)
  • build: add missing bower bump (111797ae)
  • package: update dependencies (79feec43)

Features

  • aurelia: ensure animator implementation (e3ab3ab0)
  • build: add command line argument for semver bump. resolve #28 (39652c80)
  • framework: prevent forms without [action] from submiting (a5805257)

0.8.6 (2015-02-03)

Features

  • plugins: support legacy atscript annotation location (37463681)

0.8.5 (2015-01-29)

Bug Fixes

  • aurelia: custom event undefined in local scope (c3594bf9)
  • plugins: set es5 computed properties correctly (f1b140d9)

Features

  • aurelia: raise DOM events for start and compose (feed2a3a)

0.8.4 (2015-01-25)

Bug Fixes

  • aurelia: ensure plugin resources are loaded first (bffcd614)

0.8.3 (2015-01-25)

Bug Fixes

  • plugins: enable relative path plugins (7cbe4d22)

0.8.2 (2015-01-24)

Bug Fixes

  • package: update deps and fix bower semver ranges (3f05b27e)

0.8.1 (2015-01-22)

Bug Fixes

  • plugins: language helpers should return this for chaining (d8817425)

0.8.0 (2015-01-22)

Bug Fixes

  • aurelia: ensure all start code paths return a promise (02752512)
  • package: update dependencies (b52b1b05)

Features

  • aurelia: enable splash screen swaps on load (c2135d41)
  • plugins:
    • update atscript helper to use new metadata api (c9b4fb99)
    • enable loading after bootstrapped (790c9da2)
    • new plugin api including explicit support for es5 and at script (b5c588bc)
    • track plugin id for relative resource loading without system hack (3465e849)

0.7.0 (2015-01-12)

Bug Fixes

  • aurelia: load groups of resources in order (2d936e5f)
  • package: update Aurelia dependencies (f9df6e55)
  • plugins: install sequentially (cc78f9a0)

0.6.0 (2015-01-07)

Bug Fixes

  • aurelia: directly use app container to create root view model (d86665b3)
  • package: update dependencies to latest (bfcd292e)

Features

  • aurelia: set root sets element in container and uses composition engine (9f6fa60d)

0.5.0 (2015-01-06)

Bug Fixes

  • aurelia:
    • remove dependency on event aggregator (424fa2bf)
    • plugin loading module id fix (ba79cb93)
  • plugins: ensure plugin installation can only happen once (9b37c848)

Features

  • build: update compiler and switch to register module format (63c5d367)

0.4.0 (2014-12-22)

Bug Fixes

  • package: update templating to latest version (63d4c5f6)

Features

  • framework: enable plugin loading and config (f3b02ea9)

0.3.2 (2014-12-18)

Bug Fixes

  • package: update templating to latest version (5d1305e6)

0.3.1 (2014-12-18)

Bug Fixes

  • package: update templating to latest version (1e981956)

0.3.0 (2014-12-17)

Bug Fixes

  • package: update dependencies to latest versions (12f0f9a8)

0.2.1 (2014-12-12)

Bug Fixes

  • package: update dependencies to latest versions (5ca82ad1)

0.2.0 (2014-12-11)

Bug Fixes

  • package: update dependencies to their latest versions (fe83ef37)