Skip to content

Commit a3cf282

Browse files
committed
docs: add Features component documentation
1 parent 0be6a14 commit a3cf282

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

readme/custom.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,35 @@ import FeatureButton from "@site/src/components/features/FeatureButton";
106106

107107
***
108108

109+
## Features
110+
111+
Renders a responsive array of `FeatureButton` components.
112+
113+
**Import:**
114+
115+
```jsx
116+
import Features from "@site/src/components/features/Features";
117+
```
118+
119+
**Usage:**
120+
121+
```jsx
122+
const features = [
123+
{ url: "/docs/overview", imgUrl: "/img/overview.svg", text: "Overview" },
124+
{ url: "/docs/start", imgUrl: "/img/start.svg", text: "Get Started" },
125+
];
126+
127+
<Features featureList={features} index width="140px" />
128+
```
129+
130+
**Props:**
131+
132+
* `featureList` (array, required) - List of feature objects with `url`, `imgUrl`, `text`, and optional `alt`
133+
* `index` (boolean, optional) - If true, all buttons use primary styling; otherwise secondary styling
134+
* `...props` (any, optional) - Passed to each `FeatureButton` (e.g., `width`, `classes`)
135+
136+
***
137+
109138
## BulletBox
110139

111140
A styled box component designed to display content in a responsive card-like button format.

0 commit comments

Comments
 (0)