modGallery

R Package Versionlint codecov R-CMD-check test-coverage

Note for Agents & Developers

  1. First visit this link to review organization-wide general guidance: Organization Agents Guide
  2. Next review AGENTS.md in this repository for repo-specific guidance: Repository Agents Guidance
  3. Additional notes and general R package guidance can be found below in this README.md file.

Setup Development Environment

To setup the dev & test environment for this package, see script found here: Setup Script

Overview

modGallery is a Shiny module for the Artalytics platform that provides an interactive gallery display for digital artwork. It features artwork verification, NFT integration, 3D statistics visualization, and responsive Bootstrap 5 design.

Bootstrap 5 Migration (v0.8.9+)

As of version 0.8.9, modGallery has been fully migrated from bs4Dash to Bootstrap 5 using the bslib package. This provides:

  • Modern, responsive UI components
  • Enhanced dark mode support
  • Better performance and accessibility
  • Consistent styling across all browsers

Migration Notes for Developers

If you’re upgrading from an earlier version:

  1. Dependencies: The package now requires bslib >= 0.9.0 instead of bs4Dash
  2. CSS Classes: All Bootstrap 4 classes have been updated to Bootstrap 5 equivalents
  3. JavaScript: Component initialization now uses Bootstrap 5 APIs
  4. Styling: Custom CSS has been updated in inst/css/modGallery-bootstrap5-fixes.css

Key Features

  • Artwork Display: High-quality image display with variant navigation
  • NFT Integration: OpenSea badge display for NFT artworks
  • 3D Statistics: Interactive 3D visualization of artwork metrics
  • Responsive Design: Mobile-optimized layout with Bootstrap 5
  • Dark Mode: Full dark mode support with automatic theme detection
  • Accessibility: ARIA labels and keyboard navigation support

Installation 

# Install from GitHub
remotes::install_github("artalytics/modGallery")

Usage 

library(modGallery)

# In your Shiny app UI
modGalleryUI("gallery")

# In your Shiny app server
modGalleryServer("gallery", reactive_data)

Testing

Run the test suite:

devtools::test()

Run specific Bootstrap 5 migration tests:

devtools::test(filter = "bootstrap5")

Documentation

For detailed changes, see the NEWS.md file.

Proprietary - Do Not Distribute