Skip to content

Commit 0be6a14

Browse files
committed
docs: add FeatureButton component with customizable properties for enhanced navigation
1 parent 2d49990 commit 0be6a14

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

readme/custom.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,40 @@ import LbeChip from "@site/src/components/commons/LbeChip";
7272

7373
***
7474

75+
## FeatureButton
76+
77+
A clickable button component that displays an image with text, designed for feature navigation.
78+
79+
**Import:**
80+
81+
```jsx
82+
import FeatureButton from "@site/src/components/features/FeatureButton";
83+
```
84+
85+
**Usage:**
86+
87+
```jsx
88+
<FeatureButton
89+
url="/docs/example"
90+
imgUrl="/img/icon.svg"
91+
text="Feature Name"
92+
width="150px"
93+
alt="Feature icon"
94+
/>
95+
```
96+
97+
**Props:**
98+
99+
* `url` (string, required) - The link destination URL
100+
* `imgUrl` (string, required) - Path to the image/icon (relative to static folder)
101+
* `text` (string, required) - Button text displayed below the image
102+
* `width` (string, optional) - Width of the image (default: "120px")
103+
* `alt` (string, optional) - Alternative text for the image (defaults to `text` if not provided)
104+
* `index` (boolean, optional) - If true, applies primary button styling; otherwise uses secondary styling
105+
* `classes` (string, optional) - Additional CSS classes to apply to the button
106+
107+
***
108+
75109
## BulletBox
76110

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

0 commit comments

Comments
 (0)