Skip to content

NickColley/pwc-marquee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Progressive Web Component: Marquee

A re-implementation of the obsolete marquee.

This is a project done for fun and I would definitely not recommend using this in a real service, as the marquee element was made obsolete for a real reason :).

How to use

Use from CDN

<pwc-marquee>Scrolling text is fun</pwc-marquee>

<script type="module">
    import Marquee from "https://unpkg.com/pwc-marquee"

    window.customElements.define('pwc-marquee', Marquee)
</script>

Install from npm

npm install pwc-marquee
<pwc-marquee>Scrolling text is fun</pwc-marquee>

<script type="module">
    import Marquee from "pwc-marquee"

    window.customElements.define('pwc-marquee', Marquee)
</script>

Note: you can choose what the custom element is called by changing pwc-marquee to what you prefer.

Features

[TODO document what attributes you can use, see example/index.html for now]

Improvements over the original marquee element

  • Smooth rendering cross-browser

Think of a cool effect that could be added?

Feel free to raise an issue or contribute it.

Progressive Enhancement

As this is a progressive web component, for browsers that do not support custom elements, it will fallback to regular text.

To do / Known issues

  • implement marquee events
  • implement marquee methods
  • If a user changes the size of their screen, the component does not currently adjust correctly.
  • Consider using shadow DOM to make the HTML output cleaner