Skip to content

kush1nado/rell-ui

BranchesTags

Repository files navigation

Rell UI

Universal UI framework built with Web Components. Framework-agnostic and dependency-free.

Features

  • Web Components - Works with any framework or vanilla JavaScript
  • Design Tokens - Centralized design system with CSS custom properties
  • Storybook - Interactive component documentation
  • Zero Dependencies - Pure native Web Components
  • Dark Theme - Modern dark theme with vibrant accents

Installation

npm install rell-ui

For detailed installation and setup instructions, see Getting Started Guide.

Development

# Start Storybook
npm run storybook

# Build library
npm run build

Components

Form Components

  • Typography - Typography system with multiple variants
  • Button - Button component with multiple variants and sizes
  • Input - Text input fields with validation states
  • Select - Dropdown select component with single and multiple selection modes
  • Checkbox - Checkbox component with group support
  • Radio - Radio button component with group support
  • Switch - Toggle switch component with group support
  • Form - Form wrapper with validation and data collection
  • DatePicker - Date picker with calendar interface
  • DateRangePicker - Date range picker with two-step selection
  • Search - Search input with clearable and loading states
  • Autocomplete - Autocomplete input with suggestions
  • Slider - Range slider with marks and value display
  • Rating - Star rating component with half-star support
  • FileUpload - File upload component with drag & drop support
  • Calendar - Calendar component with date selection, range, and multiple selection modes

Layout Components

  • Container - Container component with max-width and padding
  • Row - Flex row container for layout
  • Col - Column component with grid system (1-12 columns)
  • Grid - CSS Grid layout component
  • Stack - Flexible stack layout component
  • Center - Centering component for content
  • Box - Generic container with styling options
  • Spacer - Flexible spacing component
  • Header - Page header component
  • Body - Page body component
  • Footer - Page footer component
  • Navbar - Navigation bar component
  • Drawer - Side drawer component
  • SplitPane - Split pane component for resizable layouts
  • Resizable - Resizable container component

Data Display Components

  • Card - Card component with header and footer slots
  • Badge - Badge component with variants and sizes
  • Avatar - Avatar component with fallback support
  • Image - Image component with lazy loading and fallback
  • Svg - SVG icon component with built-in icons
  • Alert - Alert component for static messages
  • Notification - Toast notification component
  • Breadcrumbs - Breadcrumb navigation component
  • Tabs - Tab navigation component
  • Stepper - Step-by-step progress component
  • Divider - Divider component with orientation and label
  • Tree - Tree view component with expandable nodes
  • Item - List item component with slots for icon, title, description, and action
  • ItemList - List container with drag and drop support
  • Progress - Progress bar component with multiple variants
  • Skeleton - Skeleton loading component
  • Chip - Chip component for tags and labels
  • Link - Link component with variants
  • Accordion - Accordion component with collapsible sections
  • Table - Table component with rows and cells
  • VirtualTable - Virtualized table component for large datasets
  • Toolbar - Toolbar component for actions
  • Timeline - Timeline component with vertical and horizontal layouts
  • Carousel - Carousel component with slides
  • ColorPicker - Color picker component
  • EmptyState - Empty state component for empty data
  • Watermark - Watermark component with text, pattern, and grid modes
  • QRCode - QR code generator component
  • Popconfirm - Confirmation popup component

Navigation Components

  • Pagination - Pagination component for server-side and client-side pagination
  • ButtonGroup - Button group component
  • ToggleButton - Toggle button component
  • Menu - Menu component with items and dividers
  • SegmentedControl - Segmented control component
  • SplitButton - Split button component with dropdown

Overlay Components

  • Backdrop - Backdrop component for overlays
  • Dialog - Dialog component for modal dialogs
  • Modal - Modal component for full-screen overlays
  • Tooltip - Tooltip component for hints
  • Popover - Popover component for contextual information
  • Dropdown - Dropdown component for selectable options
  • ContextMenu - Context menu component for right-click menus

Usage

Basic HTML

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="node_modules/rell-ui/dist/tokens/theme.css">
  <script type="module" src="node_modules/rell-ui/dist/index.js"></script>
</head>
<body>
  <rell-container>
    <rell-breadcrumbs>
      <a href="#home">Home</a>
      <span>Page</span>
    </rell-breadcrumbs>
    
    <rell-typography variant="h1">Hello World</rell-typography>
    
    <rell-row gap="1rem">
      <rell-col span="8">
        <rell-input placeholder="Enter text..."></rell-input>
      </rell-col>
      <rell-col span="4">
        <rell-button variant="primary">Click me</rell-button>
      </rell-col>
    </rell-row>
  </rell-container>
</body>
</html>

React

import 'rell-ui/dist/index.js';
import 'rell-ui/theme.css';

function App() {
  return (
    <>
      <rell-typography variant="h1">Hello React</rell-typography>
      <rell-button variant="primary">Click me</rell-button>
    </>
  );
}

Vue

<template>
  <rell-typography variant="h1">Hello Vue</rell-typography>
  <rell-button variant="primary">Click me</rell-button>
</template>

<script setup>
import 'rell-ui/dist/index.js';
import 'rell-ui/theme.css';
</script>

Design Tokens

The library uses a comprehensive design token system for colors, typography, spacing, shadows, and border radius. All tokens are available as CSS custom properties and can be overridden.

Colors

/* Background colors */
--rell-bg-primary: #0a0a0f;
--rell-bg-secondary: #12121a;
--rell-bg-tertiary: #1a1a24;

/* Text colors */
--rell-text-primary: #e0e0e8;
--rell-text-secondary: #a0a0b0;
--rell-text-tertiary: #707080;
--rell-text-inverse: #ffffff;

/* Accent colors */
--rell-accent-cyan: #00ffff;
--rell-accent-magenta: #ff00ff;
--rell-accent-yellow: #ffff00;

/* Interactive colors */
--rell-interactive-primary: #00ffff;
--rell-interactive-primary-hover: #00cccc;
--rell-interactive-primary-active: #009999;

/* Status colors */
--rell-success: #00ff88;
--rell-warning: #ffaa00;
--rell-error: #ff4444;
--rell-info: #00aaff;

Typography

/* Font families */
--rell-font-sans: "Inter", "SF Pro Display", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
--rell-font-mono: "JetBrains Mono", "Fira Code", "Consolas", monospace;

/* Font sizes */
--rell-font-size-xs: 0.75rem;
--rell-font-size-sm: 0.875rem;
--rell-font-size-base: 1rem;
--rell-font-size-lg: 1.125rem;
--rell-font-size-xl: 1.25rem;
--rell-font-size-2xl: 1.5rem;
--rell-font-size-3xl: 1.875rem;
--rell-font-size-4xl: 2.25rem;

Spacing

--rell-spacing-0: 0;
--rell-spacing-1: 0.25rem;
--rell-spacing-2: 0.5rem;
--rell-spacing-3: 0.75rem;
--rell-spacing-4: 1rem;
--rell-spacing-5: 1.25rem;
--rell-spacing-6: 1.5rem;
--rell-spacing-8: 2rem;
--rell-spacing-10: 2.5rem;
--rell-spacing-12: 3rem;
--rell-spacing-16: 4rem;
--rell-spacing-20: 5rem;
--rell-spacing-24: 6rem;

Border Radius

--rell-radius-none: 0;
--rell-radius-sm: 0.25rem;
--rell-radius-md: 0.5rem;
--rell-radius-lg: 0.75rem;
--rell-radius-xl: 1rem;
--rell-radius-full: 9999px;

Shadows

--rell-shadow-sm: 0 1px 2px rgba(0, 0, 0, 0.1);
--rell-shadow-md: 0 4px 6px rgba(0, 0, 0, 0.1);
--rell-shadow-lg: 0 10px 15px rgba(0, 0, 0, 0.1);
--rell-shadow-xl: 0 20px 25px rgba(0, 0, 0, 0.15);
--rell-shadow-cyan: 0 0 20px rgba(0, 255, 255, 0.3);
--rell-shadow-magenta: 0 0 20px rgba(255, 0, 255, 0.3);

For complete theming guide, see Styling & Theming Documentation.

Component API

Typography

<rell-typography 
  variant="h1|h2|h3|h4|h5|h6|body|caption|small"
  color="primary|secondary|tertiary|accent|success|warning|error|info"
  weight="light|normal|medium|semibold|bold|extrabold"
  align="left|center|right|justify"
  font-family="sans|mono">
  Text content
</rell-typography>

Button

<rell-button 
  variant="primary|secondary|outline|ghost"
  size="sm|md|lg"
  disabled
  full-width>
  Button text
</rell-button>

Input

<rell-input 
  type="text|email|password|number|tel|url|search"
  placeholder="Placeholder text"
  value="Initial value"
  size="sm|md|lg"
  disabled
  error>
</rell-input>

Select

<!-- Single select -->
<rell-select 
  value="selected-value"
  size="sm|md|lg"
  disabled
  error>
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</rell-select>

<!-- Multiple select -->
<rell-select 
  multiple
  value='["1","2"]'
  placeholder="Select options...">
  <option value="1">Option 1</option>
  <option value="2">Option 2</option>
</rell-select>

Item and ItemList

<!-- Draggable list -->
<rell-item-list draggable variant="outlined">
  <rell-item data-id="1" clickable>
    <span slot="title">First Item</span>
    <span slot="description">Description text</span>
  </rell-item>
  <rell-item data-id="2" clickable>
    <span slot="title">Second Item</span>
  </rell-item>
</rell-item-list>

<script>
  const list = document.querySelector('rell-item-list');
  
  // Get current order
  const order = list.getOrder(); // ['1', '2']
  
  // Set order programmatically
  list.setOrder(['2', '1']);
  
  // Listen for order changes
  list.addEventListener('order-changed', (e) => {
    console.log('New order:', e.detail.order);
  });
</script>

Form

<rell-form>
  <rell-input name="email" type="email" required></rell-input>
  <rell-input name="password" type="password" required></rell-input>
  <rell-button type="submit">Submit</rell-button>
</rell-form>

<script>
  const form = document.querySelector('rell-form');
  
  // Get form data
  const data = form.getFormDataAsObject();
  
  // Validate form
  const isValid = form.validate();
  
  // Reset form
  form.reset();
</script>

DatePicker

<rell-date-picker 
  value="2024-01-15"
  format="YYYY-MM-DD"
  placeholder="Select date"
  min-date="2024-01-01"
  max-date="2024-12-31">
</rell-date-picker>

Pagination

<!-- Client-side pagination -->
<rell-pagination 
  current="1"
  total="100"
  page-size="10"
  mode="client">
</rell-pagination>

<!-- Server-side pagination -->
<rell-pagination 
  current="1"
  total="1000"
  page-size="20"
  mode="server">
</rell-pagination>

FileUpload

<rell-file-upload 
  accept="image/*"
  multiple
  max-size="1048576">
</rell-file-upload>

<script>
  const upload = document.querySelector('rell-file-upload');
  upload.addEventListener('files-changed', (e) => {
    console.log('Files:', e.detail.files);
  });
  
  // Get files
  const files = upload.getFiles();
  
  // Clear files
  upload.clearFiles();
</script>

Calendar

<!-- Single date selection -->
<rell-calendar value="2024-01-15"></rell-calendar>

<!-- Multiple date selection -->
<rell-calendar multiple></rell-calendar>

<!-- Date range selection -->
<rell-calendar range></rell-calendar>

<script>
  const calendar = document.querySelector('rell-calendar');
  calendar.addEventListener('change', (e) => {
    console.log('Selected dates:', e.detail);
  });
</script>

Popconfirm

<rell-popconfirm 
  title="Удалить элемент?"
  description="Это действие нельзя отменить."
  confirm-text="Удалить"
  cancel-text="Отмена"
  variant="danger">
  <rell-button slot="trigger" variant="danger">Удалить</rell-button>
</rell-popconfirm>

<script>
  const popconfirm = document.querySelector('rell-popconfirm');
  popconfirm.addEventListener('confirm', () => {
    console.log('Confirmed!');
  });
  popconfirm.addEventListener('cancel', () => {
    console.log('Cancelled!');
  });
</script>

Watermark

<rell-watermark 
  text="CONFIDENTIAL"
  opacity="0.15"
  font-size="24px"
  rotate="-45">
  <div>Your content here</div>
</rell-watermark>

QRCode

<rell-qrcode 
  value="https://example.com"
  size="200"
  color="#000000"
  background="#ffffff">
</rell-qrcode>

<script>
  const qrcode = document.querySelector('rell-qrcode');
  
  // Get data URL
  const dataURL = qrcode.getDataURL();
  
  // Download QR code
  qrcode.download('qrcode.png');
</script>

Events

All components dispatch standard DOM events:

const button = document.querySelector('rell-button');
button.addEventListener('click', (e) => {
  console.log('Button clicked');
});

const input = document.querySelector('rell-input');
input.addEventListener('input', (e) => {
  console.log('Input value:', e.detail.value);
});

const select = document.querySelector('rell-select');
select.addEventListener('change', (e) => {
  console.log('Selected value:', e.detail.value);
});

const itemList = document.querySelector('rell-item-list');
itemList.addEventListener('order-changed', (e) => {
  console.log('Order changed:', e.detail.order);
});

Common Use Cases

Building a Dashboard

<rell-container>
  <rell-header>
    <rell-navbar>
      <rell-typography variant="h2">Dashboard</rell-typography>
      <rell-menu orientation="horizontal">
        <rell-menu-item active>Overview</rell-menu-item>
        <rell-menu-item>Analytics</rell-menu-item>
        <rell-menu-item>Settings</rell-menu-item>
      </rell-menu>
    </rell-navbar>
  </rell-header>

  <rell-body>
    <rell-row gap="1rem">
      <rell-col span="3">
        <rell-card>
          <rell-typography variant="h4">Total Users</rell-typography>
          <rell-typography variant="h2">1,234</rell-typography>
        </rell-card>
      </rell-col>
      <rell-col span="9">
        <rell-card>
          <div slot="header">
            <rell-typography variant="h3">Recent Activity</rell-typography>
          </div>
          <rell-table>
            <!-- Table content -->
          </rell-table>
        </rell-card>
      </rell-col>
    </rell-row>
  </rell-body>
</rell-container>

Creating a Form with Validation

<rell-form>
  <rell-input 
    name="email" 
    type="email" 
    required
    validate-on="blur"
    error-message="Please enter a valid email">
  </rell-input>
  <rell-button type="submit" variant="primary">Submit</rell-button>
</rell-form>

Modal with Confirmation

<rell-popconfirm 
  title="Delete item?"
  description="This action cannot be undone."
  variant="danger">
  <rell-button slot="trigger" variant="danger">Delete</rell-button>
</rell-popconfirm>

Documentation

Storybook

Interactive component documentation and examples are available in Storybook:

npm run storybook

Visit http://localhost:6006 to explore all components.

License

MIT

About

UI Library in dark cyberpunk colors

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages