Paparazzi

If you experience or witness unacceptable behavior or have concerns regarding the community, report it by emailing codeofconduct@squareup.com. All reports are handled with discretion.

To ensure an effective review, please include the following in your report:

• Your contact information.
• Names (real, nicknames, or pseudonyms) of individuals involved and any witnesses.
• A detailed account of what occurred and whether the incident is ongoing.
• Links to any publicly available records (e.g., mailing list archives or public IRC logs).
• Any other helpful additional information.

It is recommended to use Git LFS to store snapshots. Follow these steps to set it up locally:

1. Install Git LFS: brew install git-lfs
2. Initialize: git lfs install --local
3. Track snapshots: git lfs track "**/snapshots/**/*.png"
4. Commit attributes: git add .gitattributes

To improve git checkout performance, you can run: git config lfs.setlockablereadonly false.

brew install git-lfs
git config core.hooksPath
git lfs install --local
git lfs track "**/snapshots/**/*.png"
git add .gitattributes
git config lfs.setlockablereadonly false

To use Paparazzi in your Android project, apply the plugin using either the buildscript block or the plugins DSL. Ensure mavenCentral() and google() are in your repositories.

// Using plugins DSL
plugins {
  id 'app.cash.paparazzi' version '2.0.0-alpha05'
}

// OR using buildscript
buildscript {
  repositories {
    mavenCentral()
    google()
  }
  dependencies {
    classpath 'app.cash.paparazzi:paparazzi-gradle-plugin:2.0.0-alpha05'
  }
}

apply plugin: 'app.cash.paparazzi'

Accessibility snapshots are rendered as a split view:

• Left Pane: The original UI.
• Right Pane: A color-coded legend.

Key characteristics:

• Legend Order: Matches the order a screen reader (TalkBack) surfaces elements (typically start-to-end, top-to-bottom).
• Color Coding: Each legend entry has a color badge that matches a colored rectangle overlaid on the UI element.
• Deterministic Colors: Colors are derived from a hash of the element's accessibility text, ensuring stability across runs.
• Font Scaling: Legend text does not scale with fontScale, ensuring consistent snapshot output.

Paparazzi does not set LocalInspectionMode globally to ensure snapshots represent true production output. If your Composable (like GoogleMap()) relies on LocalInspectionMode to show a preview-safe version, wrap it in a CompositionLocalProvider during your test.

 @Test
  fun inspectionModeView() {
    paparazzi.snapshot(
      CompositionLocalProvider(LocalInspectionMode provides true) {
        YourComposable()
      }
    )
  }

If you use Jetifier to migrate off Support libraries, add the following to your gradle.properties to prevent issues with bundled Android dependencies:

android.jetifier.ignorelist=android-base-common,common

When using AccessibilityRenderExtension, be aware of the following constraints:

• RenderingMode.SHRINK is not supported: Using this mode with the extension will throw an IllegalStateException.
• validateAccessibility is deprecated: The old validateAccessibility: Boolean parameter on Paparazzi (which used Android's LayoutValidator for contrast) cannot be used simultaneously with AccessibilityRenderExtension.

When taking screenshots of Lottie animations, you must force Lottie to run on the same thread to avoid exceptions. Set LottieTask.EXECUTOR to an executor that runs the Runnable immediately.

@Before
fun setup() {
    LottieTask.EXECUTOR = Executor(Runnable::run)
}

For JUnit 5, you must manually manage the Paparazzi lifecycle using @BeforeEach and @AfterEach. You need to call setup() with a TestName containing the package, class, and method names to ensure correct context.

lateinit var paparazzi: Paparazzi

@BeforeEach
fun setup(testInfo: TestInfo) {
  paparazzi = Paparazzi().apply {
    setup(
      testName = TestName(
        packageName = testInfo.testClass.get().`package`?.name.orEmpty(),
        className = testInfo.testClass.get().simpleName,
        methodName = testInfo.testMethod.get().name
      )
    )
  }
}

@AfterEach
fun tearDown() {
  paparazzi.teardown()
}

@Test
fun snapshot_example() {
  val view = paparazzi.inflate<TextView>(android.R.layout.simple_list_item_1).apply {
    text = "Hello Paparazzi"
    textSize = 24f
    gravity = Gravity.CENTER
  }

  paparazzi.snapshot(view)
}