Skip to content

Commit c1d8b72

Browse files
SyedSohaib456SyedSohaib456
committed
docs: add issue templates, update project documentation, and enhance package metadata
1 parent 0a19262 commit c1d8b72

5 files changed

Lines changed: 102 additions & 7 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve FieldFlow
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Reproduction**
14+
Please provide a minimal code snippet or a link to a Snack/GitHub repo that reproduces the issue.
15+
16+
```tsx
17+
// Your code here
18+
```
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots/Videos**
24+
If applicable, add screenshots or videos to help explain your problem.
25+
26+
**Environment:**
27+
- FieldFlow version: [e.g. 1.1.4]
28+
- Device: [e.g. iPhone 15, Pixel 7]
29+
- OS: [e.g. iOS 17.2, Android 14]
30+
- React Native version: [e.g. 0.73.1]
31+
- Reanimated version: [e.g. 3.6.1]
32+
33+
**Additional context**
34+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for FieldFlow
4+
title: '[FEAT] '
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎README.md‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<br/>
66
<br/>
77

8-
**The keyboard form library React Native should have shipped with.**
8+
**The high-performance keyboard avoidance and focus management library React Native should have shipped with.**
99

1010
<br/>
1111

@@ -15,10 +15,23 @@
1515

1616
<br/>
1717

18+
**react-native-fieldflow** provides a professional-grade, zero-config solution for the three biggest pain points in React Native forms: **Keyboard Avoidance**, **Focus Management (Chaining)**, and **Synced Accessory Views**.
19+
20+
<br/>
21+
1822
> **Zero refs &nbsp;·&nbsp; Zero platform switches &nbsp;·&nbsp; Zero boilerplate**
1923
2024
<br/>
2125

26+
### 🚀 Core MVP Features:
27+
- **Automatic Next-Field Focusing**: Effortless input chaining without manual refs.
28+
- **"Ref to Next" Automation**: Zero-config focus transition from field to field.
29+
- **Synced Accessory Views**: Cross-platform toolbars that move in perfect harmony with the keyboard.
30+
- **Native Keyboard Avoidance**: Smooth, 60fps layout adjustments using Reanimated worklets.
31+
- **Expo Compatible**: Works out-of-the-box with Expo and bare workflows.
32+
33+
<br/>
34+
2235
<table>
2336
<tr>
2437
<td align="center" width="33%" style="padding:32px 20px">
@@ -149,9 +162,9 @@ import { FieldForm, FieldInput } from 'react-native-fieldflow';
149162

150163
## How it works
151164

152-
<div align="center">
165+
<!-- <div align="center">
153166
<img src="media/architecture.png" width="580" alt="FieldFlow internals diagram" />
154-
</div>
167+
</div> -->
155168

156169
<br/>
157170

‎packages/react-native-fieldflow/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,9 @@ import { FieldForm, FieldInput } from 'react-native-fieldflow';
149149

150150
## How it works
151151

152-
<div align="center">
152+
<!-- <div align="center">
153153
<img src="media/architecture.png" width="580" alt="FieldFlow internals diagram" />
154-
</div>
154+
</div> -->
155155

156156
<br/>
157157

‎packages/react-native-fieldflow/package.json‎

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
{
22
"name": "react-native-fieldflow",
3+
"displayName": "FieldFlow",
34
"version": "1.1.4",
4-
"description": "High-performance field flow (keyboard avoidance + focus chaining) for React Native.",
5+
"description": "High-performance React Native keyboard avoidance and zero-config focus chaining. Effortlessly manage form flows with 'ref to next' automation, high-speed focus transitions, and synced accessory views.",
56
"main": "src/index.ts",
67
"types": "src/index.ts",
8+
"sideEffects": false,
79
"files": [
810
"src",
911
"README.md",
@@ -19,7 +21,27 @@
1921
"avoidance",
2022
"scrollview",
2123
"form",
22-
"fieldflow"
24+
"fieldflow",
25+
"reanimated",
26+
"focus-management",
27+
"ref to next",
28+
"focusing next field",
29+
"keyboard-avoidance",
30+
"form-flow",
31+
"autofocus",
32+
"ios",
33+
"android",
34+
"expo-compatible",
35+
"smooth-scrolling",
36+
"keyboard-avoiding-view",
37+
"keyboard-accessory",
38+
"input-focus",
39+
"form-management",
40+
"react-native-form",
41+
"keyboard-manager",
42+
"input-chaining",
43+
"automatic-focus",
44+
"textinput-focus"
2345
],
2446
"author": "Syed Sohaib",
2547
"license": "MIT",
@@ -44,5 +66,11 @@
4466
"react": "19.1.0",
4567
"react-native": "0.81.5",
4668
"typescript": "~5.9.2"
69+
},
70+
"engines": {
71+
"node": ">=18"
72+
},
73+
"publishConfig": {
74+
"access": "public"
4775
}
4876
}

0 commit comments

Comments
 (0)