DOCSEARCHbyAlgolia
Submit Docs

Pixeleye Documentation

website·Indexed 32 days ago

https://pixeleye.io/docs

An open-source visual review and testing platform for UI. Pixeleye provides tools for capturing snapshots, diff highlighting, and cross-browser and responsive testing. It features integrations with Storybook, Puppeteer, Playwright, Cypress, and GitHub Actions, and supports both cloud and self-hosted deployments.

Tokens
12.8K
Snippets
51
Records
124
Agent score
66%

What's inside Pixeleye

  1. Overview of Pixeleye Visual Testing Platform

    Pixeleye is an open-source, self-hostable, all-in-one visual test and review platform designed to detect, track, and review visual changes across various browsers and screen sizes. It is built to integrate into development pipelines to increase product reliability and speed up development.

  2. Overview of Pixeleye visual testing platform

    Pixeleye is an open-source, batteries-included platform for visually testing and reviewing user interfaces. It allows developers to capture snapshots (images) of individual components or entire applications to compare changes and catch unintended visual regressions. The platform is available as a cloud solution or can be self-hosted to keep data in-house.

  3. Exercise data privacy rights with Pixeleye

    Users have the following rights regarding their personal data:

    • Right to Deletion: Request the deletion of personal information (subject to legal exceptions).
    • Right to Know: Request information about the categories of data collected, the purposes of use, and whether data is shared or sold.
    • Right to Non-Discrimination: Users will not be discriminated against for exercising these rights.
    • Right to Limit Sensitive Information: Not applicable as Pixeleye does not process sensitive personal information.

    To exercise these rights, users must undergo a verification process to match their identity with information already on file (e.g., via email or phone).

    Contact email: support@pixeleye.io

  4. Manage projects using Personal and Organization teams

    Pixeleye provides two types of teams for project organization:

    • Personal teams: Created automatically upon signup for personal projects. Supports projects from any VCS provider and allows inviting collaborators.
    • Organization teams: Created automatically when a supported VCS provider organization is added (e.g., adding GitHub org pixeleye-io creates a pixeleye-io team). These teams automatically sync collaborators and roles from the VCS provider.

  5. Perform cross-browser testing with Pixeleye

    Pixeleye enables consistent user experience verification by taking screenshots across multiple browsers and devices. This feature is powered by Playwright. Currently, the supported browsers are Chrome, Firefox, and Safari.

  6. Understand Pixeleye's cross-browser rendering mechanism

    Unlike traditional screenshot tools, the official Pixeleye SDKs capture snapshots of the DOM. These snapshots are then rendered in each supported browser in a separate process from the tests. This architecture ensures that cross-browser testing does not slow down the execution of the test suite.

  7. Integrate Pixeleye with a VCS provider

    Pixeleye integrates with VCS providers to enable automated permission syncing and pull-request enhancements. While Pixeleye supports any git project via manual addition, using a supported VCS integration is recommended for full feature access. Currently, GitHub is the only supported provider.

  8. Apply for free Pixeleye usage for open source projects

    Open source maintainers can request that Pixeleye cover their usage. To apply, send an email describing the project to enquiries@pixeleye.io for discretionary approval.

  9. Sync Pixeleye team permissions with VCS providers

    Pixeleye automatically syncs team permissions with your version control system (VCS) provider (e.g., GitHub). Collaborators from the VCS provider are added to the corresponding Pixeleye team with appropriate roles. Users can still be added manually to override roles provided by the VCS provider.

  12. Report a breach of Pixeleye Acceptable Use Policy

    To report content or contributions that breach the Acceptable Use Policy or infringe upon third-party intellectual property rights, contact Pixeleye via email. Provide details on which content is in breach and the reason for the report.
    Email: support@pixeleye.io