README.md

uPortal Web Components

A collection of reusable, standardized, and accessible web components for uPortal

Installation

There are couple options for installing components:

• a node package through npm or yarn
• a webjar through gradle or maven

# install with npm
npm install @uportal/{package name goes here}

# install with yarn
yarn add @uportal/{package name goes here}

install with maven

<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>uportal__{package name goes here}</artifactId>
    <version>{version number goes here}</version>
</dependency>

install with gradle

compile 'org.webjars.npm:uportal__{package name goes here}:{version number goes here}'

Usage

To install any component, add a tag with the component's name, and a script tag pointing to the JavaScript bundle for that component.

For example an example-component would be loaded by adding

<example-component></example-component>
<script src="node_modules/@uportal/example-component/dist/js/example-component.js"></script>

Components

• Content Carousel
• Open ID Connect

Contribute

uPortal Components are built by people just like you! Check out CONTRIBUTING.md for ways to get started.

Want to chat with the community and contributors? Join us in Slack and the Mailing List!

Additional Topics

• Local Project Setup
• Project Automation Tools
• Project Conventions and Practices