@triko-app/hooks

Provides hooks for triko application

• useApplicationConfig
• useAvailableCountries
• useRegionalConfig
• useSession
• useStyles
• useTranslation

useApplicationConfig

Centralize access to dotenv variables

type ApplicationConfigType = {
    androidID: string
    apiServer: string
    appCode: string
    env: 'dev' | 'prod'
    google: {
        apiKey: string
    }
    iosId: string
    ipFinderUrl: string
    translation: {
        group: string
    }
    version: string
}
type useApplicationConfig = () => ApplicationConfigType

Args

No args needed

Usage

import {useApplicationConfig} from '@triko-app/hooks'

const Component: React.FC = () => {
    const {apiServer} = useApplicationConfig()
    return (
        <Text>
            {`api server: ${apiServer}`}
        </Text>
    )
}

useAvailableCountries

Returns a list of the available countries for TrikoApp

type AvailableCountryItem = {
    capital: string
    continent: string
    /**
     * Currency alpha-3 codes, comma-separated.
     */
    currency: string
    emoji: string
    emojiU: string
    /**
     * List of Country's spoken Languages (alpha-2 codes).
     */
    languages: string[]
    name: string
    native: string
    phone: string
    code: string
}

type useAvailableCountries = () => AvailableCountryItem[]

Args

No arguments needed

Usage

import {useAvailableCountries} from '@triko-app/hooks'

const Component: React.FC = () => {
    const countriesList = useAvailableCountries()
    // Render...
    return null
}

useRegionalConfig

Returns settings per region

type RegionConfigReturns = {
    appVersion: string
    availableCountries: string[]
    dayStartsAt: string
    dayEndsAt: string
    rateStep: number | string
    minimumAge: number | string
    minimumRate: number | string
    maximumRate: number | string
    minimumIncentiveStep: number | string
    contactWhatsApp: string
    whatsappMessage: string
    contactEmail: string
    supportEmailSubject: string
    minimumAnticipation: number
    minimumScheduleAnticipation: number | string
    minimumMoneyStep: number | string
    place2payUrl: string
    bankInfoDocs: any
    paymentContactEmail: string
    rateStepAlternative: number | string
    termsUrl: string
    landingUrl: string
    shareIncentive: any
    defaultSearchDistance: number | string
    shopperMinimumRate: number | string
    taskMinimumRate: number | string
    courierMinimumRate: number | string
    requestFetchInterval: number | string
}

type useRegionConfig = () => RegionConfigReturns

Args

No args needed

Usage

import {useRegionConfig} from '@triko-app/hooks'

const Component: React.FC = () => {
    const {appVersion} = uuseRegionConfig()
    // Render...
    return null
}

useSession

It's a shortcut to access useSession hook from the package @triko-app/session

useStyles

It's a shortcut to access useStyles hook from the package @triko-app/theme-provider

useTranslation

It's a shortcut to access useTranslation hook from the package @triko-app/translate