Adding images

Apple and Google Wallet want pass artwork in very different shapes. Apple needs image files bundled into the signed .pkpass, so you point the builder at paths on disk. Google needs publicly reachable URLs, so you hand the Class a URL that Google's servers fetch.

##Apple

Every Apple pass takes a logo (top-left corner) and an icon (the square seen in notifications and email attachments). Boarding passes also take a footer image above the barcode.

Pass the path to the image file on disk:

$builder
    ->setLogoImage(public_path('images/logo.png'))
    ->setIconImage(public_path('images/icon.png'));

Apple renders passes at 1x, 2x, and 3x pixel densities. Providing higher-density versions gives you crisper results; pass them as extra arguments:

$builder->setLogoImage(
    x1Path: public_path('images/logo.png'),
    x2Path: public_path('images/logo@2x.png'),
    x3Path: public_path('images/logo@3x.png'),
);

If a path doesn't exist on disk, the builder throws an InvalidArgumentException right away so mistyped paths surface immediately.

##Recommended dimensions

Apple publishes the exact sizes it expects. The values below are for the 1x density; double them for 2x, triple for 3x.

Apple's docs don't strictly require any of these, but passes feel unfinished without an icon (it's what shows up on the lock screen and in Mail), so treat that one as mandatory in practice.

See Apple's Pass Design and Creation chapter for the full table, exact pixel sizes for every density, and which images each pass style supports.

##Google

Google doesn't ship image bytes. You give the Class a URL, and Google fetches it when it renders the pass. The URL has to be publicly reachable over HTTPS. The methods live on the Class, not on the per-attendee Builder:

use Spatie\LaravelMobilePass\Builders\Google\EventTicketPassClass;

EventTicketPassClass::make('beatles-shea-1965')
    // ...
    ->setLogoUrl('https://cdn.example.com/beatles-logo.png')
    ->setHeroImageUrl('https://cdn.example.com/beatles-hero.png')
    ->save();

Different Class types expose different image setters. Event tickets and boarding passes take a logo and a hero image. Loyalty programs take a program logo via setProgramLogoUrl(). Offers take a logo.

Google caches images it has fetched. When you change a URL's contents in place, you may need to use a new URL (or append a cache-busting query string) to see the new image.

##Recommended dimensions

Google expects PNG at the dimensions below. The service scales images down when needed, but starting above the recommended size avoids soft edges on high-density displays.

Google's Brand guidelines carry the full reference, including per-pass-type constraints.

##Background colors

Both platforms support a background color (handy when you're not using a background image). On Apple pass a hex string to setBackgroundColor():

$builder->setBackgroundColor('#1d72b8');

On Google hand a hex string to setBackgroundColor() on the Class:

EventTicketPassClass::make('beatles-shea-1965')
    ->setBackgroundColor('#1d72b8')
    ->save();