Out-of-the box comes with:

• Themes
• Layouts (Cards, Vertical, Horizontal, Centered etc.)
• Texts (Title, Subtitle, Text, Caption etc.)
• Buttons (Simple, Transparent, Loading etc.)
• Images and Icons (Icons, Avatars, Images etc.)
• Font (Specify Regular, Styled and Bold fonts)
• Bars (Toolbars, Bottom nav bars etc.)
• Modals (Dialogboxes, Selection bottomsheet, Horizontal selection etc.)
• Expand box (Animated)
• Lists (Simple data list)
• Webview (In app web browser)
• Internationalization (I18n)
• Analytics (Clicks, Impression tracking)

Install

npm install react-native-boxes

Dependencies

Make sure you have following dependencies installed. The versions can be any satisfying version but must not have any breaking changes.

    "@expo/vector-icons": "^13.0.0",
    "react": "^18.2.0",
    "@react-native-async-storage/async-storage": "1.23.1",
    "react-native": "^0.73.6",
    "react-native-safe-area-context": "^4.9.0",
    "react-native-gesture-handler":"~2.14.0"

Usage

At the root of your app you must add a theme context and thats it! You are good to go.

import { Colors, DarkColors, Theme } from 'react-native-boxes';
import { GestureHandlerRootView } from 'react-native-gesture-handler';

export default function App(){ 
    const colorScheme = 'dark'
    const theme = new Theme('my-app', colorScheme === 'dark' ? DarkColors : Colors);
    return (
        <ThemeContext.Provider value={theme} >
            <GestureHandlerRootView> 
                <WatchlistPage />
            </GestureHandlerRootView>
        </ThemeContext.Provider>
    )
}

Optional: If you are also gonna use bottomsheets, Add GestureHandlerRootView

Components

Themes

Dark colors and Light colors come out of the box.

Dark Colors

Light Colors

import { Colors, Theme } from 'react-native-boxes';
...

const MyColors = Object.assign(Colors, {
    accent: '#086CFE',
    accentLight: '#337DFF',
    text: '#444444',
    caption: '#A9A9A9',
    heading: '#222222',
    background: '#E6E6E6',
    forground: '#fff',
    transparent: 'transparent',
    semitransparent: '#111a1a1c',
    info: '#2196F3',
    success: '#4CAF50',
    successBackground: '#388E3C',
    warning: '#FFA726',
    critical: '#F44336',
    invert: {
        text: '#fff',
        caption: '#fff',
        heading: '#fff',
        background: '#1a1a1c'
    }
})
 const theme = new Theme('my-app', MyColors);
return (
    <ThemeContext.Provider value={theme} >
            <WatchlistPage />
    </ThemeContext.Provider>
)
                

You can also customize sizes, dimensions etc, but it is not recommended.

const theme = new Theme(
    appname = '',
    colors  ,
    dimens ,
    fonts  ,
    styles , 
)
    

Fonts

Load the below font names. Different components use different font families.

  loadAsync({
    'Regular': require('./assets/fonts/Regular.ttf'), // Used in all general texts
    'Bold': require('./assets/fonts/Bold.ttf'), // Used in Buttons and Headings
    'Styled': require('./assets/fonts/Styled.ttf'), // Used in special places
  })

Layouts

VPage

Your root tag for pages. Consists of vertical alignment and some basic padding.

<VPage>
  <Title>Watchlist1</Title>
</VPage>

Center

<Center>
    <Title>Watchlist</Title>
    <Caption>Coming soon  </Caption>
</Center>

VBox

<VBox>
    <Title>Watchlist</Title>
    <Caption>Coming soon  </Caption>
</VBox>

HBox

  <HBox>
    <Title>Watchlist1</Title>
    <Title>Watchlist2</Title>
  </HBox>
  

Texts

<Title>Watchlist Title</Title>
  <TextView>
    This is a text with a simple example from a watchlist screen. You can add stocks to your watchlist and see their performance. You can also add alerts to get notified when a stock reaches a certain price.
  </TextView>
  <Subtitle>This is a subtitle for watchlist</Subtitle>
  <TitleText>
    This is a title text that explains what a watchlist is.
  </TitleText>
  <TextView>
    A watchlist is a list of stocks that you are interested in.
  </TextView>
  <TitleText>
    This is a another title text that explains what a watchlist is.
  </TitleText>
  <TextView>
    A watchlist is a list of stocks that you are interested in.
  </TextView>
  <Caption>
    This is a caption. All investments are subject to market risk. Please do your own research before investing in any stock. This app is for educational purposes only.
  </Caption>

Images

Avatars

• With icon
• With image url
• With text

<Avatar iconName='user' />
<Avatar iconUrl='https://avatars.githubusercontent.com/u/16799797?v=4' />
<Avatar iconText='SN' />
      

Icons

Support for Fontawesome icon names from https://icons.expo.fyi/

<Icon name='home' size={50} />
<Title>Light Theme Watchlist</Title>
      

Buttons

<ButtonView text='Simple Button' />

<TransparentButton text='Transparent Button' />

const [loading, setLoading] = useState(false)

<LoadingButton loading={loading} text='Loading Button' onPress={() => {
    setLoading((prev) => !prev)
  }} />

Bottombar

export default function AppBottomBar() {
  const theme = useContext(ThemeContext)
  const router = useRouter()
  const [selectedId, setSelectedId] = React.useState('watchlist')
  return (
    <BottomNavBar
      selectedId={selectedId}
      options={[
        {
          id: 'watchlist',
          icon: 'bookmark',
          title: 'Watchlist'
        },
        {
          id: 'orders',
          icon: 'file-text',
          title: 'Orders'
        },
        {
          id: 'positions',
          icon: 'briefcase',
          title: 'Positions'
        },
        {
          id: 'settings',
          icon: 'gears',
          title: 'Settings'
        }
      ]}
      onSelect={(selectedId) => {
        console.log('selected', selectedId)
        setSelectedId(selectedId)
        router.push('/explore')
      }} />
  )
}

Expand

<Expand title='Expand Watchlist' >
    <TextView>INFY</TextView>
    <TextView>TCS</TextView>
</Expand>

Toolbars

Simple Toolbar

<SimpleToolbar title="Watchlist" />

Transparent Center Toolbar

<SimpleToolbar title="Watchlist" />

Toolbar with buttons

<TransparentCenterToolbar
    homeIcon={"arrow-left"}
    title="Watchlist"
    options={[{
      id: 'search',
      icon: 'search',
      onClick: () => {
        console.log('Search clicked')
      }
    }]}
  />

Divider

<Expand title='Expand Watchlist' >
    <TextView>INFY</TextView>
    <TextView>TCS</TextView>
</Expand>

Modals

Bottomsheet on mobile

  <BottomSheet title="Bottomsheet About Watchlists" visible={showDialog} onDismiss={() => setShowDialog(false)}>
    <TextView>
      This is a simple dialog that can be used to show more information to the user. It is a bottom sheet that can host any content.
    </TextView>
    <HBox />
    <TextView>
      Watchlists are a great way to keep track of your favorite stocks. You can add stocks to your watchlist and see their performance. You can also add alerts to get notified when a stock reaches a certain price.
    </TextView>
    <TertiaryButtonView text='Goto Watchlist' onPress={() => setShowDialog(false)} />
  </BottomSheet>
  

Bottomsheet on Desktop (web)

Web view

Opens a webview on native and a iframe on Web

<WebBrowserView url='https://www.google.com' title='Google'/>

Internationalization

Install your favorite js library.

import { I18n } from 'i18n-js';

const I18nProvider = new I18n({
  en: {
    watchlist: {
      hello: 'Hello!'
    },
    home:{
      title:'Hello %{name} !'
    }
  },
  hi: {
    watchlist: {
      hello: 'नमस्ते !'
    }
  },
  hinglish: {
    watchlist: {
      hello: 'Namaste !'
    }
  },
  es: {
    watchlist: {
      hello: 'Hola!'
    }
  }
});
I18nProvider.locale = 'hi'
I18nProvider.missingBehavior = "guess";


export default function App(){
    const [locale, setLocale] = useState('en')
    I18nProvider.locale = locale
    const theme = new Theme('appname', colorScheme === 'dark' ? DarkColors : Colors);
    theme.i18n = I18nProvider
    
      
    return (
        <ThemeContext.Provider value={theme} >
        <Center>
              <Title>watchlist.hello</Title>
            </Center>
            <Center>
              <HBox>
                <TransparentButton text='English' onPress={() => {
                  setLocale('en')
                }} />
                <TransparentButton text='Hindi' onPress={() => {
                  setLocale('hi')
    
                }} />
              </HBox>
              <HBox>
                <TransparentButton text='Hinglish' onPress={() => {
                  setLocale('hinglish')
    
                }} />
                <TransparentButton text='Spanish' onPress={() => {
                  setLocale('es')
    
                }} />
              </HBox>
        </Center>
     </ThemeContext.Provider>
    )
 }

For Skipping localization, you can add create custom middleware like below and wrap your string with {{YOUR STRING}}, this will directly output your string.

let tOriginal = I18nProvider.t.bind(I18nProvider)
I18nProvider.t = (scope, options) => {
    if (scope == undefined)
        return ''
    if (typeof scope == 'string') {
        if (scope.startsWith("{{") && scope.endsWith("}}")) {
            return scope.replace("{{", "").replace("}}", "")
        }
    }
    return tOriginal(scope, options)
}

<TextView text={`{{This String will not be localized. Nope}}`} /> 

For using placeholders in your locales,

<TextView text={`{{  ${theme.i18n.t('home.title',{ name: 'Shivesh Navin' })}  }}` />

Analytics

If you wanna track the users clicks and impressions on each component, just add a onTrack hook to your theme.

action : TrackingActionType = click | view | navigate
view : TrackingViewType = button | dropdown...
text : The text related to the component if present
extra : Depending on component, some contextual info. For e.g. the WebView impression gives {url, title} extra

const theme = new Theme('appname', DarkColors);  
theme.onTrack = (action, view, text, extras) => {
    myTracker.track(`${action}-${text}-${text}`, extras)
}