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 distributed as pure es modules.
- **Exposes functions/classes and Web Components:** Ships a functionality in it's most appropriate form.
> Note: Our demos may look a little bland but that is on purpose. They only come with functional stylings.
> This makes sense as the main use case is to extend those components and if you do you do not want to override existing stylings.
Explore the Lion Guides ▶
Table of Contents
## Astro migration
- Keep using `/docs` on the root level as we used it in the `master` branch. The documentation is copied into Astro related directories on `npm run start` and when when anything in `/docs` is updated.
- Replace manually all references to assets in all `md` files so that we imply that the path is produced from the directory where the md file is located. F.e. `new URL('../src/wa-combobox/assets/obama.jpeg', import.meta.url).href;` should `new URL('./src/wa-combobox/assets/obama.jpeg', import.meta.url).href;`. Note double dot is replaced with one dot. See [this PR](https://github.com/ing-bank/lion/pull/2125/files#diff-403b1e0ab54d51dcfe54248e847498e492da00383d8b33a4087994ab9035a22c) for the reference.
- Rename all `*.mjs` files to `*.js` ones if they are used by `mdjs` examples
### Astro how to
- To start in dev mode run `npm run start`
- To start in production mode:
- Run `npm run build`
- Run `npm run preview`
### Issues which are not caused by the migration (not to be fixed now)
- There is a browser console error on [collapsible page](http://localhost:4321/components/collapsible):
```
__mdjs-stories--use-cases.js:40 Uncaught TypeError: shadowRoot.getElementById is not a function
```
Note. There is the same error on master. This issue is not caused by the migration
## How to install
```bash
npm i @lion/ui
```
### Temporary phone-number metadata workaround
We temporarily vendor `awesome-phonenumber@7.9.0-tlouisse.libphonenumber-9.0.41`,
rebuilt from Google's **libphonenumber v9.0.41**, instead of the registry dependency.
This includes updated phone-number metadata, such as the French Guiana premium-rate
example `+594890123456`, which the previous `awesome-phonenumber@7.8.0` rejected.
We keep this workaround until the next upstream awesome-phonenumber release
incorporating the required metadata is available.
The private workspace `packages-node/awesome-phonenumber` contains pinned fork
and Google JavaScript sources, not a prebuilt distribution. Its build verifies
source checksums, compiles with Closure ADVANCED and bundles ESM with Rollup using
the fork's inputs and options. `npm run types --workspace @lion/ui` and `npm pack`
build and copy the generated library into `packages/ui/generated/awesome-phonenumber`.
Root postinstall builds these assets before source-analysis tools and browser tests;
prepack also emits UI declarations for a fresh checkout.
Wireit caches unchanged inputs; no source downloads occur during builds.
`@lion/ui` has no awesome-phonenumber runtime or bundled dependency.
Its package-private `#awesome-phonenumber` import maps types, ESM and CommonJS
to the shipped assets, requiring no consumer browser import map.
The legacy docs dependency keeps its separate registry version.
MIT and Google's Apache-2.0 notices accompany both sources and generated assets.
See [source provenance and build requirements](packages-node/awesome-phonenumber/README.md).
Run `npm run test:node --workspace @lion/ui` to pack Lion, install it into a fresh
consumer outside the checkout with no overrides, and verify ESM, CommonJS,
TypeScript 7 and 4.7.4, licenses, provenance, and French Guiana metadata. It also
checks deterministic source rebuilds and rejection of modified sources.
The install needs registry access for Lion's ordinary dependencies, not the phone
library. `npm run lint:phone-number-up-to-date` verifies the maintained source
inventory rather than incorrectly claiming registry freshness.
Once the next upstream awesome-phonenumber release includes the required
metadata, restore the normal registry dependency in `packages/ui/package.json`,
replace `#awesome-phonenumber` runtime/JSDoc imports with the registry name, and
remove the private workspace, UI `imports` mapping, generated `files` entry and
build/prepack hooks/helpers, including the root postinstall phone-build step.
Remove the generated directory, source-lint integration, snapshot newline rule
and third-party formatter/linter exclusions, then regenerate `package-lock.json`.
Update the packaging test to check the registry dependency instead of generated
assets. Keep the metadata
regression test and rerun the phone tests, typechecks, and packed-consumer install
check before removing this workaround documentation.
## 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
```
### Use a Web Component
You can also use the lion elements directly, although this is likely not a common use case.
```html
```
## 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) |
| Set of components |
| [@lion/ajax](https://github.com/ing-bank/lion/tree/master/packages/ajax) |
| A small wrapper around fetch |
| [Singleton-manager](https://github.com/ing-bank/lion/tree/master/packages/singleton-manager) |
| 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) |
| 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 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) |
| 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) |
| 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
## Supported browsers
Lion needs the native modal dialog: a modal overlay is opened with `