Skip to main content
1.0.0 Dark Light System

Lynk: A library of web components for building web applications with the Uplynk user interface style guide

  • Works with any framework that support Native Web Components
  • Fully customizable & themeable
  • Includes a dark and light theme 🌛
  • Built with accessibility in mind ♿️
  • First-class Aurelia & React support
  • Built-in localization

Quick Start

pnpm install @uplynk/lynk-design

or add the following code to your page.

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@uplynk/lynk-design@1.0.0/cdn/themes/light.css" />
<script type="module" src="https://cdn.jsdelivr.net/npm/@uplynk/lynk-design@1.0.0/cdn/lynk-autoloader.js"></script>

Now you have access to all of Lynk’s components! Try adding a button:

Click me
<lynk-button>Click me</lynk-button>

This will activate Lynk’s experimental autoloader, which registers components on the fly as you use them. To learn more about it, or for other ways to install Lynk, refer to the installation instructions.

New to Web Components?

TL;DR – we finally have a way to create our own HTML elements and use them in any framework we want!

Thanks to the popularity of frameworks such as Angular, Vue, and React, component-driven development has become a part of our every day lives. Components help us encapsulate styles and behaviors into reusable building blocks. They make a lot of sense in terms of design, development, and testing.

Unfortunately, framework-specific components fail us in a number of ways:

  • You can only use them in the framework they’re designed for 🔒
  • Their lifespan is limited to that of the framework’s ⏳
  • New frameworks/versions can lead to breaking changes, requiring substantial effort to update components 😭

Web components solve these problems. They’re supported by all modern browsers, they’re framework-agnostic, and they’re part of the standard, so we know they’ll be supported for many years to come.

This is the technology that Lynk is built on.

Browser Support

Lynk is tested in the latest two versions of the following browsers.

Chrome Edge Firefox Opera Safari

Attribution

Special thanks to the following projects and individuals that help make Lynk possible.