js/webawesome
1
0
Fork 0
mirror of https://github.com/shoelace-style/webawesome.git synced 2026-01-12 12:09:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
This commit is contained in:
Manuel Schmidt
2022-10-19 15:35:53 +02:00
committed by GitHub
parent 0cba4695ba
commit a78b9fe5bd
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/components/alert.md
View File

@@ -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>

3
src/components/alert/alert.ts
View File

@@ -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
*