ayo/lion
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: remove live/demos section from readmes

Browse source
This commit is contained in:
Joren Broekema 2020-06-03 11:34:58 +02:00
parent 83fc711061
commit 87740606bc
26 changed files with 1 additions and 105 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
packages/ajax/README.md
View file

@ -13,10 +13,6 @@ export default {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/fetch-system-ajax) for a live demo and documentation
## Features ## Features
- only JS functions, no (unnecessarily expensive) web components - only JS functions, no (unnecessarily expensive) web components

4
packages/button/README.md
View file

@ -19,10 +19,6 @@ export default {
export const main = () => html` <lion-button>Default</lion-button> `; export const main = () => html` <lion-button>Default</lion-button> `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/buttons-button) for a live demo and API documentation
## Features ## Features
- Clickable area that is bigger than visual size - Clickable area that is bigger than visual size

4
packages/calendar/README.md
View file

@ -30,10 +30,6 @@ export const main = () => {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/calendar-standalone) for a live demo and API documentation
## Features ## Features
- fully accessible keyboard navigation (Arrow Keys, PgUp, PgDn, ALT+PgUp, ALT+PgDn) - fully accessible keyboard navigation (Arrow Keys, PgUp, PgDn, ALT+PgUp, ALT+PgDn)

6
packages/checkbox-group/README.md
View file

@ -5,7 +5,7 @@
`lion-checkbox-group` component enhances the functionality of the native `<input type="checkbox">` element. `lion-checkbox-group` component enhances the functionality of the native `<input type="checkbox">` element.
Its purpose is to provide a way for users to check **multiple** options amongst a set of choices, or to function as a single toggle. Its purpose is to provide a way for users to check **multiple** options amongst a set of choices, or to function as a single toggle.
> You should use [lion-checkbox](https://github.com/ing-bank/lion/tree/master/packages/checkbox) elements as the children of the `<lion-checkbox-group>`. > You should use `<lion-checkbox>` elements as the children of the `<lion-checkbox-group>`.
```js script ```js script
import { html } from 'lit-html'; import { html } from 'lit-html';
@ -33,10 +33,6 @@ export const main = () => html`
> Make sure that the checkbox-group also has a name attribute, this is necessary for the [lion-form](?path=/docs/forms-form-overview--page)'s serialization result. > Make sure that the checkbox-group also has a name attribute, this is necessary for the [lion-form](?path=/docs/forms-form-overview--page)'s serialization result.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-checkbox-group--default-story) for a live demo and API documentation
## Features ## Features
Since it extends from [lion-fieldset](?path=/docs/forms-fieldset-overview--page), Since it extends from [lion-fieldset](?path=/docs/forms-fieldset-overview--page),

4
packages/core/README.md
View file

@ -17,10 +17,6 @@ export default {
import { LitElement, html, render } from '@lion/core'; import { LitElement, html, render } from '@lion/core';
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/core) for a live demo and API documentation
## Features ## Features
- [function to deduplicate mixins (dedupeMixin)](#deduping-of-mixins) - [function to deduplicate mixins (dedupeMixin)](#deduping-of-mixins)

4
packages/dialog/README.md
View file

@ -36,10 +36,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/overlays-specific-wc-dialog) for a live demo and documentation
## Features ## Features
- Show content when clicking the invoker - Show content when clicking the invoker

4
packages/fieldset/README.md
View file

@ -35,10 +35,6 @@ A native fieldset element should always have a legend-element for a11y purposes.
However, our fieldset element is not native and should not have a legend-element. However, our fieldset element is not native and should not have a legend-element.
Our fieldset instead has a label attribute or you can add a label with a div- or heading-element using `slot="label"`. Our fieldset instead has a label attribute or you can add a label with a div- or heading-element using `slot="label"`.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-fieldset-overview--page) for a live demo and documentation
## Features ## Features
- Easy retrieval of form data based on field names - Easy retrieval of form data based on field names

4
packages/form/README.md
View file

@ -24,10 +24,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-form-overview--page) for a live demo and documentation
## Features ## Features
- Data synchronization with models - Data synchronization with models

4
packages/helpers/README.md
View file

@ -13,10 +13,6 @@ A helpers package that contains several helpers that are used inside lion but ca
These helpers are considered developer tools, not actual things to use in production. These helpers are considered developer tools, not actual things to use in production.
Therefore, they may not have the same quality standards as our other packages. Therefore, they may not have the same quality standards as our other packages.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/helpers) for a live demo and API documentation
## Packages ## Packages
| Package | Version | Description | | Package | Version | Description |

4
packages/helpers/sb-action-logger/README.md
View file

@ -63,10 +63,6 @@ This connects the logger element to the trigger.
If you try logging complex values such as arrays, objects or promises, If you try logging complex values such as arrays, objects or promises,
you should expect to get only the string interpretation as the output in this logger. you should expect to get only the string interpretation as the output in this logger.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/helpers-storybook-action-logger) for a live demo and API documentation
## Features: ## Features:
- A public method `log` to log things to the action logger. - A public method `log` to log things to the action logger.

4
packages/icon/README.md
View file

@ -35,10 +35,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/icon-system-icon) for a live demo and documentation
## How to use ## How to use
### Installation ### Installation

4
packages/input-amount/README.md
View file

@ -28,10 +28,6 @@ export const main = () => {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-amount--default-story) for a live demo and API documentation
## Features ## Features
- Based on [lion-input](?path=/docs/forms-system-overview--page) - Based on [lion-input](?path=/docs/forms-system-overview--page)

4
packages/input-date/README.md
View file

@ -21,10 +21,6 @@ loadDefaultFeedbackMessages();
export const main = () => html` <lion-input-date label="Date"></lion-input-date> `; export const main = () => html` <lion-input-date label="Date"></lion-input-date> `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-date--default-story) for a live demo and API documentation
## Features ## Features
- Based on [lion-input](?path=/docs/forms-input--default-story) - Based on [lion-input](?path=/docs/forms-input--default-story)

4
packages/input-datepicker/README.md
View file

@ -26,10 +26,6 @@ export const main = () => {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-datepicker--default-story) for a live demo and API documentation
## Features ## Features
- Input field with a datepicker to help to choose a date - Input field with a datepicker to help to choose a date

4
packages/input-email/README.md
View file

@ -21,10 +21,6 @@ export const main = () => {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-email--default-story) for a live demo and API documentation
## Features ## Features
- Based on [lion-input](?path=/docs/forms-input--default-story) - Based on [lion-input](?path=/docs/forms-input--default-story)

4
packages/input-iban/README.md
View file

@ -25,10 +25,6 @@ export const main = () => {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-iban--default-story) for a live demo and API documentation
## Features ## Features
- Based on [lion-input](?path=/docs/forms-input--default-story) - Based on [lion-input](?path=/docs/forms-input--default-story)

4
packages/input-range/README.md
View file

@ -19,10 +19,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input-range--default-story) for a live demo and API documentation
## Features ## Features
- Based on [lion-input](?path=/docs/forms-input--default-story). - Based on [lion-input](?path=/docs/forms-input--default-story).

4
packages/input/README.md
View file

@ -20,10 +20,6 @@ export default {
export const main = () => html` <lion-input label="First Name"></lion-input> `; export const main = () => html` <lion-input label="First Name"></lion-input> `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-input--default-story) for a live demo and API documentation
## Features ## Features
- Based on [field](?path=/docs/forms-system-overview--page) - Based on [field](?path=/docs/forms-system-overview--page)

4
packages/localize/README.md
View file

@ -11,10 +11,6 @@ export default {
Is meant to translate text into multiple languages. Is meant to translate text into multiple languages.
In it's simplest form it is a function that returns the translated text for a namespace + key. In it's simplest form it is a function that returns the translated text for a namespace + key.
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/localize--page) for a live demo and documentation
## Features ## Features
- Uses es modules - Uses es modules

4
packages/radio-group/README.md
View file

@ -32,10 +32,6 @@ export const main = () => html`
- Make sure that to use a name attribute as it is necessary for the [lion-form](?path=/docs/forms-form-overview--page)'s serialization result. - Make sure that to use a name attribute as it is necessary for the [lion-form](?path=/docs/forms-form-overview--page)'s serialization result.
- If you have many options for a user to pick from, consider using [lion-select](?path=/docs/forms-select--default-story) instead - If you have many options for a user to pick from, consider using [lion-select](?path=/docs/forms-select--default-story) instead
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-radio-group--default-story) for a live demo and API documentation
## Features ## Features
Since it extends from [lion-fieldset](?path=/docs/forms-fieldset-overview--page), it has all the features a fieldset has. Since it extends from [lion-fieldset](?path=/docs/forms-fieldset-overview--page), it has all the features a fieldset has.

4
packages/select/README.md
View file

@ -33,10 +33,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-select--default-story) for a live demo and API documentation
For this form element it is important to put the `slot="input"` with the native `select` yourself, because you are responsible for filling it with `<option>`s. For this form element it is important to put the `slot="input"` with the native `select` yourself, because you are responsible for filling it with `<option>`s.
For most other form elements in `lion` we do this for you, because there's no need to put html inside the native form inputs. For most other form elements in `lion` we do this for you, because there's no need to put html inside the native form inputs.

4
packages/steps/README.md
View file

@ -12,10 +12,6 @@ export default {
}; };
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/steps-steps) for a live demo and API documentation
## Features ## Features
- navigate between different steps with 'previous' and 'next' functions. - navigate between different steps with 'previous' and 'next' functions.

4
packages/switch/README.md
View file

@ -18,10 +18,6 @@ export default {
export const main = () => html` <lion-switch label="Label" help-text="Help text"></lion-switch> `; export const main = () => html` <lion-switch label="Label" help-text="Help text"></lion-switch> `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/buttons-switch) for a live demo and documentation
## Features ## Features
- Get or set the checked state (boolean) - `checked` boolean attribute - Get or set the checked state (boolean) - `checked` boolean attribute

4
packages/tabs/README.md
View file

@ -29,10 +29,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/tabs) for a live demo and API documentation
## How to use ## How to use
### Installation ### Installation

4
packages/textarea/README.md
View file

@ -23,10 +23,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/forms-textarea--default-story) for a live demo and API documentation
## Features ## Features
- Default rows is 2 and it will grow to max-rows of 6. - Default rows is 2 and it will grow to max-rows of 6.

4
packages/tooltip/README.md
View file

@ -55,10 +55,6 @@ export const main = () => html`
`; `;
``` ```
## Live Demo/Documentation
> See our [storybook](http://lion-web-components.netlify.com/?path=/docs/overlays-specific-wc-tooltip) for a live demo and API documentation
## Features ## Features
- Show content when hovering the invoker - Show content when hovering the invoker