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>
<script nomodule src="https://cdn.my.wisc.edu/@myuw-web-components/myuw-card@latest/myuw-card.min.js"></script>
<myuw-card-frame>
<myuw-card-header>
Course Search and Enroll
</myuw-card-header>
<myuw-card-content>
<myuw-icon-link href="https://www.google.com">
<img src="/path/to/icon.svg">
</myuw-icon-link>
</myuw-card-content>
<myuw-card-footer href="https://www.google.com">
Launch full app
</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!
Composable Card Layouts
MyUW Card layouts are composable, which enables a degree of flexibility with widget content. The example
above shows the basic usage, but it is possible to mix and match content blocks to create new widget
variations.
All content blocks must be placed inside a <myuw-card-content></myuw-card-content>
component.
Basic icon link
<myuw-card-content>
<myuw-icon-link href="https://wisc.edu">
<img src="/path/to/icon.svg">
</myuw-icon-link>
<myuw-card-content>
Icon link with message
<myuw-card-content>
<myuw-card-message>Your message here</myuw-card-message>
<myuw-icon-link href="https://wisc.edu">
<img src="/path/to/icon.svg">
</myuw-icon-link>
<myuw-card-content>
Contributing
See also: CONTRIBUTING
Developer Requirements
- Node.js
- Yarn (optional but recommended)
- npm (if not using Yarn)
Install dependencies:
$ yarn install
$ npm install
Run the development server:
$ yarn start
$ npm start
Build modules to dist/
:
$ yarn build
$ npm run build
ESLint and Prettier will be install
and are already configured. It is recommended that you use them.