From b9bcddaa12b7e4cf86c69949b5547da12e5f42f0 Mon Sep 17 00:00:00 2001 From: natxocc Date: Tue, 31 Mar 2026 16:34:52 +0200 Subject: [PATCH] Update docs --- docs/ui/quick.md | 56 ++++++++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/docs/ui/quick.md b/docs/ui/quick.md index b980fd0..c8c8265 100644 --- a/docs/ui/quick.md +++ b/docs/ui/quick.md @@ -1,28 +1,23 @@ - # UI Components `(WIP)` -> **Status: Work In Progress.** > These are high-level, complex visual components designed to speed up development. They replace native HTML elements with "superpowered" versions that handle their own internal logic, reactivity, and professional styling. +> **Status: Work In Progress.** +> SigPro UI is a complete component environment built with SigPro, Tailwind CSS and DaisyUI. It provides smart components that handle their own internal logic, reactivity, and professional styling.
-

⚠️ Prerequisites

-

- To ensure all components render correctly with their reactive themes and states, your project must have the following versions installed: +

📢 Official Documentation

+

+ All official documentation, interactive examples, and usage guides are available at:

-
    -
  • - v4+ - Tailwind CSS -
    • -
  • - v5+ - DaisyUI -
    • -
+
+ + https://natxocc.github.io/sigpro-ui/#/ + +

- * Earlier versions might cause unexpected styling issues with SigPro UI components. + * Documentation is actively being updated as components are released.

@@ -37,11 +32,28 @@ Unlike **Tag Helpers** (which are just functional mirrors of HTML tags), SigPro * **Stateful**: They manage complex internal states (like date ranges, search filtering, or API lifecycles). * **Reactive**: Attributes prefixed with `$` are automatically tracked via `$watch`. * **Self-Sane**: They automatically use `._cleanups` to destroy observers or event listeners when removed from the DOM. -* **Themed**: Fully compatible with the DaisyUI v5 theme system and Tailwind v4 utility classes. +* **Themed**: Fully compatible with DaisyUI v5 theme system and Tailwind v4 utility classes. --- -## 2. The UI Registry (Available Now) +## 2. Prerequisites + +
+
+ +
+

To ensure all components render correctly, your project must have:

+
    +
  • Tailwind CSS v4+
    • +
  • DaisyUI v5+
    • +
+
+
+
+ +--- + +## 3. The UI Registry (Available Now) | Category | Components | | :--- | :--- | @@ -52,7 +64,7 @@ Unlike **Tag Helpers** (which are just functional mirrors of HTML tags), SigPro --- -## 3. Examples with "Superpowers" +## 4. Examples with "Superpowers" ### A. The Declarative API Flow (`Request` & `Response`) Instead of manually managing `loading` and `error` flags, use these together to handle data fetching elegantly. @@ -123,7 +135,7 @@ Modal({ --- -## 4. Internationalization (i18n) +## 5. Internationalization (i18n) The UI library comes with a built-in locale system. @@ -133,6 +145,4 @@ Locale("en"); // Access translated strings (Returns a signal that tracks the current locale) const t = tt("confirm"); -``` - - +``` \ No newline at end of file