Skip to content

Commit cccd801

Browse files
committed
update docs
1 parent bf23e8a commit cccd801

File tree

387 files changed

+26756
-4991
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

387 files changed

+26756
-4991
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: mrzachnugent
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[ BUG ]'
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
<!--
10+
11+
⚠️ **Important**: Issues must include a valid reproduction link. Reports without one will be automatically closed.
12+
13+
You can quickly create a minimal reproduction using:
14+
15+
```bash
16+
npx @react-native-reusables/cli@latest init -t minimal
17+
```
18+
19+
-->
20+
21+
**Reproduction link**: `<link>`
22+
23+
**Describe the bug**
24+
A clear and concise description of what the bug is.
25+
26+
**Steps to reproduce the behavior:**
27+
28+
1. Start the '...' app with '...'
29+
2. Go to '...'
30+
3. Click on '....'
31+
4. Scroll down to '....'
32+
5. See error
33+
34+
**Expected behavior**
35+
A clear and concise description of what you expected to happen.
36+
37+
**Screenshots**
38+
If applicable, add screenshots to help explain your problem.
39+
40+
**Platform (please complete the following information):**
41+
42+
- Type: [eg: Browser, Simulator, Emulator, Device]
43+
- OS: [e.g. iOS]
44+
- Browser (if applies) [e.g. chrome, safari]
45+
46+
**CLI output (paste the full command output)**
47+
48+
If applicable, paste the full command output by running it with the `--log-level all` flag.
49+
50+
```bash
51+
npx @react-native-reusables/cli@latest --log-level all [command] [args] [options]
52+
53+
// example:
54+
// npx @react-native-reusables/cli@latest --log-level all init -t minimal
55+
```
56+
57+
**Additional context**
58+
Add any other context about the problem here.

.github/pull_request_template.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# Pull Request Template
22

3+
<!--
4+
5+
⚠️ **Important**
6+
7+
**If you want to propose a new feature:**
8+
9+
1. Make sure to read the [project scope](https://github.com/founded-labs/react-native-reusables/discussions/229) to confirm your proposal fits within the vision and purpose of `react-native-reusables`.
10+
2. Before taking any action, please open a [new discussion](https://github.com/founded-labs/react-native-reusables/discussions). This allows us to collaborate, gather feedback, and ensure alignment with the project's goals.
11+
12+
-->
13+
314
## Description:
415

516
<!-- Provide a brief description of the changes introduced by this pull request. -->
@@ -20,7 +31,8 @@ Fixes issue #<!-- Add the issue number that this PR fixes, if applicable. -->
2031

2132
- [ ] apps/docs
2233
- [ ] apps/showcase
23-
- [ ] packages/rnr-ui
34+
- [ ] apps/cli
35+
- [ ] packages/registry
2436

2537
### Screenshots:
2638

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,4 +62,3 @@ xcuserdata
6262

6363
# VSCode
6464
.history/
65-
/coverage

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
20.11.0
1+
20.11

.prettierrc

Lines changed: 0 additions & 9 deletions
This file was deleted.

.vercel/project.json

Lines changed: 0 additions & 1 deletion
This file was deleted.

COMMUNITY_RESOURCES.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
# Community Resources
2+
3+
Community-created components, libraries, and templates that extend React Native Reusables and fill in missing shadcn/ui elements.
4+
5+
_Contributions are welcome! Submit a PR to add your resource._
6+
7+
## Components & Libraries
8+
9+
### Calendar
10+
11+
- [React Native Flash Calendar](https://github.com/MarceloPrado/flash-calendar)
12+
Incredibly fast and flexible library to build calendars in React Native.
13+
14+
### Carousel
15+
16+
- [Animated.ScrollView](https://medium.com/timeless/building-a-gallery-carousel-in-react-native-using-reanimated-i-19b19e6b6b10)
17+
Article explaining how to create a carousel using the ScrollView component.
18+
19+
### Chart
20+
21+
- [Victory Native](https://github.com/FormidableLabs/victory-native-xl)
22+
Charting library for React Native with a focus on performance and customization.
23+
24+
### Combobox
25+
26+
_TBD_
27+
28+
### Command
29+
30+
_TBD_
31+
32+
### Data Table
33+
34+
- [Tanstack Table](https://tanstack.com/table/latest)
35+
Headless UI for building powerful tables and datagrids.
36+
37+
### Date Picker
38+
39+
- [React Native DateTimePicker](https://github.com/react-native-datetimepicker/datetimepicker)
40+
Date and time picker component for iOS, Android, and Windows.
41+
42+
### Drawer
43+
44+
- [Universal Bottom Sheet](https://github.com/adebayoileri/universal-bottom-sheet) by [adebayoileri](https://github.com/adebayoileri)
45+
Bottom sheet component that combines Gorhom Bottom Sheet and Vaul for a seamless, responsive experience across mobile and web.
46+
47+
### Form
48+
49+
- [React Hook Form](https://react-hook-form.com/get-started#ReactNative)
50+
Performant, flexible, and extensible forms with easy-to-use validation.
51+
52+
### Input OTP
53+
54+
- [input-otp-native](https://github.com/yjose/input-otp-native)
55+
🔐 OTP input for React Native/Expo apps: unstyled, copy-paste examples that are fully tested and compatible with Nativewind.
56+
57+
### Resizable
58+
59+
_TBD_
60+
61+
### Scroll Area
62+
63+
- [React Native ScrollView](https://reactnative.dev/docs/scrollview)
64+
Generic scrolling container that can host multiple components and views.
65+
66+
### Sheet (Drawer Navigation)
67+
68+
- [Drawer Navigation](https://reactnavigation.org/docs/drawer-based-navigation/)
69+
Drawer navigation component that slides in from the side.
70+
71+
### Sonner
72+
73+
- [Sonner Native](https://github.com/gunnartorfis/sonner-native) by [gunnartorfis](https://github.com/gunnartorfis)
74+
Opinionated toast component for React Native. Port of @emilkowalski's sonner.
75+
76+
- [Burnt](https://www.npmjs.com/package/burnt)
77+
Cross-platform toasts for React Native, powered by native elements. Uses [Sonner](https://github.com/emilkowalski/sonner) on Web.
78+
79+
---
80+
81+
## Templates
82+
83+
- [RNR Base Bare](https://github.com/a0m0rajab/rnr-base-bare) by [a0m0rajab](https://github.com/a0m0rajab)
84+
Supabase-powered starter app with sign-in, sign-up, and profile functionality.

CONTRIBUTING.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,24 @@
11
# Contributing to React Native Reusables
22

3-
Thank you for your interest in contributing to `rnr-registry-template`! We welcome contributions from the community to improve and enhance this project. Before getting started, please take a moment to review the following guidelines.
3+
Thank you for your interest in contributing to `react-native-reusables`! We welcome contributions from the community to improve and enhance this project. Before getting started, please take a moment to review the following guidelines.
44

55
## How to Contribute
66

7+
> ⚠️ **Important**
8+
>
9+
> If you want to propose a new feature:
10+
>
11+
> 1. Make sure to read the [project scope](https://github.com/founded-labs/react-native-reusables/discussions/229) to confirm your proposal fits within the vision and purpose of `react-native-reusables`.
12+
> 2. Before taking any action, please open a [new discussion](https://github.com/founded-labs/react-native-reusables/discussions). This allows us to collaborate, gather feedback, and ensure alignment with the project's goals.
13+
714
<br />
815

916
1. Fork the repository to your GitHub account.
1017
2. Clone the forked repository to your local machine:
11-
1218
```bash
13-
git clone https://github.com/your-username/rnr-registry-template.git
14-
cd rnr-registry-template
19+
git clone https://github.com/your-username/react-native-reusables.git
20+
cd react-native-reusables
1521
```
16-
1722
3. Create a new branch:
1823

1924
```bash
@@ -43,18 +48,18 @@ Please follow the coding style and guidelines used in the project. If there are
4348
4449
## Issue Tracker
4550

46-
Check the [issue tracker](https://github.com/next-dev-team/next-dev/issues) for existing issues or open a new issue to discuss and coordinate your contribution with the maintainers.
51+
Check the [issue tracker](https://github.com/founded-labs/react-native-reusables/issues) for existing issues or open a new issue to discuss and coordinate your contribution with the maintainers.
4752

4853
## Code of Conduct
4954

50-
Please review and adhere to our [Code of Conduct](https://github.com/next-dev-team/next-dev/blob/main/CODE_OF_CONDUCT.md). Be respectful and considerate towards others.
55+
Please review and adhere to our [Code of Conduct](https://github.com/founded-labs/react-native-reusables/blob/main/CODE_OF_CONDUCT.md). Be respectful and considerate towards others.
5156

5257
## License
5358

54-
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](https://github.com/next-dev-team/next-dev/blob/main/LICENSE) file of this repository.
59+
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](https://github.com/founded-labs/react-native-reusables/blob/main/LICENSE) file of this repository.
5560

5661
## Contact
5762

58-
If you have any questions or need further assistance, feel free to contact us at <hello@foundedlabs.com>.
63+
If you have any questions or need further assistance, feel free to contact us at hello@foundedlabs.com.
5964

6065
**We appreciate your contributions and look forward to working with you!**

README.md

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,27 @@
1-
# React Native Reusables registry template
1+
# React Native Reusables
22

33
Bringing [shadcn/ui](https://ui.shadcn.com) to React Native. Beautifully crafted components with [Nativewind](https://www.nativewind.dev/), open source, and almost as easy to use.</i>
44

55
![hero](apps/docs/public/og.png)
66

7-
## Getting Started
8-
9-
This is a template for creating a custom registry using Next.js or Expo.
10-
11-
- The template uses a `registry.json` file to define components and their files. These are found in both `apps/docs` and `apps/showcase` folders.
12-
- The `shadcn build` command is used to build the registry.
13-
- You can use `turbo registry` to build the registry. This will generate the `public/r` folders in both `apps/docs` and `apps/showcase`.
14-
- The registry items are served as static files under `public/r/[name].json`.
15-
- Every registry item are compatible with the `shadcn` CLI.
16-
177
## Documentation
188

19-
Visit <https://next-dev-docs.vercel.app/> to view the documentation.
9+
Visit https://reactnativereusables.com/docs to view the documentation.
2010

2111
## Community Resources
2212

2313
See the [community resources](./COMMUNITY_RESOURCES.md) for community-maintained components, libraries, and templates.
2414

15+
## Contributing
16+
17+
Please read the [contributing guide](/CONTRIBUTING.md).
18+
2519
## License
2620

2721
Licensed under the [MIT license](/LICENSE).
2822

29-
## Credits
30-
31-
- [react-native-reusables](https://reactnativereusables.com) for the inspiration and the template.
23+
<br />
24+
<br />
25+
<a href="https://vercel.com/oss">
26+
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge.svg" />
27+
</a>

0 commit comments

Comments
 (0)