You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26
Original file line number
Diff line number
Diff line change
@@ -65,6 +65,7 @@ If you are using `web3uikit` with Next.js, be sure to follow the [official guide
65
65
-[🤝 Need help](#-need-help)
66
66
-[🚀 Quick start](#-quick-start)
67
67
-[🧭 Table of Contents](#-table-of-contents)
68
+
-[🏗️ New Components](#-new-components)
68
69
<!-- - [👩🔬 Advanced setup](#-advanced-setup) -->
69
70
-[📦 Packages](#-packages)
70
71
-[Core module](#core-module)
@@ -76,6 +77,31 @@ If you are using `web3uikit` with Next.js, be sure to follow the [official guide
76
77
77
78
It's possible to install all functionalities of web3uikit by installing `web3uikit` as a dependency. But, you may choose to only install certain modules (as listed below). -->
78
79
80
+
# 🏗️ New Components
81
+
82
+
Remember to follow steps from [CONTRIBUTE.md](https://github.com/web3ui/web3uikit/blob/master/CONTRIBUTE.md) to setup your local environment.
83
+
84
+
## Want to add new component ?
85
+
86
+
- run `pnpm new` in terminal and follow the interactive steps to generate templates for a new component.
87
+
88
+
## Want to add new icon ?
89
+
90
+
- Add the svg file(s) to `web3uikit/packages/icons/src/lib/svgs/` (remember to give meaningful filename, as filename gets converted to icon name)
91
+
- run `pnpm run icons:create` in terminal and your icon is created. 🔥
92
+
- To verify your newly added icon run `pnpm storybook-build`. Once storybook is open, navigate to `8.ICONS/Gallery` and search for your icon.
93
+
94
+
## Want to add a new Chain Logo ?
95
+
96
+
- run `pnpm plop "ChainLogo" -- --name "<CHAIN NAME HERE>" --color "<BACKGROUND COLOR HERE>"`
97
+
98
+
example => `pnpm plop "ChainLogo" -- --name "ethereum" --color "#396993"`
99
+
100
+
- Now in your code editor navigate to `web3uikit/packages/core/src/lib/Illustrations/images/chains`, here a new file must be created with your chain name, in this file replace `<></>` with your chain `svg code`.
101
+
- To verify your newly added chain logo run `pnpm storybook-build`. Once storybook is open:
102
+
- navigate to `6.Graphic`, and your chain logo should be added to `Illustration` and `CryptoLogo` component.
103
+
- navigate to `4.UI/CryptoCards`, and your chain logo should be added here as well. 😃
0 commit comments