Skip to main content

Renative API Reference


getScaledValue​

Help to render UI with unified relative scaled factor

type: function

import { getScaledValue } from 'renative'

StyleSheet.create({
    view: {
      width: getScaledValue(50),
      height: getScaledValue(50)
    }
})

useOpenURL​

Cross-platform hook to open external URLs

type: function

import { useOpenURL } from 'renative'

const openURL = useOpenURL();
openURL('https://renative.org')

useNavigate​

Cross-platform hook to navigate to specific section of app

type: function

import { useNavigate } from 'renative'

const navigate = useNavigate();
navigate(route, opts, params)

usePop​

Cross-platform hook to navigate back to previous screen

type: function

import { usePop } from 'renative'

const pop = usePop();
pop()

useOpenDrawer​

Cross-platform hook to open drawer

type: function

import { useOpenDrawer } from 'renative'

const openDrawer = useOpenDrawer();
openDrawer(drawerName)

platform​

Returns string representing current platform

type: string

import { platform } from 'renative'

factor​

Returns string representing current form factor

type: string

import { factor } from 'renative'

engine​

Returns string representing current core engine

type: string

import { engine } from 'renative'

isPlatform...​

Built-time platform checks for renative target platform

returns true if running under specific platform via rnv ... -p <PLATFORM>

isPlatformAndroid​

type: bool

import { isPlatformAndroid } from 'renative'

isPlatformAndroidtv​

type: bool

import { isPlatformAndroidtv } from 'renative'

isPlatformAndroidwear​

type: bool

import { isPlatformAndroidwear } from 'renative'

isPlatformIos​

type: bool

import { isPlatformIos } from 'renative'

isPlatformTvos​

type: bool

import { isPlatformTvos } from 'renative'

isPlatformWeb​

type: bool

import { isPlatformWeb } from 'renative'

isPlatformWebos​

type: bool

import { isPlatformWebos } from 'renative'

isPlatformTizen​

type: bool

import { isPlatformTizen } from 'renative'

isPlatformTizenwatch​

type: bool

import { isPlatformTizenwatch } from 'renative'

isPlatformTizenmobile​

type: bool

import { isPlatformTizenmobile } from 'renative'

isPlatformMacos​

type: bool

import { isPlatformMacos } from 'renative'

isPlatformWindows​

type: bool

import { isPlatformWindows } from 'renative'

isPlatformFirefoxos​

type: bool

import { isPlatformFirefoxos } from 'renative'

isPlatformFirefoxtv​

type: bool

import { isPlatformFirefoxtv } from 'renative'

isPlatformKaios​

type: bool

import { isPlatformKaios } from 'renative'

isEngine...​

Built-time platform checks for renative core engine

isEngineNative​

type: bool

import { isEngineNative } from 'renative'

isEngineWeb​

type: bool

import { isEngineWeb } from 'renative'

isFactor...​

Built-time platform checks for renative form factor per each specific platform

returns true if running under specific form factor via rnv ... -p <PLATFORM> and matches one of the form factors ie for android: Android Extenstion Support

isFactorBrowser​

type: bool

import { isFactorBrowser } from 'renative'

isFactorDesktop​

type: bool

import { isFactorDesktop } from 'renative'

isFactorMobile​

type: bool

import { isFactorMobile } from 'renative'

isFactorTv​

type: bool

import { isFactorTv } from 'renative'

isFactorWatch​

type: bool

import { isFactorWatch } from 'renative'