@myuw-web-components/myuw-basic-card

A basic card for MyUW

Usage no npm install needed!

<script type="module">
  import myuwWebComponentsMyuwBasicCard from 'https://cdn.skypack.dev/@myuw-web-components/myuw-basic-card';
</script>

README

MyUW Basic Card

This is a basic card web component used with MyUW.

Screenshot showing an example of a basic card

Using

Add the following to your page's <head>:

<script src="https://unpkg.com/@myuw-web-components/myuw-basic-card@^1"></script>

Using the component

  <myuw-basic-card
    title="My Account"
    uid="unique-identifier"
    url="/star"
    md-icon="account_circle"
    button-text="Launch"
  >
  </myuw-compact-card>

Configurable properties

title: The title of the web component.

uid: The unique ID of the card.

md-icon: Material UI icon name.

fa-icon: Font Awesome icon name.

svg-icon: A relative SVG icon URL.

url: The URL to open when the card is clicked. If the URL starts with http or https the link will open in a new tab. If it is relative it will open in the same tab.

button-text: The text to show in the launch button.

Removing Card

When the remove card button is clicked a deleteCardNotify event is fired where event.detail as the UID of the card.

  const el = document.getElementById('my-card');
  el.addEventListener('deleteCardNotify', event => {
    console.log(event.detail);
  });

Local Development

Install dependencies with npm install

Run local server with npm run serve:element

Building

Build the element into a single JavaScript file with npm run build-element. A single file will be generated in element/element.js. This build path can be changed in build-elements.js