myuw-card

Import and include the component as follows:

Usage no npm install needed!

<script type="module">
  import myuwCard from 'https://cdn.skypack.dev/myuw-card';
</script>

README

myuw-card

MyUW Card

Getting Started

Import and include the component as follows:

<script type="module" src="https://cdn.my.wisc.edu/@myuw-web-components/myuw-card@latest/myuw-card.min.mjs"></script>

<!-- fallback for browsers without ES2015 module support -->
<script nomodule src="https://cdn.my.wisc.edu/@myuw-web-components/myuw-card@latest/myuw-card.min.js"></script>

<myuw-card-frame size="full">
  <myuw-card-header
    slot="myuw-card-header"
    title="Course Search and Enroll"
  ></myuw-card-header>
  <myuw-icon-link
    icon="face"
    icon-type="md"
    href="https://www.google.com"
  ></myuw-icon-link>
  <myuw-card-footer
    slot="myuw-card-footer"
    text="Launch app"
    href="https://www.google.com"
  ></myuw-card-footer>
</myuw-card-frame>

Note: The evergreen "latest" version can be used for convenience, but in production settings it is recommended to use the latest release version specifically, and upgrade only after testing!

Contributing

See also: CONTRIBUTING

Developer Requirements

  • Node.js
  • Yarn (optional but recommended)
  • npm (if not using Yarn)

Install dependencies:

$ yarn install
# or
$ npm install

Run the development server:

$ yarn start
# or
$ npm start

Build modules to dist/:

$ yarn build
# or
$ npm run build

ESLint and Prettier will be install and are already configured. It is recommended that you use them.