Skip to content

Commit 54e17a7

Browse files
committed
docs: update custom theme guide
1 parent 510008c commit 54e17a7

File tree

1 file changed

+64
-3
lines changed

1 file changed

+64
-3
lines changed

README.md

Lines changed: 64 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,68 @@ A demo of the application is available at [https://essentials-stg.vercel.app/](h
1414

1515
## Custom Theme Guide
1616

17-
### Network Logo
17+
This project utilizes Hero UI's theming system for consistent styling across the application. The theming system is based on TailwindCSS and allows for extensive customization.
18+
19+
### Customizing the Theme
20+
21+
You can customize the theme by modifying the `tailwind.config.js` file. The Hero UI plugin is already configured, allowing you to:
22+
23+
1. Define custom colors
24+
2. Create light and dark themes
25+
3. Customize component appearances
26+
27+
```javascript
28+
// Example of customizing theme in tailwind.config.js
29+
const {heroui} = require("@heroui/react");
30+
31+
module.exports = {
32+
// ... other configs
33+
plugins: [
34+
heroui({
35+
themes: {
36+
'purple-dark': {
37+
extend: 'dark',
38+
colors: {
39+
primary: {
40+
50: '#3B096C',
41+
100: '#520F83',
42+
200: '#7318A2',
43+
300: '#9823C2',
44+
400: '#c031e2',
45+
500: '#DD62ED',
46+
600: '#F182F6',
47+
700: '#FCADF9',
48+
800: '#FDD5F9',
49+
900: '#FEECFE',
50+
DEFAULT: '#DD62ED',
51+
foreground: '#ffffff',
52+
},
53+
},
54+
},
55+
},
56+
}),
57+
// Other plugins
58+
],
59+
}
60+
```
61+
62+
```javascript
63+
// Example of customizing theme in layout.tsx, add corresponding theme name in className
64+
65+
<Providers>
66+
<div className="purple-dark flex flex-col min-h-screen">
67+
<div className="flex-grow">
68+
{children}
69+
</div>
70+
<Footer />
71+
</div>
72+
</Providers>
73+
74+
```
75+
76+
### Network Branding Assets
77+
78+
#### Network Logo
1879

1980
Network logos should be placed in the `/public/images/network/` directory with the following specifications:
2081

@@ -27,7 +88,7 @@ Currently available network logos:
2788
* `assethub-westend.png`
2889
* `paseo.png`
2990

30-
### Network Banner Images
91+
#### Network Banner Images
3192

3293
Network banner images should be placed in:
3394

@@ -36,7 +97,7 @@ Network banner images should be placed in:
3697
* Banner images will be displayed at the top of network pages
3798
* Design Style: Should reflect the network's characteristics and may include the network name, logo, and related visual elements
3899

39-
### Adding New Network Images
100+
#### Adding New Network Images
40101

41102
1. Prepare image files according to the specifications above
42103
2. Add the network logo to `/public/images/network/[network-id].png`

0 commit comments

Comments
 (0)