@vendure/ui-devkit
Version:
A library for authoring Vendure Admin UI extensions
26 lines (25 loc) • 812 B
TypeScript
import { BrandingOptions, StaticAssetExtension } from './types';
/**
* @description
* A helper function to simplify the process of setting custom branding images.
*
* @example
* ```ts
* 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'),
* }),
* ],
* });
* ```
*
* @docsCategory UiDevkit
* @docsPage helpers
*/
export declare function setBranding(options: BrandingOptions): StaticAssetExtension;