Skip to content

Latest commit

 

History

History
144 lines (111 loc) · 11.1 KB

README.md

File metadata and controls

144 lines (111 loc) · 11.1 KB

🛠 Status: Pilot Phase

Lion Web Components are still in an early alpha stage; they should not be considered production ready yet.

The goal of our pilot phase is to gather feedback from a private group of users. Therefore, during this phase, we kindly ask you to:

  • not publicly promote or link us yet: (no tweets, blog posts or other forms of communication about Lion Web Components)
  • not publicly promote or link products derived from/based on Lion Web Components

As soon as Pilot Phase ends we will let you know (feel free to subscribe to this issue ing-bank#1)

Lion Web Components

Lion web components is a set of highly performant, accessible and flexible Web Components. They provide an unopinionated, white label layer that can be extended to your own layer of components.

Demos

We do have a live Storybook which shows all our components.

How to install

npm i @lion/<package-name>

Content

Package Version Description
-- Forms --
checkbox checkbox Checkbox form element
checkbox-group checkbox-group Group of checkboxes
field field Base Class for all inputs
form form Wrapper for multiple form elements
input input Input element for strings
input-amount input-amount Input element for amounts
input-date input-date Input element for dates
input-email input-email Input element for e-mails
input-iban input-iban Input element for IBANs
radio radio Radio from element
radio-group radio-group Group of radios
select select Simple native dropdown element
textarea textarea Multiline text input
validate validate Validation for form components
-- Icons --
icon icon Display our svg icons
-- Localize --
localize localize Localize and translate your application/components
-- Overlays --
overlays overlays Overlays System using lit-html for rendering
popup popup Popup element
tooltip tooltip Popup element
-- Steps --
steps steps Multi Step System
-- Individual Packages --
core core Core System (exports LitElement, lit-html)
ajax ajax Fetching data via ajax request
button button Button
calendar calendar Standalone calendar

How to use

Use a Web Component

<script type="module">
  import '@lion/input/lion-input.js';
</script>

<lion-input name="firstName"></lion-input>

Use a JavaScript system

<script type="module">
  import { ajax } from '@lion/ajax';

  ajax.get('data.json').then(response => {
    // most likely you will use response.data
  });
</script>

Extend a Web Component

import { LionInput } from '@lion/input';

class MyInput extends LionInput {}
customElements.define('my-input', MyInput);

Key Features

  • High Performance - Focused on great performance in all relevant browsers with a minimal number of dependencies
  • Accessibility - Aimed at compliance with the WCAG 2.0 AA standard to create components that are accessible for everybody
  • Flexibility - Provides solutions through Web Components and JavaScript classes which can be used, adopted and extended to fit all needs

Technologies

Lion Web Components aims to be future proof and use well-supported proven technology. The stack we have chosen should reflect this.

Rationale

We know from experience that making high quality, accessible UI components is hard and time consuming: it takes many iterations, a lot of development time and a lot of testing to get a generic component that works in every context, supports many edge cases and is accessible in all relevant screen readers.

Lion aims to do the heavy lifting for you. This means you only have to apply your own Design System: by delivering styles, configuring components and adding a minimal set of custom logic on top.

How to contribute

Lion Web Components are only as good as its contributions. Read our contribution guide and feel free to enhance/improve our product.

Contact

Feel free to create a github issue for any feedback or questions you might have. You can also find us on the Polymer slack in the #lion channel.

You can join the Polymer slack by visiting Polymer Slack Invite.

Support and issues

As stated above "support and issues time" is currently rather limited: feel free to open a discussion. However, we can not guarantee any response times.