helpers

setBranding

Package: @vendure/ui-devkit File: helpers.ts

A helper function to simplify the process of setting custom branding images.

Example

compileUiExtensions({
  outputPath: path.join(__dirname, '../admin-ui'),
  extensions: [
    setBranding({
      // This is used as the branding in the top-left above the navigation
      smallLogoPath: path.join(__dirname, 'images/my-logo-sm.png'),
      // This is used on the login page
      largeLogoPath: path.join(__dirname, 'images/my-logo-lg.png'),
      faviconPath: path.join(__dirname, 'images/my-favicon.ico'),
    }),
  ],
});

Signature

function setBranding(options: BrandingOptions): StaticAssetExtension

Parameters

options

parameter

type:

BrandingOptions

Contents