Shoutem UI

Customizable set of components for React Native applications

README

Shoutem UI


Shoutem UI is a set of styleable components that enables you to build beautiful React Native applications for iOS and Android. All of our components are built to be both composable and customizable. Each component has a predefined style that is compatible with the rest of the Shoutem UI, which makes it possible to build complex components that look great without the need to manually define complex styles.

Install


These instructions are valid for React Native 0.60.0 and higher. If you're running a lower version, please use v1.X.X.

  1. ```
  2. $ npm install --save @shoutem/ui
  3. ```

We have a postinstall script which will add @shoutem/ui's native dependencies to your root package.json in order to support autolinking and pod installation.

Optional: Link the font files to your iOS and Android projects using react-native-asset:

  1. ```
  2. $ npx react-native-asset node_modules/@shoutem/ui/fonts
  3. ```

Not doing this will result in dismissable red screen errors about unknown font names, as well as the default system fonts being used on iOS and Android when a Shoutem UI font is meant to be used, so we suggest running this step.

Docs


All the documentation is available on the Developer portal.

Community


Join our community on Facebook. Also, feel free to ask a question on Stack Overflow using "shoutem" tag.

UI Toolkit


Shoutem UI is a part of the Shoutem UI Toolkit that enables you to build professional looking React Native apps with ease.

It consists of three libraries:

- @shoutem/ui: beautiful and customizable UI components
- @shoutem/theme: “CSS-way” of styling entire app
- @shoutem/animation: declarative way of applying ready-made animations

License


Copyright (c) 2016-present, Shoutem