Skip to content

phcurado/daisy_ui_components

Repository files navigation

DaisyUI Components

Daisy UI Logo

CI Coverage Status Hex.pm HexDocs.pm License

This project brings Daisy UI components into your Phoenix LiveView project.

This project is still experimental, expect breaking changes in future.

Installation

Reference this repository on your mix.exs file to start using.

def deps do
  [
    {:daisy_ui_components, "~> 0.4"}
  ]
end

Add through npm the daisy UI package inside your phoenix application:

cd assets
npm i -D daisyui@latest

On 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/1

And 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

    # Import DaisyUI components into your project
    use DaisyUIComponents
    # HTML escaping functionality
    import Phoenix.HTML
    # Phoenix CoreComponents replacement
    import DaisyUIComponents.CoreComponents

    # 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
end

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 includes its own Core Components styled with DaisyUI. It is designed to replace your existing CoreComponents, ensuring that Phoenix generators continue to work seamlessly in your project.

If you encounter any compatibility issues, feel free to open an issue or submit a pull request, and I'll take a look.

Liveview 1.0

This project is fully compatible with the Liveview 1.0 🔥. If you are using a previous Liveview version, check the migration guide.

Components

List of available components.

✅: Implemented ❌: To be implemented