config.SplashConfig — Kuito Documentation

Usage

Validate a configuration in an app-development tool.

This type is used by config.resolveConfig

tsx

// Validate a configuration in an app-development tool.
import { resolveConfig, SETTING_DEFAULTS, IOS_BACKGROUND_MODES } from 'kuito/config';

const config = resolveConfig(
  {
    name: 'Notes',
    ios: { bundleIdentifier: 'com.example.notes' },
    android: { applicationId: 'com.example.notes' },
    environments: { staging: { idSuffix: '.staging' } },
  },
  '/project/kuito.config.ts',
  'staging',
);
console.log(config.ios.bundleIdentifier, config.splash, config.icon);
console.log(SETTING_DEFAULTS.minSdk, IOS_BACKGROUND_MODES);

Type declaration

export interface SplashConfig extends SplashLook {
  /** Each variant: the splash with its own keys replaced. */
  variants: Record<string, SplashLook>;
}

Members 6

Name	Type	Required	Description
`variants`	`Record<string, SplashLook>`	Yes	Each variant: the splash with its own keys replaced.
`logo`	`IconSource`	Yes	—
`logoWidth`	`number`	Yes	—
`background`	`string`	Yes	`#RRGGBB`.
`brand`	`IconSource`	Yes	—
`dark`	`{ logo: IconSource \| null; background: string \| null; brand: IconSource \| null;}`	Yes	—

dark — nested fields

dark fields

Name	Type	Required	Description
`logo`	`IconSource`	Yes	—
`background`	`string`	Yes	—
`brand`	`IconSource`	Yes	—

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.