0.0.0 • Published 6 years ago

udb3-angular v0.0.0

Weekly downloads
5
License
-
Repository
-
Last release
6 years ago

Build Status Coverage Status

This project holds all the necessary angular recipes, styles and templates to create an UDB3 front-end.

Usage

You can use bower to manage any dependencies on this project. Navigate to your bower project and the following command: bower install --save cultuurnet/udb3-angular

If you are using wiredep to include all of your bower modules, udb3-angular.js and udb3-angular.css will be automatically included. You can find them in the dist folder together with a minified version if you want to include them manually.

The .css you get out of the box is based on Bootstrap and uses the default variables. You can make the styling blend in with your custom bootstrap theme by using the .less files in the 'src/styles' folder.

Configuration

Inject the udb.core module into your app module like this:

angular
  .module('myUdbApp', [
    'udb.core',
  ])
  .config(udbAppConfig)
  .run(function (udbApi) {
    udbApi.getMe();
  });

And use the following config to get you up and running.

function udbAppConfig($translateProvider, queryFieldTranslations, dutchTranslations, uiSelectConfig) {
  // Translation configuration
  var defaultTranslations = _.merge(dutchTranslations, queryFieldTranslations.nl);

  $translateProvider
    .translations('nl', defaultTranslations)
    .preferredLanguage('nl');
  // end of translation configuration

  uiSelectConfig.theme = 'bootstrap';
}

Directives

Directives are always prefixed with udb- and usable as elements, e.g.: <udb-directive-name></udb-directive-name>.

Search bar

Search

Development

This AngularJS Style Guide was used for the project.

Prepare your environment

  • Install Node.js and NPM (should come with)
  • Install global dev dependencies: npm install -g bower grunt-cli
  • Install local dev dependencies: npm install && bower install in repository directory

Test and build

grunt build and grunt test