![React Native Directory Logo](./assets/logo.png)
React Native Directory is a website where you can see all the libraries that are compatible with React Native.
- You made a repository on GitHub and you want the world to know it works with React Native.
- You want to submit a pull request to improve React Native Directory or libraries dataset.
- You want to report a bug or make a suggestion.
- Add it at the end of
react-native-libraries.json
file. - Submit a PR.
Note Please follow format, fields order and indentation as seen below, skip any of the
false
values and do not fill optional fields, unless it's necessary.
{
"githubUrl": "<GITHUB REPOSITORY URL>",
"npmPkg": "<OPTIONAL NPM PACKAGE NAME>",
"nameOverride": "<OPTIONAL PACKAGE DISPLAY NAME>",
"examples": [
"<THE URL TO REPO>",
"<THE URL TO A SNACK>"
],
"images": ["<PUBLIC URL TO RELATED IMAGE>"],
"ios": false,
"android": false,
"web": false,
"expo": false,
"windows": false,
"macos": false,
"tvos": false,
"unmaintained": false,
"dev": false,
"template": false,
"newArchitecture": false
}
-
(string) - URL to the package GitHub repository (currently other Git hosts are not supported).
Package also needs to be published to the NPM registry, because it is a source of crucial data for the directory.
-
(string) - npm package name, by default GitHub repository name will be used. Example:
"@expo/react-native-action-sheet"
.Fill only when the GitHub repository name is different from the name of package published to npm, or the package is a part of monorepo.
-
(string) - display name override.
Fill only when it is different from the GitHub repository name and npm package name.
-
(array of strings) - URLs to example projects or Snacks which demonstrates the library.
-
(array of strings) - URLs to static images or GIFs that shows the library functionality.
Please do not add logotypes or other branding material, and please avoid linking multiple resources which shows the same feature.
- (boolean) - works on Android device.
- (boolean) - works on iOS device.
-
(boolean) - can be used with
react-native-web
. - (boolean) - can be used in managed workflow, without ejecting an Expo application (any library can be used if you eject).
Note Adding out-of-tree platforms support requires an example or link to the app which uses the library on the given platform.
-
(boolean) - can be used with
react-native-windows
. -
(boolean) - can be used with
react-native-macos
. -
(boolean) - can be used with
react-native-tvos
.
-
(boolean) - signify that a library is no longer maintained.
-
(boolean) - signify that a library is a development tool or is only a part of development process.
-
(boolean) - signify that a library is a new project template.
-
(boolean) - signify that a library supports the new architecture
Set this tag only when automatic architecture detection fails for your package, despite it supports the new architecture.
Note If your package is within a monorepo on GitHub, eg: https://github.com/expo/expo/tree/main/packages/expo-web-browser, then the name, description, homepage, and topics (keywords) will be extracted from
package.json
for that subrepo. GitHub stats will be based on the monorepo, because there isn't really another option.
- Node LTS
yarn && yarn start
You should be able to visit localhost:3000
in your browser.
- Visit https://github.com/settings/developers to get your keys (don't worry about the callback URL, put whatever you want).
- Load the
GITHUB_TOKEN
environment variable into your shell.
This command creates site data in ./assets/data.json
GITHUB_TOKEN=<*> yarn data:update
Get a commit on main
and it will be automatically deployed.
Sure, go for it!
https://reactnative.directory/api/libraries
- Returns a list of all libraries in
JSON
format.
https://reactnative.directory/api/libraries?search=webgl
- Returns a list of all libraries in
JSON
format that have the keywordwebgl
.
https://reactnative.directory/api/libraries?search=webgl&expo=true
- Returns a list of all libraries in
JSON
format that have the keywordwebgl
and work with Expo managed.
https://reactnative.directory/api/libraries?search=webgl&expo=true&android=true
- Returns a list of all libraries in
JSON
format that have the keywordwebgl
and work with Expo managed and Android.
https://reactnative.directory/api/libraries?search=webgl&expo=true&android=true&isPopular=true
- Returns a list of all libraries in
JSON
format that have the keywordwebgl
, work with Expo managed and Android and are popular based on the scoring criterion.
- Submit a PR with changes to
scripts/calculate-score.js
. - You have all the power! Tell us what you want.
- Site is hosted on Vercel, and this is the easiest way to do it.
- You can deploy your own with your own Vercel account
- You will need to provide
GITHUB_TOKEN
environment variable in your Vercel configuration.
# once environment variables are configured, install Vercel and deploy
npm i -g vercel
vercel