Getting Started

Installation

Follow the steps below to get started with LumexUI quickly!

Prerequisites

Before you begin, ensure that you have the following:


  1. Install LumexUI

    Install LumexUI using the .NET CLI or NuGet Package Manager.

    Terminal
    › dotnet add package LumexUI
    
  2. Install Tailwind CSS

    LumexUI is built on top of Tailwind CSS. Start by following the official installation guide, then update the app’s CSS file.

    Note: The Tailwind standalone CLI is recommended if Node.js or npm are not required.

    app.css
    @import "tailwindcss";
    @import "../bin/lumexui/theme"; /* theme */
    
    @source "../bin/lumexui/*.cs"; /* styles */
    
  3. Configure startup file

    Add the necessary LumexUI services to Program.cs file.

    Program.cs
    using LumexUI.Extensions;
    
    // ...
    builder.Services.AddLumexServices();
    
  4. Include CSS and JS

    Add the static files to the <head> and <body> sections of the page.

    App.razor
    <!DOCTYPE html>
    <html>
    <head>
        <meta charset="utf-8" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <link href="app.css" rel="stylesheet" />
    </head>
    <body>
        <script src="_content/LumexUI/js/LumexUI.js" type="module"></script>
        <!-- Other scripts -->
    </body>
    </html>
    
  5. Start using LumexUI

    All set! Begin integrating and using LumexUI components throughout the project.

    Component.razor
    @using LumexUI
        
    <LumexButton>Click me</LumexButton>
    
An unhandled error has occurred. Reload 🗙