lumen-blocks 0.0.0

Accessible, styled, opinionated components for Dioxus inspired by the shadcn UI and built on Dioxus Primitives
Documentation
  • Coverage
  • 0%
    0 out of 1 items documented0 out of 0 items with examples
  • Size
  • Source code size: 4.66 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 228.71 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 13s Average build duration of successful builds.
  • all releases: 13s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Leaf-Computer/lumen-blocks
    111 8 1
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • danieldaquino

Lumen is an ARIA-accessible, styled, opinionated component library for Dioxus inspired by the shadcn UI project, and built on top of the Dioxus Primitives unstyled components library.

[!IMPORTANT] This library is still experimental. Expect bugs and breaking changes until a stable release is made.

Getting started

For installation instructions and getting started with your project, please visit our documentation: Installation Guide

Running the preview

  1. Ensure you have the Dioxus toolchain.
  2. Run this to serve the base component preview app:
dx serve -p docsite --platform web

Development

Without nix-shell

If you are making changes to components, you should also run this during development to keep tailwind classes up to date, on top of the dx serve command.

cd docsite && tailwindcss -i tailwind.css -o assets/tailwind.css --config tailwind.config.js --watch

With nix-shell

If you have nix-shell, these two commands can be done more ergonomically:

  1. Run this command to get needed CLI tools:
nix-shell
  1. Run this to serve the base component preview app:
just dev-docsite
  1. Run this to keep tailwind classes up to date:
just dev-docsite-tailwind

Acknowledgements

This project stands in the shoulders of giants, and we would like to acknowledge the following open-source projects:

  • Dioxus Primitives for the unstyled components library.
  • shadcn UI for the inspiration and overall structure.
  • Dioxus for the awesome framework, and several code examples that helped the development of this library.

Funding

If you find value in this project, please consider becoming a sponsor to support ongoing development and maintenance. Your contributions help ensure Lumen Blocks continues to evolve with new features and improvements!

License

All source-code for this project is licensed under the MIT license.

Any contribution intentionally submitted for inclusion in this repository, by you, shall be licensed as MIT, without any additional terms or conditions.

© All rights are reserved to Leaf Computer Corporation for the name "Lumen Blocks", and the "Lumen Blocks" logo.