File tree Expand file tree Collapse file tree 2 files changed +11
-2
lines changed
docs/src/content/docs/guides
packages/starlight/user-components Expand file tree Collapse file tree 2 files changed +11
-2
lines changed Original file line number Diff line number Diff line change @@ -282,6 +282,10 @@ Other content is also supported in asides.
282282</Aside >
283283
284284<Aside type = " danger" >Do not give your password to anyone.</Aside >
285+
286+ <Aside icon = " heart" >
287+ Aside with a custom icon. The icon must be part of starlight's icon list.
288+ </Aside >
285289````
286290
287291The above code generates the following on the page:
@@ -306,6 +310,11 @@ Other content is also supported in asides.
306310
307311<Aside type = " danger" >Do not give your password to anyone.</Aside >
308312
313+ <Aside icon = " heart" >
314+ { ' ' }
315+ Aside with a custom icon. The icon must be part of starlight's icon list.
316+ </Aside >
317+
309318Starlight also provides a custom syntax for rendering asides in Markdown and MDX as an alternative to the ` <Aside> ` component.
310319See the [ “Authoring Content in Markdown”] ( /guides/authoring-content/#asides ) guide for details of the custom syntax.
311320
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ interface Props {
1212 title? : string ;
1313}
1414
15- let { type = ' note' , title } = Astro .props ;
15+ let { type = ' note' , title, icon } = Astro .props ;
1616
1717if (! asideVariants .includes (type )) {
1818 throw new AstroError (
@@ -30,7 +30,7 @@ if (!title) {
3030
3131<aside aria-label ={ title } class ={ ` starlight-aside starlight-aside--${type } ` } >
3232 <p class =" starlight-aside__title" aria-hidden =" true" >
33- <Icon name ={ icons [type ]} class =" starlight-aside__icon" />{ title }
33+ <Icon name ={ icon || icons [type ]} class =" starlight-aside__icon" />{ title }
3434 </p >
3535 <section class =" starlight-aside__content" >
3636 <slot />
You can’t perform that action at this time.
0 commit comments