UNPKG

8.29 kBMarkdownView Raw
1<div align="center">
2
3[![][logo-url]][docs-url]
4
5**Tailwind CSS Components**
6Adds component classes like `btn`, `card` and more to Tailwind CSS
7
8[ [See all components][docs-url] ]
9
10[![][tweet]][tweet-url]
11
12</div>
13
14[![][banner-url]][docs-url]
15
16# daisyUI
17[![][build]][build-url] [![][npm]][npm-url] [![][number-of-components]][docs-url] [![][license]][license-url]
18[![][dl]][npm-url] [![][stars]][gh-url] [![][commit]][gh-url]
19
20
21- 👉 [ [See all components][docs-url] ]
22- 📘 Documents: [daisyui.com][docs-url]
23- 🎲 Try it online: [Tailwind Play][tw-play-url] | [Codepen][codepen-url]
24- 📦 Source: [GitHub][gh-url] | [NPM][npm-url] | [Unpkg][unpkg-url] | [JSdeliver][jsdeliver-url] | [cdnjs][cdnjs-url]
25
26---
27
28## 🌼 Features
29<details>
30<summary>
31 show / hide
32</summary>
33
34- **Tailwind CSS plugin**
35 daisyUI is a Tailwind CSS plugin. Install it and add it to your `tailwind.config.js` file.
36- **Component classes**
37 Adds component classes to Tailwind. Classes like `btn`, `card`,… So you will end up with a cleaner HTML.
38- **Semantic color names**
39 Adds color names like `primary`, `secondary`, `accent`,….
40- **Customizable**
41 You can customize the design of components with Tailwind utility classes and CSS variables.
42- **Themeable**
43 Add multiple themes and customize colors. You can even set a theme for a specific section of your page.
44- **RTL supported**
45 Enable `rtl` config for right to left layouts.
46- **Pure CSS**
47 No script file, no dependencies. Works on all frameworks and environments!
48
49</details>
50
51---
52
53## 📀 Install now!
54
55```bash
56npm i daisyui
57```
58
59Then add daisyUI to your `tailwind.config.js`
60[ [Read more][docs-url-install] ]
61```js
62module.exports = {
63
64 plugins: [
65 require('daisyui'),
66 ],
67
68}
69```
70
71
72<details>
73<summary>
74 Or use a CDN
75</summary>
76
77
78Loading CSS files from CDN is not recommended for production. It's better to install Tailwind and daisyUI as Nodejs dependencies so you can config/customize everything, and purge unused styles.*
79
80
81```html
82<link href="https://cdn.jsdelivr.net/npm/daisyui@1.24.2/dist/full.css" rel="stylesheet" type="text/css" />
83<link href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2/dist/tailwind.min.css" rel="stylesheet" type="text/css" />
84```
85
86</details>
87
88---
89## 🚀 Use
90Use component classes to build your UI.
91```html
92<a class="btn">Hello!</a>
93```
94```html
95<input type="checkbox" class="checkbox"/>
96```
97```html
98<input type="checkbox" class="toggle"/>
99```
100```html
101<div class="alert alert-success">
102 Message sent successfully
103</div>
104```
105
106👉 [See all components][docs-url]
107🎲 [Try it online][tw-play-url]
108
109---
110
111## 📘 Documents + Examples
112See the official site:
113[ [daisyui.com][docs-url] ↗︎ ]
114
115---
116
117## 🤝 Contributing
118Read the documents for more info:
119[ [Read contribution guide](https://github.com/saadeghi/daisyui/blob/master/.github/CONTRIBUTING.md) ]
120
121---
122## List of Components
123<details>
124<summary>
125 show / hide
126</summary>
127
128- [x] Alert
129- [x] Artboard
130- [ ] App bar
131- [x] Avatar
132 - [x] Avatar group
133- [x] Badge
134- [ ] Banner
135- [x] Breadcrumb
136- [x] Button
137 - [x] Button group
138- [ ] Calendar
139- [x] Carousel
140- [x] Card
141- [ ] Chat bubble
142- [x] Collapse (Accordion)
143- [ ] Comment
144- [x] Countdown
145- [ ] Cover
146- [x] Divider
147- [x] Drawer
148- [ ] Empty placeholder
149- [x] Footer
150- [ ] Form
151 - [x] Select
152 - [x] Text input
153 - [x] Text area
154 - [x] Checkbox
155 - [x] Radio
156 - [x] Range slider
157 - [x] Rating
158 - [x] Toggle
159 - [ ] Upload
160- [x] Hero
161- [x] Indicator
162- [x] Kbd
163- [x] Link
164- [ ] Loading
165- [x] Menu
166- [ ] Mockup
167 - [ ] Browser
168 - [x] Code
169 - [x] Phone
170 - [x] Window
171- [x] Navbar
172- [x] Mask
173- [x] Modal
174- [x] Pagination
175- [x] Progress
176- [x] Stack
177- [x] Stat
178- [x] Steps
179- [ ] Tag
180- [x] Table
181- [x] Tabs
182- [ ] Timeline
183- [ ] Toast
184- [x] Tooltip
185- [ ] Treeview
186
187</details>
188
189---
190## Featured on:
191
192<details>
193<summary>
194 show / hide
195</summary>
196
197- Blogs
198 - [Logrocket](https://blog.logrocket.com/daisyui-tailwind-components-react-apps/)
199 - [GraphCMS](https://graphcms.com/blog/build-a-personal-timeline-with-graphcms-and-sveltekit)
200 - [wweb.dev](https://wweb.dev/weekly/85/)
201 - [flaming.codes](https://flaming.codes/posts/boostrap-tailwind-alternative-with-daisy-ui)
202 - [rockyourcode](https://www.rockyourcode.com/how-to-setup-react-typescript-with-snowpack-and-daisyui/)
203 - [HackerNews](https://news.ycombinator.com/item?id=28004515)
204 - [Product Hunt](https://www.producthunt.com/posts/daisyui)
205 - [Siecle Digital](https://siecledigital.fr/2021/05/29/daisyui-plugin-gratuit-avec-composants-tailwind-css-a/)
206 - [speckyboy](https://speckyboy.com/weekly-news-for-designers-594/)
207 - [dailydev](https://app.daily.dev/posts/-4OPGw0te)
208 - [Future Tech Blog (Japanese)](https://future-architect.github.io/articles/20211124a/)
209- Youtube videos
210 - [Supabase & Sveltekit - Build Twitter in 75 minutes](https://www.youtube.com/watch?v=mPQyckogDYc)
211 - [Setup the Best Frontend JavaScript Stack - Svelte, Vite, TailwindCSS and DaisyUI](https://www.youtube.com/watch?v=mEBPN_9jTAE)
212 - [Jamstack powered Image gallery with Cloudinary, Tailwind and DaisyUI](https://www.youtube.com/watch?v=Hpjq0D1vcpM)
213 - [SvelteKit Crash Course w/ Tailwind CSS and DaisyUI, GraphQL and dynamic routes](https://www.youtube.com/watch?v=zH2qG9YwN3s)
214 - [DaisyUI : Worth a try or skip on by?](https://www.youtube.com/watch?v=hM9fENyAquM)
215 - [How to use daisyUI in SvelteKit?](https://www.youtube.com/watch?v=haKnkk6ds20)
216 - [DaisyUI Untuk Yang Mau Pindah ke TailwindCSS dari Bootstrap (Indonesian)](https://www.youtube.com/watch?v=Wm2g6FWec34)
217 - [Next.js - Tailwind - DeisyUI Setup](https://www.youtube.com/watch?v=uXQgJbUj3PQ)
218- Courses
219 - [Building with SvelteKit and GraphCMS](https://explorers.netlify.com/learn/building-with-sveltekit-and-graphcms)
220 - [Svelte for Beginners by Mike Karan](https://www.udemy.com/course/svelte-for-beginners/)
221 - [React Front To Back 2022 by Brad Traversy](https://www.udemy.com/course/react-front-to-back-2022/)
222 - [Build Instagram profile page UI clone w/Next.js TailwindCSS](https://www.udemy.com/course/build-instagram-profile-page-ui-clone-nextjs-tailwindcss/)
223 - [Instagram UI Clone Login Page w/ NextJS & TailwindCSS](https://www.udemy.com/course/instagram-ui-clone-login-page-w-nextjs-tailwindcss/)
224 - [Build your Developer Portfolio and Blog from Scratch with Svelte and GraphCMS](https://www.freecodecamp.org/news/build-your-developer-portfolio-from-scratch-with-sveltekit-and-graphcms/)
225
226</details>
227
228---
229
230<div align="center">
231
232
233༼ つ ◕_◕ ༽つ Please share
234
235[![][tweet]][tweet-url]
236
237</div>
238
239
240
241[install-size]: https://badgen.net/bundlephobia/minzip/daisyui?label=bundle%20size&color=green
242[build]: https://badgen.net/github/checks/saadeghi/daisyui?label=build
243[npm]: https://badgen.net/github/tag/saadeghi/daisyui?label=version&color=green
244[dl]: https://badgen.net/npm/dt/daisyui?label=installs&icon=npm&color=green
245[commit]: https://badgen.net/github/last-commit/saadeghi/daisyui?icon=github&color=green
246[license]: https://badgen.net/github/license/saadeghi/daisyui?color=green
247[stars]: https://badgen.net/github/stars/saadeghi/daisyui?color=green
248[tweet]: https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fsaadeghi%2Fdaisyui
249
250[install-size-url]: https://bundlephobia.com/result?p=daisyui
251[license-url]: https://github.com/saadeghi/daisyui/blob/master/LICENSE
252[npm-url]: https://www.npmjs.com/package/daisyui
253[cdnjs-url]: https://cdnjs.com/libraries/daisyui
254[gh-url]: https://github.com/saadeghi/daisyui
255[tw-play-url]: https://daisyui.com/tailwindplay
256[codepen-url]: https://codepen.io/saadeghi/pen/gOwWKvv
257[unpkg-url]: https://unpkg.com/browse/daisyui/
258[jsdeliver-url]: https://www.jsdelivr.com/package/npm/daisyui
259[build-url]: https://github.com/saadeghi/daisyui/actions
260[tweet-url]: https://twitter.com/intent/tweet?text=daisyUI%20%0D%0AUI%20Components%20for%20Tailwind%20CSS%20%0D%0Ahttps://github.com/saadeghi/daisyui
261[number-of-components]: https://badgen.net/badge/total%20components/41/green
262
263[docs-url-install]: https://daisyui.com/docs/install
264[docs-url]: https://daisyui.com/
265[logo-url]: https://raw.githubusercontent.com/saadeghi/files/main/daisyui/logo-4.svg
266[banner-url]: https://raw.githubusercontent.com/saadeghi/files/main/daisyui/card-3.png
267
268