Skip to contents

Notes for Agents and Developers

Source: AGENTS.md

This file contains guidance targeted for this repository. Notes here should follow organization guidance (see here).

Package Purpose

artshiny provides shared Shiny UI components and helpers for the Artalytics platform. This package centralizes common interface patterns to:

  • Maintain visual consistency across app modules
  • Reduce code duplication
  • Provide tested, reusable UI components
  • Simplify cross-module UI updates

Architecture

This is a Core layer package that: - Provides UI infrastructure components - Can be depended upon by Tools and Apps layers - Should NOT contain business logic or data operations - Should remain lightweight and focused on UI patterns

Components

Statistics Box Module (statsBoxUI, statsBoxServer)

  • Reusable module for displaying metric cards
  • Customizable icons and values
  • Used across: modGallery, modBrowse, modUpload, appPlatform

Loading Screens (wait_art_html, wait_art_spinner)

  • Artwork-themed loading animations
  • CDN-hosted GIF assets
  • Integrates with waiter package

Development Guidelines

  1. Keep components generic - No business logic
  2. Document all parameters - Include roxygen2 examples
  3. Test UI rendering - Use shinytest2 for visual regression
  4. Minimize dependencies - Only shiny, bslib, waiter, artcore
  5. Follow naming convention - [component]UI() and [component]Server() for modules

Repo Files

  • setup-env.sh - This file should contain a minimal install script to setup the dev/test environment for only this package.
  • Dockerfile - This file should be used to build the image containing the dev/test environment for only this package.

Task Items

    • wait_art_html() usage and parameters
    • create_waiter() factory function usage
    • UI-side setup (waiter_preloader, useWaiter, useSteward)
    • Server-side patterns (show/hide, update with messages)
    • Cross-module consistency guidelines