Alquimia Documentation
  • Welcome To Alquimia
  • Architecture
  • Operational Handler
  • Alquimia Runtime Helm Chart
  • UI SDK
    • Alquimia-AI Tools
      • Summary
      • getting-started
        • Getting Started with Alquimia Tools
    • Alquimia-AI UI
      • Summary
      • api-reference
        • API Types Reference
      • components
        • Atom Components
        • Molecules
        • Organism Components
        • Components Overview
      • examples
        • Examples
      • getting-started
        • Installation
      • styling
        • Styling Guide
        • Using Custom Themes with Tailwind CSS
    • Alquimia AI Widget
Powered by GitBook
On this page
  • Overview
  • Key Features
  • Quick Links
  • Installation and quick start
  • Package Structure
  • Styling System
  • Component Standards
  • Documentation Sections
  • Related Links
  • License
  1. UI SDK

Alquimia-AI UI

Library with UI elements built with React, TailwindCSS, and ShadCN. This library follows the Atomic Design methodology to help you create modular and reusable components for Alquimia AI products.

Overview

Alquimia UI provides a comprehensive set of React components designed for building web applications. Built with TypeScript and following best practices, it offers a flexible and maintainable solution for building Alquimia AI assistants.

Key Features

  • 🎨 Atomic Design Structure

    • Atoms: Basic building blocks (buttons, inputs, etc.)

    • Molecules: Compound components

    • Organisms: Complex UI patterns

    • Templates: Page-level layouts

  • 🛠️ Tech Stack

    • React 18+

    • TypeScript

    • Tailwind CSS

    • Radix UI Primitives

  • 📦 Component Architecture

    • Built on shadcn/ui standards

    • Fully typed components

    • Easily integrate into any React or Next.js project.

  • 🎯 Other Features

    • Rich text components

    • Document viewers (PDF, Plain Text)

    • Custom hooks

    • Utility functions

Quick Links

Installation and quick start

# Using npm
npm install @alquimia-ai/ui

# Using yarn
yarn add @alquimia-ai/ui

# Using pnpm
pnpm add @alquimia-ai/ui

To use the components, you need to configure your Tailwind CSS configuration file.

// tailwind.config.js

const baseConfig = require("@alquimia-ai/ui/tailwind.config")

module.exports = {
  content: [
    // Your code
    ...baseConfig.content,
  ],
  theme: {
    extend: {
      // Your customizations
    }
  }
}

Basic usage:

import { Button } from "@alquimia-ai/ui/components/atoms"

const App = () => (
  <Button variant="default" size="lg">
    Click Me
  </Button>
);

export default App;

Package Structure

@alquimia-ai/ui/
├── components/
│   ├── atoms/
│   ├── molecules/
│   ├── organisms/
│   └── templates/
├── hooks/
├── utils/
└── types/

Styling System

Alquimia UI is built on top of Tailwind CSS, providing:

  • Utility-first styling approach

  • Customizable design tokens and classes

  • Responsive design utilities

  • Custom component classNames

Component Standards

Built following shadcn/ui principles:

  • Style with CSS variables

  • Accessible/customizable semantic components

Documentation Sections

Related Links

License


PreviousGetting Started with Alquimia ToolsNextSummary

Last updated 4 months ago

MIT ©

Getting Started
Components
Styling
API Reference
Installation & Setup
Component Library
Atoms
Molecules
Organisms
Styling Guide
API Reference
Types
Alquimia AI Website
Alquimia AI Docs
Radix UI
TailwindCSS
ShadCN
Alquimia AI
Next: Getting Started →