Skip to content

Latest commit

 

History

History
964 lines (637 loc) · 14.5 KB

PublicAppConfig.md

File metadata and controls

964 lines (637 loc) · 14.5 KB

@divvi/mobile

@divvi/mobile / PublicAppConfig

Interface: PublicAppConfig<tabScreenConfigs>

Defined in: packages/@divvi/mobile/src/public/types.tsx:24

Type Parameters

• tabScreenConfigs extends TabScreenConfig[] = TabScreenConfig[]

Properties

deepLinkUrlScheme

deepLinkUrlScheme: string

Defined in: packages/@divvi/mobile/src/public/types.tsx:27

displayName

displayName: string

Defined in: packages/@divvi/mobile/src/public/types.tsx:26

divviProtocol?

optional divviProtocol: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:262

protocolIds

protocolIds: (
  | "aave"
  | "aerodrome"
  | "allbridge"
  | "beefy"
  | "celo"
  | "fonbnk"
  | "mento"
  | "somm"
  | "vana")[];

referrerId

referrerId: string

experimental?

optional experimental: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:207

Experimental features that may change or be removed in future versions. These features are not part of the stable configuration API and should be used with caution.

Features may graduate to the stable API or be removed entirely.

activity?

optional activity: object;
activity.hideActionsCarousel?
optional hideActionsCarousel: boolean;

alchemyKeys?

optional alchemyKeys: Record<string, string>;

bidali?

optional bidali: object;
bidali.url
url: string

disableNfts?

optional disableNfts: boolean;

earn?

optional earn: object;
earn.showLearnMore?
optional showLearnMore: boolean;
earn.showSafetyScoreOnPoolCard?
optional showSafetyScoreOnPoolCard: boolean;

enableSwapAppFee?

optional enableSwapAppFee: boolean;

firebase?

optional firebase: boolean;

hideCashInTokenFilters?

optional hideCashInTokenFilters: boolean;

inviteFriends?

optional inviteFriends: boolean;

notificationCenter?

optional notificationCenter: boolean;

onboarding?

optional onboarding: object;
onboarding.enableBiometry?
optional enableBiometry: boolean;
onboarding.protectWallet?
optional protectWallet: boolean;

otaTranslations?

optional otaTranslations: object;
otaTranslations.crowdinDistributionHash
crowdinDistributionHash: string

phoneNumberVerification?

optional phoneNumberVerification: boolean;

showImportTokensFlow?

optional showImportTokensFlow: boolean;

showPositions?

optional showPositions: boolean;

showSwapTokenFilters?

optional showSwapTokenFilters: boolean;

tokens?

optional tokens: object;
tokens.enabledTokenIds
enabledTokenIds: string[];
tokens.overrides?
optional overrides: object;
Index Signature
[tokenId: string]: object

transactions?

optional transactions: object;
transactions.emptyState?
optional emptyState: ReactElement<any, string | JSXElementConstructor<any>>;

wallet?

optional wallet: object;
wallet.emptyState?
optional emptyState: ReactElement<any, string | JSXElementConstructor<any>>;
wallet.showActionsCarousel?
optional showActionsCarousel: boolean;

zendeskConfig?

optional zendeskConfig: object;
zendeskConfig.apiKey
apiKey: string
zendeskConfig.projectName
projectName: string

features?

optional features: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:158

cloudBackup?

optional cloudBackup: boolean;

segment?

optional segment: object;
segment.apiKey
apiKey: string

sentry?

optional sentry: object;
sentry.clientUrl
clientUrl: string

statsig?

optional statsig: object;
statsig.apiKey
apiKey: string

walletConnect?

optional walletConnect: object;
walletConnect.projectId
projectId: string

ios?

optional ios: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:30

appStoreId?

optional appStoreId: string;

locales?

optional locales: Partial<{
  de: Record<string, any>;
  en-US: Record<string, any>;
  es-419: Record<string, any>;
  fr-FR: Record<string, any>;
  it-IT: Record<string, any>;
  pl-PL: Record<string, any>;
  pt-BR: Record<string, any>;
  ru-RU: Record<string, any>;
  th-TH: Record<string, any>;
  tr-TR: Record<string, any>;
  uk-UA: Record<string, any>;
  vi-VN: Record<string, any>;
  zh-CN: Record<string, any>;
}>;

Defined in: packages/@divvi/mobile/src/public/types.tsx:179

Optional copies overwrite. This field should contain the same language keys as @interxyz/mobile. TODO: Eventually, we want to make this fully type-safe (maybe with generics?)

networks?

optional networks: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:196

enabledNetworkIds?

optional enabledNetworkIds: NetworkId[];

registryName

registryName: string

Defined in: packages/@divvi/mobile/src/public/types.tsx:25

screens?

optional screens: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:141

custom()?

optional custom: (Screen) => Element;
Parameters
Screen

any

Returns

Element

tabs()?

optional tabs: (args) => object;
Parameters
args
defaultTabs

{ activity: TabScreenConfig & object; discover: TabScreenConfig & object; earn: TabScreenConfig & object; wallet: TabScreenConfig & object; }

defaultTabs.activity

TabScreenConfig & object

defaultTabs.discover

TabScreenConfig & object

defaultTabs.earn

TabScreenConfig & object

defaultTabs.wallet

TabScreenConfig & object

Returns

object

initialScreen?
optional initialScreen: tabScreenConfigs[number]["name"];
screens?
optional screens: tabScreenConfigs;

themes?

optional themes: object;

Defined in: packages/@divvi/mobile/src/public/types.tsx:35

default

default: object;
default.assets?
optional assets: object;
default.assets.backupAndRecoveryImages?
optional backupAndRecoveryImages: object;
default.assets.backupAndRecoveryImages.cloudBackupEmail?
optional cloudBackupEmail: ImageSourcePropType;
default.assets.backupAndRecoveryImages.recoveryPhraseEducation1?
optional recoveryPhraseEducation1: ImageSourcePropType;
default.assets.backupAndRecoveryImages.recoveryPhraseEducation2?
optional recoveryPhraseEducation2: ImageSourcePropType;
default.assets.backupAndRecoveryImages.recoveryPhraseEducation3?
optional recoveryPhraseEducation3: ImageSourcePropType;
default.assets.backupAndRecoveryImages.recoveryPhraseEducation4?
optional recoveryPhraseEducation4: ImageSourcePropType;
default.assets.backupAndRecoveryImages.walletSafe?
optional walletSafe: ImageSourcePropType;
default.assets.biometryImages?
optional biometryImages: object;
default.assets.biometryImages.face?
optional face: ImageSourcePropType;
default.assets.biometryImages.faceId?
optional faceId: ImageSourcePropType;
default.assets.biometryImages.fingerprint?
optional fingerprint: ImageSourcePropType;
default.assets.biometryImages.iris?
optional iris: ImageSourcePropType;
default.assets.biometryImages.touchId?
optional touchId: ImageSourcePropType;
default.assets.brandLogo?
optional brandLogo: ComponentType<{
  color: string;
  size: number;
}>;
default.assets.noEarnPoolsLogo?
optional noEarnPoolsLogo: ComponentType<any>;
default.assets.onboardingSuccessBackgroundImage?
optional onboardingSuccessBackgroundImage: ImageSourcePropType;
default.assets.onboardingSuccessImage?
optional onboardingSuccessImage: ImageSourcePropType;
default.assets.splashBackgroundImage?
optional splashBackgroundImage: ImageSourcePropType;
default.assets.welcomeBackgroundImage?
optional welcomeBackgroundImage: ImageSourcePropType;
default.assets.welcomeLogo?
optional welcomeLogo: ComponentType<any>;
default.colors?
optional colors: object;
default.colors.accent?
optional accent: string;
default.colors.backgroundOnboardingComplete?
optional backgroundOnboardingComplete: string;
default.colors.backgroundPrimary?
optional backgroundPrimary: string;
default.colors.backgroundScrim?
optional backgroundScrim: string;
default.colors.backgroundSecondary?
optional backgroundSecondary: string;
default.colors.backgroundSplash?
optional backgroundSplash: string;
default.colors.backgroundTertiary?
optional backgroundTertiary: string;
default.colors.barShadow?
optional barShadow: string;
default.colors.borderPrimary?
optional borderPrimary: string;
default.colors.borderSecondary?
optional borderSecondary: string;
default.colors.bottomSheetHandle?
optional bottomSheetHandle: string;
default.colors.brandGradientLeft?
optional brandGradientLeft: string;
default.colors.brandGradientRight?
optional brandGradientRight: string;
default.colors.buttonPrimaryBackground?
optional buttonPrimaryBackground: string | string[];

Can be a single color or array of colors for a linear gradient

default.colors.buttonPrimaryBorder?
optional buttonPrimaryBorder: string;
default.colors.buttonPrimaryContent?
optional buttonPrimaryContent: string;
default.colors.buttonQuickActionBackground?
optional buttonQuickActionBackground: string;
default.colors.buttonQuickActionBorder?
optional buttonQuickActionBorder: string;
default.colors.buttonQuickActionContent?
optional buttonQuickActionContent: string;
default.colors.buttonSecondaryBackground?
optional buttonSecondaryBackground: string;
default.colors.buttonSecondaryBorder?
optional buttonSecondaryBorder: string;
default.colors.buttonSecondaryContent?
optional buttonSecondaryContent: string;
default.colors.buttonTertiaryBackground?
optional buttonTertiaryBackground: string;
default.colors.buttonTertiaryBorder?
optional buttonTertiaryBorder: string;
default.colors.buttonTertiaryContent?
optional buttonTertiaryContent: string;
default.colors.contentOnboardingComplete?
optional contentOnboardingComplete: string;
default.colors.contentPrimary?
optional contentPrimary: string;
default.colors.contentSecondary?
optional contentSecondary: string;
default.colors.contentTertiary?
optional contentTertiary: string;
default.colors.disabled?
optional disabled: string;
default.colors.errorPrimary?
optional errorPrimary: string;
default.colors.errorSecondary?
optional errorSecondary: string;
default.colors.inactive?
optional inactive: string;
default.colors.info?
optional info: string;
default.colors.lightShadow?
optional lightShadow: string;
default.colors.loadingIndicator?
optional loadingIndicator: string;
default.colors.navigationBottomPrimary?
optional navigationBottomPrimary: string;
default.colors.navigationBottomSecondary?
optional navigationBottomSecondary: string;
default.colors.navigationTopPrimary?
optional navigationTopPrimary: string;
default.colors.navigationTopSecondary?
optional navigationTopSecondary: string;
default.colors.qrTabBarPrimary?
optional qrTabBarPrimary: string;
default.colors.qrTabBarSecondary?
optional qrTabBarSecondary: string;
default.colors.skeletonPlaceholderBackground?
optional skeletonPlaceholderBackground: string;
default.colors.skeletonPlaceholderHighlight?
optional skeletonPlaceholderHighlight: string;
default.colors.softShadow?
optional softShadow: string;
default.colors.successPrimary?
optional successPrimary: string;
default.colors.successSecondary?
optional successSecondary: string;
default.colors.textInputBackground?
optional textInputBackground: string;
default.colors.textLink?
optional textLink: string;
default.colors.warningPrimary?
optional warningPrimary: string;
default.colors.warningSecondary?
optional warningSecondary: string;
default.isDark?
optional isDark: boolean;