Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.28 KB

wired-link.md

File metadata and controls

46 lines (31 loc) · 1.28 KB

wired-link

Hand-drawn sketchy Anchor/Link web component.

For demo and view the complete set of wired-elememts: wiredjs.com

Usage

Add wired-elements to your JavaScript project:

npm i wired-elements

Import module in your code:

import { WiredLink } from 'wired-elements';
// or
import { WiredLink } from 'wired-elements/lib/wired-link.js';

Or load directly into your HTML page:

<script type="module" src="https://unpkg.com/wired-elements/lib/wired-link.js?module"></script>

Use it in your HTML:

<wired-link href="/more.html">Learn more</wired-link>
<wired-link elevation="3" href="/more.html" target="_blank">Elevation</wired-link>

Properties

elevation - Number between 1 and 5 (inclusive) that gives the sketchy link underline a height. Default value is 1.

href - URL of the page to link to

target - Similar to the target property of <a>, the target window of this link.

Custom CSS Properties

--wired-link-decoration-color - Color of the sketchy underline of the link. Default value is blue. Foreground color is set by setting the color css property.

License

MIT License (c) Preet Shihn