Skip to content

Commit efc8c37

Browse files
authored
Merge pull request #414 from mrzachnugent/@zach/docs-rewrite
feat: New CLI. New docs. New registry. New showcase app
2 parents 82620c0 + 0e17d1d commit efc8c37

File tree

789 files changed

+28440
-29019
lines changed

Some content is hidden

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

789 files changed

+28440
-29019
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,35 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: "[ BUG ]"
4+
title: '[ BUG ]'
55
labels: bug
66
assignees: ''
7-
87
---
98

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+
1023
**Describe the bug**
1124
A clear and concise description of what the bug is.
1225

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
26+
**Steps to reproduce the behavior:**
27+
1528
1. Start the '...' app with '...'
1629
2. Go to '...'
17-
2. Click on '....'
18-
3. Scroll down to '....'
19-
4. See error
30+
3. Click on '....'
31+
4. Scroll down to '....'
32+
5. See error
2033

2134
**Expected behavior**
2235
A clear and concise description of what you expected to happen.
@@ -25,9 +38,21 @@ A clear and concise description of what you expected to happen.
2538
If applicable, add screenshots to help explain your problem.
2639

2740
**Platform (please complete the following information):**
28-
- Type: [eg: Browser, Simulator, Emulator, Device]
29-
- OS: [e.g. iOS]
30-
- Browser (if applies) [e.g. chrome, safari]
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+
```
3156

3257
**Additional context**
3358
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

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

.github/pull_request_template.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
<!--
44
5-
# Important Note:
5+
⚠️ **Important**
66
7-
Please create a [discussion](https://github.com/mrzachnugent/react-native-reusables/discussions/categories/ideas) for any new feature proposals **before** submitting a pull request. This helps ensure alignment with project goals and gather community feedback.
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.
811
912
-->
1013

@@ -18,7 +21,6 @@ Fixes issue #<!-- Add the issue number that this PR fixes, if applicable. -->
1821

1922
<!-- Check the platforms that you have tested this PR on. -->
2023

21-
- [ ] Docs
2224
- [ ] Web
2325
- [ ] iOS
2426
- [ ] Android
@@ -27,8 +29,10 @@ Fixes issue #<!-- Add the issue number that this PR fixes, if applicable. -->
2729

2830
<!-- Specify which apps or packages are affected by this pull request. -->
2931

30-
- [apps/app_x]
31-
- [packages/package_y]
32+
- [ ] apps/docs
33+
- [ ] apps/showcase
34+
- [ ] apps/cli
35+
- [ ] packages/registry
3236

3337
### Screenshots:
3438

.prettierrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"printWidth": 100,
3+
"tabWidth": 2,
4+
"singleQuote": true,
5+
"bracketSameLine": true,
6+
"trailingComma": "es5",
7+
"plugins": ["prettier-plugin-tailwindcss"],
8+
"tailwindFunctions": ["cva"]
9+
}

CODE_OF_CONDUCT.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
1717
Examples of behavior that contributes to a positive environment for our
1818
community include:
1919

20-
* Demonstrating empathy and kindness toward other people
21-
* Being respectful of differing opinions, viewpoints, and experiences
22-
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
2424
and learning from the experience
25-
* Focusing on what is best not just for us as individuals, but for the
25+
- Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

2828
Examples of unacceptable behavior include:
2929

30-
* The use of sexualized language or imagery, and sexual attention or
30+
- The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
32-
* Trolling, insulting or derogatory comments, and personal or political attacks
33-
* Public or private harassment
34-
* Publishing others' private information, such as a physical or email
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
3535
address, without their explicit permission
36-
* Other conduct which could reasonably be considered inappropriate in a
36+
- Other conduct which could reasonably be considered inappropriate in a
3737
professional setting
3838

3939
## Enforcement Responsibilities
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
nugentzn@gmail.com.
63+
hello@foundedlabs.com.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behavior, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within

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: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Contributing to [react-native-reusables](https://github.com/mrzachnugent/react-native-reusables)
1+
# Contributing to React Native Reusables
22

33
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**
7+
> ⚠️ **Important**
88
>
9-
> **If you want to propose a new feature:**
9+
> If you want to propose a new feature:
1010
>
11-
> 1. Make sure to read the [project scope](https://github.com/mrzachnugent/react-native-reusables/discussions/229) to confirm your proposal fits within the vision and purpose of `react-native-reusables`.
12-
> 2. Please open a [new discussion](https://github.com/mrzachnugent/react-native-reusables/discussions) before taking any action. This allows us to collaborate, gather feedback, and ensure alignment with the project's goals.
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.
1313
1414
<br />
1515

@@ -19,10 +19,10 @@ Thank you for your interest in contributing to `react-native-reusables`! We welc
1919
git clone https://github.com/your-username/react-native-reusables.git
2020
cd react-native-reusables
2121
```
22-
3. Create a new branch for your feature or bug fix:
22+
3. Create a new branch:
2323

2424
```bash
25-
git checkout -b feature/your-feature-name
25+
git checkout -b your-username/your-feature-name
2626
```
2727

2828
4. Make your changes and ensure that your code adheres to the existing coding standards.
@@ -35,7 +35,7 @@ git commit -m "Add your commit message here"
3535
6. Push your changes to your forked repository:
3636

3737
```bash
38-
git push origin feature/your-feature-name
38+
git push origin your-username/your-feature-name
3939
```
4040

4141
7. Open a pull request (PR) against the main branch of the original repository.
@@ -48,18 +48,18 @@ Please follow the coding style and guidelines used in the project. If there are
4848
4949
## Issue Tracker
5050

51-
Check the [issue tracker](https://github.com/mrzachnugent/react-native-reusables/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.
5252

5353
## Code of Conduct
5454

55-
Please review and adhere to our [Code of Conduct](https://github.com/mrzachnugent/react-native-reusables/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.
5656

5757
## License
5858

59-
By contributing to this project, you agree that your contributions will be licensed under the [LICENSE](https://github.com/mrzachnugent/react-native-reusables/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.
6060

6161
## Contact
6262

63-
If you have any questions or need further assistance, feel free to contact us at nugentzn@gmail.com.
63+
If you have any questions or need further assistance, feel free to contact us at hello@foundedlabs.com.
6464

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

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Zach Nugent
3+
Copyright (c) 2025 Founded Labs
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

0 commit comments

Comments
 (0)