Skip to content
This repository has been archived by the owner on Aug 7, 2020. It is now read-only.
/ ovh-ui-angular Public archive

[DEPRECATED] — A set of maintainable components for the OVH ecosystem (Angular).

License

Notifications You must be signed in to change notification settings

ovh-ux/ovh-ui-angular

OVH UI Kit (AngularJS)

OVH component deprecated

A set of maintainable components for the OVH ecosystem (AngularJS).

NPM

Project status stable Maintenance Chat on gitter


🔖 ovh-ui-angular is now deprecated. Please take a look at our OVH UI Kit - Master UI Framework.

Installation

Prerequisites

This library has been tested with AngularJS 1.6+.

You will also need these dependencies in your project:

Follow the guide for ovh-ui-kit, because you need to integrate it by yourself.

Install with npm

npm install ovh-ui-angular

Install with yarn

yarn add ovh-ui-angular

Install with bower (deprecated)

bower install --save ovh-ui-angular

Usage

Integration

  1. In your index.html, you need to load oui-angular.min.js:
    ...
    <script src="ovh-ui-angular/dist/oui-angular.min.js" type="text/javascript"></script>
    ...
  1. You need to add oui in your angular module dependencies like that:
angular.module("myAwesomeApp", [
    ...
    "oui"
    ...
]);

Develop

Run in development mode

  1. Clone and install ovh-ui-angular
git clone https://github.com/ovh-ux/ovh-ui-angular.git
cd ovh-ui-angular
yarn install
yarn link
  1. Run ovh-ui-angular with ovh-ui-kit-documentation
git clone https://github.com/ovh-ux/ovh-ui-kit-documentation.git
cd ovh-ui-kit-documentation
yarn install
yarn link ovh-ui-angular
yarn start

Hot reload

Once you have yarn start-ed the project, you can edit anything with an automatic browser refresh as a result.

Contributing

You've developed a new cool feature? Fixed an annoying bug? We'd be happy to hear from you!

see CONTRIBUTING

And read this quick start.

Related links

Documentation

Documentation is available from the packages/ folder, every package is self-documented throught a README.md file. But you can also check bellow.

License

See https://github.com/ovh-ux/ovh-ui-angular/blob/master/LICENSE