Locale

The KigoContext.locale object allows you to customize various labels used in the wallet interface to match the language and terminology of your application. This customization helps ensure that the wallet UI aligns with your brand’s tone and the user’s expectations.

Example: Customizing Locale Labels

You can set up the localization by passing a locale object when initializing the Kigo context. Here’s an example:

kigo.setContext({
  locale: {
    walletLabel: {
      singular: "Hub",
      plural: "Hubs",
    },
    rewardLabel: {
      singular: "Benefit",
      plural: "Benefits",
    },
    claimLabel: {
      singular: "Voucher",
      plural: "Vouchers",
    },
    revealLabel: {
      singular: "Unlock",
      plural: "Unlocks",
    },
    offerLabel: {
      singular: "Deal",
      plural: "Deals",
    },
    programNameLabel: {
      singular: "My Perks",
      plural: "My Perks",
    },
  },
});

Supported Locale Properties

Each of these properties can take a singular and a plural form, allowing you to accurately reflect the context in which these labels are used within your application.

• walletLabel

  • Description: Custom labels for the wallet, used in the Wallet header and throughout the application.
  • Default:
    JavaScript

    {
      singular: "Wallet",
      plural: "Wallets"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    walletLabel: {
      singular: "Hub",
      plural: "Hubs"
    }
    

• rewardLabel

  • Description: Custom labels for rewards.
  • Default:
    JavaScript

    {
      singular: "Reward",
      plural: "Rewards"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    rewardLabel: {
      singular: "Benefit",
      plural: "Benefits"
    }
    

• claimLabel

  • Description: Custom labels for claims.
  • Default:
    JavaScript

    {
      singular: "Claim",
      plural: "Claims"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    claimLabel: {
      singular: "Voucher",
      plural: "Vouchers"
    }
    

• revealLabel

  • Description: Custom labels for reveals.
  • Default:
    JavaScript

    {
      singular: "Reveal",
      plural: "Reveals"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    revealLabel: {
      singular: "Unlock",
      plural: "Unlocks"
    }
    

• offerLabel

  • Description: Custom labels for offers.
  • Default:
    JavaScript

    {
      singular: "Offer",
      plural: "Offers"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    offerLabel: {
      singular: "Deal",
      plural: "Deals"
    }
    

• programNameLabel

  • Description: Custom labels for program names.
  • Default:
    JavaScript

    {
      singular: "Program",
      plural: "Programs"
    }
    

  • Valid values: string for both singular and plural.
  • Example:
    JavaScript

    programNameLabel: {
      singular: "My Perks",
      plural: "My Perks"
    }