From a78b9fe5bdd1f3ef64d0316d1065e2e221abcc86 Mon Sep 17 00:00:00 2001 From: Manuel Schmidt <4742603+trailsnail@users.noreply.github.com> Date: Wed, 19 Oct 2022 15:35:53 +0200 Subject: [PATCH] `sl-alert`: move description from docs to component (#947) * 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 --- docs/components/alert.md | 2 -- src/components/alert/alert.ts | 3 +++ 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/components/alert.md b/docs/components/alert.md index 9202f0815..66f378ef2 100644 --- a/docs/components/alert.md +++ b/docs/components/alert.md @@ -2,8 +2,6 @@ [component-header:sl-alert] -Alerts are used to display important messages inline or as toast notifications. - ```html preview diff --git a/src/components/alert/alert.ts b/src/components/alert/alert.ts index 707e970c8..44bea6d19 100644 --- a/src/components/alert/alert.ts +++ b/src/components/alert/alert.ts @@ -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 *