Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ing-bank/lion

Fundamental white label web component features for your design system.
https://github.com/ing-bank/lion

hacktoberfest javascript lion lit-html modern-web open-wc web-components

Last synced: 10 days ago
JSON representation

Fundamental white label web component features for your design system.

Host: GitHub
URL: https://github.com/ing-bank/lion
Owner: ing-bank
License: mit
Created: 2019-04-11T18:19:58.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-05-17T19:47:52.000Z (6 months ago)
Last Synced: 2024-05-17T20:18:27.424Z (6 months ago)
Topics: hacktoberfest, javascript, lion, lit-html, modern-web, open-wc, web-components
Language: JavaScript
Homepage: https://lion-web.netlify.app/
Size: 61.7 MB
Stars: 1,695
Watchers: 31
Forks: 283
Open Issues: 114
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

awesome-lit - Lion - Highly performant, accessible and flexible Web Components. (Design Systems)
awesome-web-components - Lion Web Components - Set of highly performant, accessible and flexible Web Components. (Real World / Component Libraries)
awesome-web-components - Repository
awesome-starred - ing-bank/lion - Fundamental white label web component features for your design system. (web-components)

README

Lion

Website
·
Fundamentals
·
Guides
·
Components
·
Blog

**Lion 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.

- **High Performance:** Focused on great performance in all relevant browsers with a minimal number of dependencies.
- **Accessibility:** Aimed at compliance with the WCAG 2.2 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.
- **Modern Code:** Lion is distributes as pure es modules.
- **Exposes functions/classes and Web Components:** Ships a functionality in it's most appropriate form.

> Note: Our demo examples might look simple and not very stylish. This is on purpose. They are designed to be basic so you can easily add your own styles to them to match your intended design, without dealing with styles that are already there.

Explore the Lion Guides ▶

## How to install

```bash
npm i @lion/ui
```

## How to use

### Extend a Web Component

**This is the main use case for lion**. To import component classes, and extend them for your own design system's components.

```js
import { css } from 'lit';
import { LionInput } from '@lion/ui/input.js';

class MyInput extends LionInput {
static get styles() {
return [
super.styles,
css`
/* your styles here */
`,
];
}
}
customElements.define('my-input', MyInput);
```

### Use a JavaScript system

There's a couple of "systems" in lion which have a JavaScript API. Examples are `localize`, `overlays`, `ajax`, etc.

```html

import { ajax } from '@lion/ui/ajax.js';

ajax
.fetch('data.json')
.then(response => response.json())
.then(data => {
// do something with the data
});

```

### Use a Web Component

You can also use the lion elements directly, although this is likely not a common use case.

```html

import '@lion/ui/define/lion-input.js';

```

## Issues

If you encounter an issue with any of the packages we are offering please open a [new bug issue](https://github.com/ing-bank/lion/issues/new?assignees=&labels=&template=bug_report.md&title=). Be sure to include a description of the expected and the current behavior - additional adding a [reproduction](https://webcomponents.dev/edit/kpZmz1CJN580OaXsk56f?pm=1) always helps.

## Feature requests

When you have an idea on how we could improve, please check our [discussions](https://github.com/ing-bank/lion/discussions) to see if there are similar ideas or feature requests. If there are none, please [start](https://github.com/ing-bank/lion/discussions/new) your feature request as a new discussion topic. Add the title `[Feature Request] My awesome feature` and a description of what you expect from the improvement and what the use case is.

## Content

| Name | version | description |
| --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [@lion/ui](https://github.com/ing-bank/lion/tree/master/packages/ui) | @lion/ui version | Set of components |
| [@lion/ajax](https://github.com/ing-bank/lion/tree/master/packages/ajax) | @lion/ajax version | A small wrapper around fetch |
| [Singleton-manager](https://github.com/ing-bank/lion/tree/master/packages/singleton-manager) | Singleton-manager version | A singleton manager provides a way to make sure a singleton instance loaded from multiple file locations stays a singleton. Primarily useful if two major version of a package with a singleton is used. |
| [Babel plugin extend docs](https://github.com/ing-bank/lion/tree/master/packages-node/babel-plugin-extend-docs) | babel-plugin-extend-docs version | A plugin which rewrites imports and templates according to a configuration. This enables the reuse of existing documentation from source packages while still using your extensions code. |
| [Providence analytics](https://github.com/ing-bank/lion/tree/master/packages-node/providence-analytics) | providence-analytics version | Providence is the 'All Seeing Eye' that generates usage statistics by analyzing code. It measures the effectivity and popularity of your software. With just a few commands you can measure the impact for (breaking) changes, making your release process more stable and predictable. |
| [Publish docs](https://github.com/ing-bank/lion/tree/master/packages-node/publish-docs) | publish-docs version | A tool that copies and processes your documentation (in a monorepo) so it can be published/shipped with your package. |
| [Remark extend](https://github.com/ing-bank/lion/tree/master/packages-node/remark-extend) | remark-extend version | A plugin for remark to extend markdown by importing from source files. |
| [Rocket preset extend lion docs](https://github.com/ing-bank/lion/tree/master/packages-node/rocket-preset-extend-lion-docs) | | When maintaining your own extension layer of lion you most likely want to maintain a similar documentation. Copying and rewriting the markdown files works, but whenever something changes you need copy and rewrite again. To do this automatically you can use this preset for [rocket](https://rocket.modern-web.dev/). |

## Technologies

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

- [lit](https://lit.dev/)
- [npm](http://npmjs.com)
- [Open Web Components](https://open-wc.org)
- [Modern Web](https://modern-web.dev)
- [Mocha](https://mochajs.org)
- [Chai](https://www.chaijs.com)
- [ESLint](https://eslint.org)
- [prettier](https://prettier.io)
- [ES modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)
- Lots and lots of tests

## 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.

## Coding guidelines

Check out our [coding guidelines](https://lion-web.netlify.app/guides/principles/definitions-and-terms/) for more detailed information.

## How to contribute

**Please note:** This project uses Npm [Workspaces](https://docs.npmjs.com/cli/v8/using-npm/workspaces). If you want to run all demos locally you need to get at least npm 7+ and install all dependencies by executing `npm install`.

Lion Web Components are only as good as its contributions.
Read our [contribution guide](https://github.com/ing-bank/lion/blob/master/CONTRIBUTING.md) and feel free to enhance/improve Lion. We keep feature requests closed while we're not working on them.

## Contact

Feel free to create a github issue for any feedback or questions you might have.