README.md

⚠️ Maintenance & support

I am currently unable to actively maintain this library. While I continue to use it in my projects, I am facing time constraints that prevent me from dedicating proper attention to its maintenance.

Please understand that I may not be able to address issues, implement new features, or release updates at this time. However, I intend to resume maintenance as soon as I find the necessary resources.

---

Material UI components for React Native

React Native Material is a set of pre-built, cross-platform, highly customizable UI components that follow Material Design principles.

Loved the project? Please share it with your friends and give it a ⭐️

☘️️ Try it out

Take a look at our example apps:

• 💨 Expo Snack
• 🤖 Android
• 🌍 Web

Run the Explorer App on your device

Download Expo Go app on your device and scan this QR code to get started.

• 🤖 Google Play
• 🍎 App Store

Expo Go for iOS does not include a QR code scanner learn more. So you have to scan the code using the regular camera app.

Run the Example app locally

Run the example app with Expo to see it in action. The source code is located under the /example folder.

⬇️ Installation

npm install @react-native-material/core

Or (If you're using yarn):

yarn add @react-native-material/core

🚀 Quick Start

Here's a quick example to get you started, it's literally all you need:

import React from "react";
import { Button } from "@react-native-material/core";

export default function App() {
  return <Button title="Button" onPress={() => alert("hi!")} />;
}

🔌 Component API

<Appbar />

Try it out

The App bars display information and actions relating to the current screen.

<Avatar />

Try it out

Avatars are found throughout material design with uses in everything from tables to dialog menus.

<Backdrop />

Try it out

A backdrop appears behind all other surfaces in an app, displaying contextual and actionable content.

<Badge />

Try it out

A Badge represents dynamic information such as several pending requests in a Bottom Navigation or Tab Bar.

<Banner />

Try it out

A banner displays a prominent message and related optional actions.

<Button />

Try it out

Buttons allow users to take actions, and make choices, with a single tap.

<Divider />

Try it out

A divider is a thin line that groups content in lists and layouts.

<FAB />

Try it out

A floating action button (FAB) represents the primary action of a screen.

<Surface />

Try it out

Material surfaces can be displayed in different shapes. Shapes direct attention, identify components, communicate state, and express brand.

<Typography />

Try it out

Use typography to present your design and content as clearly and efficiently as possible.

👍 Community

The community is your first stop for questions and advice about the framework. Welcome to the community!

StackOverflow

For crowdsourced answers from expert React Native Material developers in our community. StackOverflow is also frequented, from time to time, by the maintainers of React Native Material.

Post a question

GitHub

React Native Material uses GitHub issues as a bug and feature request tracker. If you think you have found a bug, or have a new feature idea, please start by making sure it hasn't already been reported or fixed . You can search through existing issues and pull requests to see if someone has reported one similar to yours.

Open an issue

🤝 Contributing

Please take a look at Kanban where we have a roadmap for React Native Material community. Also, we have a list of good first issues that contain bugs that have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.

📝 License

This library is licensed under the MIT License - see the LICENSE file for details.