`sl-alert`: move description from docs to component ()

* move component description from docs to component

* use component description in docs

* add style for lead sentence, keep bc for not updated components

* run `npm prettier`

* render summary as part of the header

* add `title` as another custom tag for JSDoc

* render components title in header
pull/958/head
Manuel Schmidt 2022-10-19 15:35:53 +02:00 zatwierdzone przez GitHub
rodzic 0cba4695ba
commit a78b9fe5bd
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
2 zmienionych plików z 3 dodań i 2 usunięć
docs/components
src/components/alert

Wyświetl plik

@ -2,8 +2,6 @@
[component-header:sl-alert]
Alerts are used to display important messages inline or as toast notifications.
```html preview
<sl-alert open>
<sl-icon slot="icon" name="info-circle"></sl-icon>

Wyświetl plik

@ -15,6 +15,9 @@ import type { CSSResultGroup } from 'lit';
const toastStack = Object.assign(document.createElement('div'), { className: 'sl-toast-stack' });
/**
* @title Alert
* @summary Alerts are used to display important messages inline or as toast notifications.
*
* @since 2.0
* @status stable
*