https://github.com/uPortal-contrib/CardWebComponents

Card Web Components for the uPortal ecosystem
https://github.com/uPortal-contrib/CardWebComponents

accessibility card hyperhtml internationalization uportal web-components

Last synced: 10 months ago
JSON representation

Card Web Components for the uPortal ecosystem

• Host: GitHub
• URL: https://github.com/uPortal-contrib/CardWebComponents
• Owner: uPortal-contrib
• License: apache-2.0
• Created: 2018-06-20T08:30:13.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2025-03-03T17:34:00.000Z (10 months ago)
• Last Synced: 2025-03-03T18:38:06.406Z (10 months ago)
• Topics: accessibility, card, hyperhtml, internationalization, uportal, web-components
• Language: HTML
• Homepage: https://uportal-contrib.github.io/CardWebComponents/
• Size: 55.7 MB
• Stars: 3
• Watchers: 4
• Forks: 2
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Card Web Components

[![GitHub CI](https://github.com/uPortal-contrib/CardWebComponents/workflows/CI/badge.svg)](https://github.com/uPortal-contrib/CardWebComponents/actions?workflow=CI)

Card component for the uPortal ecosystem.

This component aims to display an Internationalized and accessible Card in Apereo uPortal.

So far tested in FF, Chrome, Safari and Edge (Windows, Mac, Linux, IOS & Android)

## Dependancies

Low and very light (-3Kb) dependencies make the component fast and easy to maintain.

- hyperHTML @lastest

- webcomponents-lite 1.2.0

- @fortawesome/fontawesome-free 5.5.0 (svg only)

## License

Apache-2.0

## Supported Languages

- `en-US` (default). :eyes: See it in [English (United States)](https://uportal-contrib.github.io/CardWebComponents/index.html) :us:

- `fr-FR` . :eyes: See it in [French](https://uportal-contrib.github.io/CardWebComponents/index_fr-FR.html) :fr:

- `fr-CA` . :eyes: See it in [French (Canada)](https://uportal-contrib.github.io/CardWebComponents/index_fr-CA.html)

- `es-ES` . :eyes: See it in [Spanish](https://uportal-contrib.github.io/CardWebComponents/index_es.html) :es:

- `nl-NL` . :eyes: See it in [Dutch](https://uportal-contrib.github.io/CardWebComponents/index_nl.html)

- `it` . :eyes: See it in [Italian](https://uportal-contrib.github.io/CardWebComponents/index_it.html) :it:

- `ar` . :eyes: See it in [Standard Arabic](https://uportal-contrib.github.io/CardWebComponents/index_ar.html)

- `de` . :eyes: See it in [German](https://uportal-contrib.github.io/CardWebComponents/index_de.html) :de:

- `zn-CN` . :eyes: See it in [Simplified Chinese](https://uportal-contrib.github.io/CardWebComponents/index_zn-CN.html) :cn:

![Card webcomponent](doc/images/2018-12-08_15-15-58.gif "uPortal card in en-US, fr-FR, es-ES, it, nl-NL")

## See multiple components in Flexbox and Grid layouts

- `Flexbox layout` :eyes: See it in [flexbox layout](https://uportal-contrib.github.io/CardWebComponents/index_albatros.html)

- `Grid layout` . :eyes: See it in [a grid layout](https://uportal-contrib.github.io/CardWebComponents/index_grid-labs.html)

Many Thanks to Heydonworks and Jen Simmons fantastic works

in these page, axe-core latest Audit score are excellent and are conforme to WCAG 2.1 AAA

![Axe Audit flags no Accessibility Violations](doc/images/axe-core_2019-05-31.png "Congratulations! No Accessibility Violations")

## Features

- [x] WCAG 2.1 Level AA - Level AAA Work in progress to got beyond simple conformance, but effective Inclusivity,

- [x] extra Features in CSS Level 4 : :visible-focus (enable accessibility flags)

- [x] An user can differentiate french from France and French Canadian with Speech Assistive Technologies (falsy-friends, Cutural Differences)

  - [ ] add Support for `en-GB`

  - [ ] add Support for `fr-BE`

  - [ ] add Support for `fr-CH`

  - [ ] add Support for `nl-BE`

  - [ ] add Support for Gaelic (Scotland) `gd`

  - [ ] add Support for Welsh `cy`

## Audits

![Card webcomponent Audit](doc/images/metrics_2018-12-09.png "Audit in Chrome devtool: Performance:100/100 - Accessibility: 100/100 - Best Practices:100/100 - SEO: 100/100")

## Build

- use `npm install` to get dependencies.

- use `npm start` to view code in a local web server.

- use `npm test` to run lint checks

## Screenshots

![Card webcomponent in English](doc/images/CardWebComponents_2019-05-31.png "card in en-US")

updated: 2019/05/31

## How it works

- open `dist/index.html` and change `` to ``, the component will be in french.

- In uPortal, the component will change automatically according to the user's locales switcher.

## Running in uPortal

copy all the files from `dist/` folder in a `card/` directory, then copy this folder into

`uPortal-start/overlays/uPortal/src/main/webapp` (or other location served by Tomcat).

#### Sample HTML in uPortal 4.2 to 5.2

Define a SimpleCMS portlet with HTML content like the following:

```HTML

```

#### Sample HTML in uPortal 5.3

Define a SimpleCMS portlet with HTML content like the following:

```HTML

```