This project brings DaisyUI components into your Phoenix project.
Reference this repository on your mix.exs file to start using.
def deps do
[
{:daisy_ui_components, "~> 0.7"}
]
endAdd through npm the daisy UI package inside your phoenix application:
cd assets
npm i -D daisyui@latestOn tailwind.config.js include Live DaisyUI Components under the content list and reference under plugins
module.exports = {
content: [
//...
"../deps/daisy_ui_components/**/*.*ex" // <- reference DaisyUIComponents as content path
],
//...
plugins: [
//...
// comment the tailwind form to not conflict with DaisyUI
// require("@tailwindcss/forms"),
require("daisyui") <- // add daisyUI plugin
//...
]
}Add error translation function to your app's config.exs file. This function is used to translate ecto changeset errors
config :daisy_ui_components, translate_function: &MyAppWeb.CoreComponents.translate_error/1And now this library is ready. To have the components available under liveview, import the components on the web folder
defp html_helpers do
quote do
# Translation
use Gettext, backend: MyAppWeb.Gettext
# HTML escaping functionality
import Phoenix.HTML
# Import DaisyUI components into your project
use DaisyUIComponents
# Comment your own CoreComponents to not conflict with the defaults of this library.
# import YourProjectWeb.CoreComponents
# Importing CoreComponents from your project is no longer necessary since
# DaisyUIComponents.CoreComponents offers a drop in replacement
# If you still want to use your own core components, remember to delete the default components generated from phoenix in this file
# ...
end
endFinally, in order to not conflict with some of the DaisyUI default styles, remove the bg-white class in your root.html.heex file.
## Change from this
<body class="bg-white">
## to this
<body>This library aims to integrate seamlessly with Phoenix generators. For this reason you don't need the components inside the CoreComponents after adding use DaisyUIComponents into your web file.
All the components should be compatible, styled with DaisyUI.
If you encounter any compatibility issues, feel free to open an issue or submit a pull request, and I'll take a look.
This project is fully compatible with the Liveview 1.0 🔥. If you are using a previous Liveview version, check the migration guide.
Since DaisyUI requires npm to install, it's also necessary to configure in your project the asset pipeline to use the npm commands.
In your mix.exs file, add the npm command in your assets setup:
"assets.setup": [
"tailwind.install --if-missing",
- "esbuild.install --if-missing"
+ "esbuild.install --if-missing",
+ "cmd npm install --prefix assets"
]and if you are deploying the application with Docker, run the npm scripts there too:
# install build dependencies
-RUN apt-get update -y && apt-get install -y build-essential git \
+RUN apt-get update -y && apt-get install -y build-essential git npm \
&& apt-get clean && rm -f /var/lib/apt/lists/*_*
# ...
RUN mix deps.compile
# build assets
+COPY assets/package.json assets/package-lock.json ./assets/
+RUN npm --prefix ./assets ci --progress=false --no-audit --loglevel=errorList of available components.
| Component | Status | Storybook |
|---|---|---|
| Button | ✅ | ✅ |
| Dropdown | ✅ | ✅ |
| Modal | ✅ | ✅ |
| Swap | ✅ | ✅ |
| Theme Controller | ❌ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Accordion | ❌ | ❌ |
| Avatar | ✅ | ✅ |
| Badge | ✅ | ✅ |
| Card | ✅ | ✅ |
| Carousel | ❌ | ❌ |
| Chat bubble | ❌ | ❌ |
| Collapse | ❌ | ❌ |
| Countdown | ❌ | ❌ |
| Diff | ❌ | ❌ |
| Kbd | ❌ | ❌ |
| Stat | ✅ | ❌ |
| Table | ✅ | ✅ |
| Timeline | ❌ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Breadcrumbs | ✅ | ✅ |
| Bottom navigation | ❌ | ❌ |
| Link | ❌ | ❌ |
| Menu | ✅ | ✅ |
| Navbar | ✅ | ✅ |
| Pagination | ✅ | ✅ |
| Steps | ❌ | ❌ |
| Tabs | ❌ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Alert | ✅ | ✅ |
| Loading | ✅ | ✅ |
| Progress | ❌ | ❌ |
| Radial progress | ❌ | ❌ |
| Skeleton | ❌ | ❌ |
| Toast | ❌ | ❌ |
| Tooltip | ✅ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Checkbox | ✅ | ✅ |
| File input | ❌ | ❌ |
| Radio | ✅ | ✅ |
| Range | ✅ | ✅ |
| Rating | ❌ | ❌ |
| Select | ✅ | ✅ |
| Text Input | ✅ | ✅ |
| Textarea | ✅ | ✅ |
| Toggle | ✅ | ✅ |
| Component | Status | Storybook |
|---|---|---|
| Artboard | ❌ | ❌ |
| Divider | ❌ | ❌ |
| Drawer | ✅ | ✅ |
| Footer | ❌ | ❌ |
| Hero | ❌ | ❌ |
| Indicator | ❌ | ❌ |
| Join | ✅ | ❌ |
| Mask | ❌ | ❌ |
| Stack | ❌ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Browser | ❌ | ❌ |
| Code | ❌ | ❌ |
| Phone | ❌ | ❌ |
| Window | ❌ | ❌ |
| Component | Status | Storybook |
|---|---|---|
| Flash | ✅ | ✅ |
| Header | ✅ | ✅ |
| List | ✅ | ✅ |
| Simple Form | ✅ | ✅ |
| Input | ✅ | ✅ |
| Table | ✅ | ✅ |
- Implement all components
- Document all components in Storybook
- Create
mixscript to enable users to import the components of this library into their projects, sharing the same project namespace.