aurelia-form editorconfig travis-ci Bower gulp npm

Fun with forms! Small form utilities to make stuff just a bit easier.

aurelia-form

Build Status Known Vulnerabilities Gitter

This library is a plugin for the Aurelia platform.

Makes working with forms just a tad more pleasant.

  • A standardized schema for describing forms
  • Elements for generating forms with two way databinding by default
  • Support for multiple css frameworks enabled by view manager
  • Ability to define your own custom elements and overwrite the default elements
  • Aliases for types so you can reuse elements for similar or different types
  • A descent amount of types so you can start generating forms out of the box

Documentation

You can find usage examples and the documentation at aurelia-form.

The changelog provides you with information about important changes.

Uses

Aurelia-form needs following plugins installed and configured:

Installation

Aureli-Cli

Run npm i aurelia-form --save from your project root.

Aurelia-form makes use of extend. So, add following to the build.bundles.dependencies section of aurelia-project/aurelia.json.

"dependencies": [
  // ...
  "extend",
  {
    "name": "aurelia-form",
    "path": "../node_modules/aurelia-form/dist/amd",
    "main": "aurelia-form",
    "resources": [
      "component/form-field.html",
      "component/form-fields.html",
      "component/schema-form.html",
      "component/framework/bootstrap/actions.html",
      "component/framework/bootstrap/association.html",
      "component/framework/bootstrap/checkbox.html",
      "component/framework/bootstrap/checkboxes.html",
      "component/framework/bootstrap/collection.html",
      "component/framework/bootstrap/conditional.html",
      "component/framework/bootstrap/fieldset.html",
      "component/framework/bootstrap/file.html",
      "component/framework/bootstrap/form-group.html",
      "component/framework/bootstrap/input.html",
      "component/framework/bootstrap/radios.html",
      "component/framework/bootstrap/select.html",
      "component/framework/bootstrap/submit.html",
      "component/framework/bootstrap/textarea.html"            
    ]
  },
  // ...
],

Jspm

Run jspm i aurelia-form from your project root.

Add following to the desired includes section of build/bundles.js, eg:

"aurelia": {
  "includes": [
    //...
    "aurelia-form",
    "[aurelia-form/**/*.js]",
    "aurelia-form/**/*.html!text",
    //...
  ]
}

If the installation results in having forks, try resolving them by running:

jspm inspect --forks
jspm resolve --only registry:[email protected]

Webpack

Run npm i aurelia-form --save from your project root.

And add aurelia-form in the coreBundles.aurelia section of your webpack.config.js.

Typescript

Npm-based installations pick up the typings automatically. For Jspm-based installations, run typings i github:spoonx/aurelia-form or add "aurelia-form": "github:spoonx/aurelia-form", to your typings.json and run typings i.

Contributing

Report bugs, request features, send pull requests for fixes and features and read the CONTRIBUTING.md

License

MIT

Related Repositories

aurelia-form

aurelia-form

Fun with forms! Small form utilities to make stuff just a bit easier. ...

aurelia-form-renderer-bootstrap

aurelia-form-renderer-bootstrap

Bootstrap form renderer for aurelia and aurelia form. ...

aurelia-form

aurelia-form

Fun with forms! Small form utilities to make stuff just a bit easier. ...

aurelia-form-validation

aurelia-form-validation

A plugin that enables validation for aurelia form. ...


Top Contributors

bas080 doktordirk RWOverdijk Scrunshes VMBindraban jeremyvergnas elenduuche Kobus-Smit larvanitis

Releases

-   v0.4.0 zip tar
-   0.3.0 zip tar
-   0.2.0 zip tar
-   0.1.12 zip tar
-   0.1.11 zip tar
-   0.1.10 zip tar
-   0.1.9 zip tar
-   0.1.8 zip tar
-   0.0.2 zip tar