Skip to content

Commit ee87b3b

Browse files
icons (#24418)
1 parent 418661a commit ee87b3b

File tree

4 files changed

+39
-2
lines changed

4 files changed

+39
-2
lines changed

src/content/docs/style-guide/components/cards.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ styleGuide:
44
component: Card
55
---
66

7+
import { Render } from "~/components";
8+
79
Cards are a built-in component provided by [Starlight](https://starlight.astro.build/components/cards/).
810

911
## Cards
@@ -43,3 +45,12 @@ import { LinkTitleCard } from "~/components";
4345
Interesting content you want to highlight.
4446
</LinkTitleCard>
4547
```
48+
49+
## Card icons
50+
51+
<Render
52+
file="icons"
53+
params={{
54+
component: "cards",
55+
}}
56+
/>

src/content/docs/style-guide/components/icons.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
title: Icons
33
---
44

5+
import { Render } from "~/components";
6+
57
There are two icon components which pull from two different icon sets.
68

79
## astro-icon
@@ -24,4 +26,13 @@ The Starlight icon set is available to use in `Tab`, `Card` and other Starlight
2426
import { StarlightIcon } from "~/components";
2527

2628
<StarlightIcon name="seti:shell" color="var(--sl-color-text-accent)" size="3rem" />
27-
```
29+
```
30+
31+
## Icon library
32+
33+
<Render
34+
file="icons"
35+
params={{
36+
component: "cards or tabs",
37+
}}
38+
/>

src/content/docs/style-guide/components/tabs.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ styleGuide:
44
component: Tabs
55
---
66

7-
import { Tabs, TabItem } from '~/components';
7+
import { Tabs, TabItem, Render } from '~/components';
88

99
This component can help you create a tabbed interface to show related information more efficiently. Use it when there are different ways of getting the same thing done:
1010

@@ -27,6 +27,15 @@ import { Tabs, TabItem } from '~/components';
2727
</Tabs>
2828
```
2929

30+
### Tab icons
31+
32+
<Render
33+
file="icons"
34+
params={{
35+
component: "tab labels",
36+
}}
37+
/>
38+
3039
## Synchronize Tabs
3140

3241
If you have tabs that follow a particular pattern (Dashboard / API / Terraform), add a `syncKey` parameter that includes a `string` value.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
params:
3+
- component
4+
---
5+
6+
Optionally, you can choose a corresponding icon from Starlight’s [Icons](https://starlight.astro.build/reference/icons/#all-icons) for {props.component}.

0 commit comments

Comments
 (0)