crystal/docs/theme/ui-pattern-audit.md
eshaffer321 ab3f8355d7
feat: Comprehensive theme system and UI improvements (#125)
* What else would you change for the theme?

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Can you think outside the box?

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* So it works for about a second... but not exact...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Can you make it more like... I'm not sure if th...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Can we have it rotate a little slower or maybe ...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Let's add just slightly more jitter I think tha...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Can you help refine the visual layout of the me...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* This is just a test message for crystal you can...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* For some reason this messages markdown didn't r...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* I don't know what you just changed but that did...

馃 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* feat: Add navigation-specific design tokens and fix sidebar token usage

- Add semantic navigation surface tokens for sidebar (surface-navigation-*)
- Add context-aware text tokens for navigation (text-navigation-*)
- Add border and divider tokens for navigation structure
- Fix SessionListItem to use proper surface-hover tokens
- Configure Tailwind utilities for new navigation tokens
- Make TokenTest component dev-only with Cmd+Shift+T shortcut
- Complete light mode token refactoring with lilac brand colors
- Document navigation token system with implementation guide

* feat: major UI refactors

* WIP: UI updates to SessionHeader and ViewTabs

* fix: TypeScript build errors after merge

- Add missing type definitions (allowClaudeTools, helperText, icon props)
- Fix Badge component to support 'primary' variant
- Update Toggle component to support pressed state and children
- Remove unused imports and parameters
- Fix GitCommands interface to include optional command methods
- Correct Dropdown position type usage
- Fix case sensitivity issue with CommitMode comparison

* fix: Restore thinking messages in RichOutputView

- Add getJsonMessages API endpoint to access raw JSON messages
- Update RichOutputView to use structured JSON data instead of formatted stdout
- Add debugging logs to track message processing
- The issue was that thinking blocks were being converted to formatted text
  instead of being preserved as structured data for the rich output view

* fix: Convert ProjectView to use token-based design system

- Replace all hardcoded gray/blue colors with design tokens
- Update tabs to use bg-surface-secondary and text-text-primary
- Convert git buttons to use semantic status colors (info/success)
- Update loading states to use border-interactive
- Fix terminal header and clear button styling
- Ensure consistent hover and disabled states using tokens

All hardcoded colors in ProjectView now use the centralized token system.

* Improve context compaction UX with clear visual feedback

Previously, context compaction was confusing - users didn't understand they could continue chatting in the same window after compacting. This commit addresses these issues:

Changes:
- Remove toast notifications in favor of inline feedback
- Add context compaction message to rich output view with clear instructions
- Show "Context Ready" indicator in input area when context is compacted
- Update terminal messages to be clearer about next steps
- Fix status indicator colors (stopped sessions now show gray, not green)
- Convert context compaction from Toggle to regular button for consistency

The new flow makes it obvious that users can just type their next message and the compacted context will be automatically included - no need to start a new session.

Key improvements:
- Rich output shows a formatted "Context Compacted" card with the summary and instructions
- Input area shows a pulsing "Context Ready" badge as a visual reminder
- All messaging emphasizes "just type your next message" instead of technical jargon
- Consistent button styling across the UI

This creates a much clearer experience where context compaction "just works" without confusion.

* Redesign rich output settings panel for clarity and consistency

The settings panel was confusing with mixed "Show/Hide" terminology and inconsistent styling. This redesign addresses these UX issues:

Changes:
- Replace confusing checkboxes with clear switch toggles
- Organize settings into logical groups: "Content Display" and "Layout & Behavior"
- Use descriptive labels instead of "Show/Hide" terminology
- Add helpful descriptions under each setting explaining what it does
- Use consistent design tokens throughout (SwitchSimple component)
- Style the settings button to match other UI elements
- Add icons to each setting for better visual scanning

The new design eliminates cognitive overhead by:
- Using positive framing ("Tool Calls" instead of "Show Tool Calls")
- Providing context with descriptions ("Display Claude's tool usage")
- Grouping related settings together
- Using familiar switch toggles that clearly show on/off state

This creates a much cleaner, more intuitive settings experience that fits seamlessly with the overall design system.

* Convert rich output settings to floating dropdown panel

The settings panel was taking up valuable vertical space and pushing content down. This redesign makes it a floating dropdown that overlays the content:

Changes:
- Move settings button to the right side of the header bar
- Convert settings panel to a floating dropdown that doesn't affect layout
- Add backdrop to close settings when clicking outside
- Compact the design with smaller icons and no descriptions
- Group settings into "Content" and "Layout" sections
- Add hover states for each setting row
- Add subtle fade-in animation for the dropdown
- Simplify button text from "Display Options" to just "Display"

The new design:
- Preserves all vertical space for actual content
- Is more accessible as a quick toggle without disrupting reading flow
- Maintains all the clarity improvements from the previous redesign
- Feels more integrated with the overall UI pattern

This creates a much cleaner experience where settings are easily accessible but don't interfere with content consumption.

* fix: Move Rich Output settings button to tab area to avoid extra vertical header

- Moved settings button from separate header bar into ViewTabs component
- Settings button now only appears when Rich Output view is active
- Maintained floating dropdown panel for settings
- Passed settings state management up to SessionView component
- Updated RichOutputView to accept settings as props for better control
- Eliminated extra vertical space by removing dedicated settings header

* fix: Remove extra header bar and improve Rich Output settings UX

- Removed the message count header bar completely to save vertical space
- Moved settings dropdown position closer to the button (top-12 instead of top-[120px])
- Added 'Display Settings' label next to gear icon for clarity
- Made button larger with proper padding and text label
- Added more descriptive tooltip for the settings button

* fix: Improve Rich Output settings dropdown positioning

- Fixed dropdown position to appear closer to the settings button (top-[165px])
- Created separate RichOutputSettingsPanel component for better modularity
- Moved settings panel rendering to SessionView for cleaner architecture
- Settings panel now renders from SessionView instead of RichOutputView
- Maintains all existing functionality with better positioning

* fix: Resolve duplicate settings panels and improve positioning

- Remove duplicate settings panels that appeared when clicking Rich Output display settings
- Consolidate settings panel rendering to SessionView only
- Clean up unused props and imports from RichOutputView and RichOutputWithSidebar
- Improve settings panel positioning to appear below the button instead of over it
- Simplify onSettingsClick handler logic by removing redundant viewMode check

The settings panel is now properly managed at the SessionView level with a single
panel appearing when the Display Settings button is clicked in Rich Output view.

* feat: Remove legacy output view and make rich output the default

- Remove the regular terminal-based output view tab
- Rename "Rich Output" tab to simply "Output" since it's now the only option
- Set 'richOutput' as the default view mode for new sessions
- Clean up ViewMode type definition to remove 'output' option
- Remove terminal rendering and associated functionality from SessionView
- Update all component interfaces to remove 'output' unread activity tracking
- Disable unused terminal writing effects that were specific to the old output view
- Update ProjectView to use 'richOutput' mode
- Remove unused imports and cleanup code

This provides a cleaner, more focused user experience with rich formatting,
syntax highlighting, and interactive elements as the primary output method.

* feat: Refactor project modals with enhanced design system

- Create new reusable UI components (EnhancedInput, FieldWithTooltip, Tooltip)
- Refactor Add New Project modal with 3 clear sections and tooltips
- Refactor Project Settings modal with improved visual hierarchy
- Add consistent spacing, larger inputs, and better form organization
- Replace inline help text with tooltip icons for cleaner interface
- Enhance validation feedback and design token compliance
- Support both DraggableProjectTreeView and ProjectSelector modals

* fix: Make terminal and Monaco editor properly theme-aware

- Fixed terminal theme switching between light/dark modes
- Added RGB to hex color conversion for xterm.js compatibility
- Fixed Monaco editor theme switching using built-in vs/vs-dark themes
- Improved theme class management (now properly adds/removes both dark and light classes)
- Made terminal colors consistent using explicit RGB values
- Added initial theme class to prevent flash of incorrect theme on load

* feat: Improve dark mode UI with subtle borders and shadows

## Summary
- Refine dark mode aesthetics by reducing harsh white strokes and borders
- Fix missing cn utility causing build failures across components
- Update pill badges and UI elements to use more subtle styling

## Key Changes

### Dark Mode Border Improvements
- Update primary borders from gray-700 to gray-750 for better contrast
- Reduce border opacity in Badge components for softer appearance
- Make Dropdown rings more subtle in dark mode

### Shadow and Effect Refinements
- Replace harsh shadow-tactile effects with subtle shadow-sm/shadow-md
- Update Pill component styling to use gentler shadows
- Improve SessionListItem active state with balanced ring opacity

### Technical Fixes
- Add missing cn utility with clsx and tailwind-merge integration
- Fix TypeScript build errors across all UI components
- Install required dependencies (clsx, tailwind-merge)

## Impact
Resolves harsh "halo effect" around pill badges and bordered elements in dark mode while maintaining proper visual hierarchy and design token consistency.

* fix: Resolve post-rebase issues with Rich Output and Dashboard views

- Fix RichOutputView undefined variable error (jsonResponse -> outputResponse)
- Add missing Dashboard view rendering in SessionView with correct project ID
- Enhance thinking message detection with fallback content fields
- Clean up debug logging from development
- Restore proper data flow for JSON messages in Rich Output view

Fixes issues that emerged after rebasing theme-audit branch onto main.

* fix: Resolve TypeScript errors and build issues after rebase

- Add missing Input import in ProjectSettings.tsx
- Remove unused Button and Card imports from SessionView.tsx
- Add missing props to SessionHeaderProps interface (isOpeningIDE, hasIdeCommand)
- Fix ProjectDashboard props to use projectName instead of sessionId
- Enhance IDE button with loading state and command validation
- All type checks and builds now pass successfully

Fixes CI failures introduced during the rebase process.

---------

Co-authored-by: Erick Shaffer <erick.shaffer@meraki.net>
Co-authored-by: Claude <noreply@anthropic.com>
2025-07-27 12:54:49 -04:00

6.3 KiB

Crystal UI Pattern Audit

Overview

This audit analyzes the Crystal codebase for UI patterns and Tailwind CSS usage inconsistencies across 49 React components in the frontend directory.

1. Button Patterns

Common Button Styles Found

Primary Buttons

  • Blue Primary: bg-blue-600 hover:bg-blue-700 text-white
    • Used in: CreateSessionButton, various dialogs
    • Example: "New Session" button

Secondary/Ghost Buttons

  • Gray Secondary: bg-gray-100 dark:bg-gray-700 text-gray-700 dark:text-gray-300
    • Used in: Settings, ProjectSettings
    • Example: "Browse" buttons

Icon Buttons

  • Icon Only: text-gray-600 dark:text-gray-400 hover:text-gray-900 dark:hover:text-gray-300
    • Used in: Close buttons in dialogs
    • Example: X close buttons

Danger Buttons

  • Red Danger: bg-red-600 hover:bg-red-700 text-white
    • Used in: Delete confirmations

Success Buttons

  • Green Success: bg-green-600 hover:bg-green-700 text-white
    • Used in: GitErrorDialog

Inconsistencies

  1. Border Radius: Mix of rounded-md, rounded-lg, rounded-full
  2. Padding: Varies between px-4 py-2, px-3 py-1.5, px-3 py-2
  3. Font Weight: Some use font-medium, others font-semibold, many none
  4. Transition: Some buttons have transition-colors, others don't
  5. Focus States: Inconsistent focus rings

2. Card/Panel Patterns

Common Card Styles

Standard Card

bg-white dark:bg-gray-800 rounded-lg border border-gray-200 dark:border-gray-700
  • Used in: Settings, ProjectSettings, dialogs

Nested/Secondary Card

bg-gray-100 dark:bg-gray-900 rounded-md border border-gray-300 dark:border-gray-700
  • Used in: Form sections, code blocks

Inconsistencies

  1. Border Radius: Mix of rounded-lg, rounded-md, rounded
  2. Shadow: Some cards have shadows, others don't
  3. Padding: Varies from p-4 to p-6

3. Modal/Dialog Patterns

Standard Dialog Structure

<div className="fixed inset-0 bg-black bg-opacity-50 flex items-center justify-center z-50">
  <div className="bg-white dark:bg-gray-800 rounded-lg w-full max-w-2xl max-h-[90vh] overflow-hidden flex flex-col border border-gray-200 dark:border-gray-700">
    {/* Header */}
    {/* Content */}
    {/* Footer */}
  </div>
</div>

Inconsistencies

  1. Max Width: Varies between max-w-lg, max-w-xl, max-w-2xl, max-w-3xl
  2. Overlay Opacity: Some use bg-opacity-50, others bg-opacity-60
  3. Z-index: Mostly z-50 but some variations

4. Form Element Patterns

Input Fields

w-full px-3 py-2 bg-white dark:bg-gray-900 border border-gray-300 dark:border-gray-700 rounded-md text-gray-900 dark:text-gray-200 focus:outline-none focus:border-blue-500

Textareas

Similar to inputs but with resize-none or custom resize behavior

Checkboxes

rounded border-gray-300 text-blue-600 focus:ring-blue-500

Inconsistencies

  1. Background: Some use dark:bg-gray-900, others dark:bg-gray-800
  2. Focus States: Mix of focus:border-blue-500 and focus:ring-2

5. Layout Patterns

Common Layouts

  • Flex Column: flex flex-col
  • Grid: Limited grid usage, mostly flex
  • Spacing: space-y-4, space-x-2 commonly used

Inconsistencies

  1. Gap vs Space: Mix of gap- utilities and space- utilities
  2. Container Width: Inconsistent max-width constraints

6. Spacing Patterns

Common Spacing

  • Padding: p-4, p-6, px-4 py-2, px-3 py-2
  • Margin: mb-4, mt-2, my-4
  • Gap: gap-2, gap-4, space-x-2, space-y-4

Inconsistencies

  1. No consistent spacing scale
  2. Mix of padding values for similar components

7. Border Radius Values

Found Values

  • rounded (0.25rem)
  • rounded-md (0.375rem)
  • rounded-lg (0.5rem)
  • rounded-full (9999px)

Usage

  • Buttons: Mix of all values
  • Cards: Mostly rounded-lg
  • Inputs: Mostly rounded-md

8. Shadow Patterns

Common Shadows

  • Cards: Often no shadow, sometimes shadow-lg
  • Dropdowns: shadow-lg
  • Modals: No shadow (uses overlay)

Inconsistencies

  1. Inconsistent shadow usage on similar components
  2. No standardized elevation system

9. Animation/Transition Patterns

Common Transitions

  • transition-colors - For hover states
  • transition-all - For general transitions
  • transition-transform - For transforms
  • duration-200 - Common duration

Animations

  • Limited custom animations
  • Status indicators use custom pulse animations

Recommendations

1. Create Reusable Button Component

interface ButtonProps {
  variant: 'primary' | 'secondary' | 'danger' | 'ghost';
  size: 'sm' | 'md' | 'lg';
  // ... other props
}

2. Standardize Card Component

interface CardProps {
  variant: 'default' | 'nested';
  padding: 'sm' | 'md' | 'lg';
  // ... other props
}

3. Create Modal Component

interface ModalProps {
  size: 'sm' | 'md' | 'lg' | 'xl';
  // ... other props
}

4. Design System Constants

const spacing = {
  xs: '0.5rem',  // 8px
  sm: '1rem',    // 16px
  md: '1.5rem',  // 24px
  lg: '2rem',    // 32px
  xl: '3rem',    // 48px
};

const borderRadius = {
  sm: '0.25rem',   // rounded
  md: '0.375rem',  // rounded-md
  lg: '0.5rem',    // rounded-lg
  full: '9999px',  // rounded-full
};

5. Standardize Dark Mode Patterns

  • Background: bg-white dark:bg-gray-800 (primary)
  • Nested: bg-gray-100 dark:bg-gray-900
  • Borders: border-gray-200 dark:border-gray-700
  • Text: text-gray-900 dark:text-gray-100

6. Focus State Standardization

  • Use consistent focus rings: focus:ring-2 focus:ring-blue-500 focus:ring-offset-2

7. Transition Standardization

  • Default: transition-colors duration-200
  • Complex: transition-all duration-200

Components Needing Most Attention

  1. Button implementations - 40+ different button styles found
  2. Dialog/Modal components - Each has unique implementation
  3. Form inputs - Inconsistent styling and focus states
  4. Card/Panel components - Mix of border radius and padding

Quick Wins

  1. Create a Button component to replace all button implementations
  2. Create a Card component for consistent containers
  3. Create a Dialog component for modals
  4. Standardize spacing scale across all components
  5. Create form component library (Input, Textarea, Select, Checkbox)