my-institution-component

1.0.6 • Public • Published

The Primo Studio feature build guide

Package documentation

  • When you want to write a feature for Primo-Studio you will be using Angular Directives.

  • To learn more about directives see:

https://docs.angularjs.org/guide/directive

  • Primo uses external directives from the Angular-material framework:

https://material.angularjs.org/latest/

  • The Primo Studio feature should be uploaded to npm. If you don't familiar with npm - please read at least one of the following tutorials:

https://www.tutorialspoint.com/nodejs/nodejs_npm.htm

https://eladnava.com/publishing-your-first-package-to-npm

  • Primo-Studio expect your package to be called the same as your component, and both suppose to include your-institution-code-then-your-component-name, e.g some-college-no-results-animated.

  • You can see in the example how we use :

  1. An HTML5 tag - header
  2. A Primo directive : prm-topbar , prm-search-bar.
  3. An external material design directive : md-progress-bar :

https://material.angularjs.org/latest/api/directive/mdProgressLinear

Concept:

  • When you want to add your own JavaScript functionality - you will need to create your own placeholder Directive that any one that installed your package can used by adding it to their project at the right place.

//////////////////TODO from here!!!!!!!!!

Point your package.json "main" field to your main module, which will export the component as an angular module.

In index.js

module.exports = 'myInstitutionComponent';

Then build your component as

Package Sidebar

Install

npm i my-institution-component

Weekly Downloads

0

Version

1.0.6

License

ISC

Unpacked Size

3.67 kB

Total Files

7

Last publish

Collaborators

  • gilax