persian-number-input 1.0.0 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +137 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,9 +1,143 @@
|
|
|
1
|
-
# Persian Number Input
|
|
1
|
+
# Persian Number Input
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
🌟 **React Persian Number Input Component**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
[فارسی 🇮🇷](#-فارسی) | [English 🇺🇸](#-english)
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## 🇮🇷 فارسی
|
|
12
|
+
|
|
13
|
+
کامپوننت React برای ورودی اعداد فارسی، انگلیسی و هندی با قابلیت جداکننده ارقام و محلیسازی کامل.
|
|
14
|
+
|
|
15
|
+
✅ **امکانات کلیدی:**
|
|
16
|
+
|
|
17
|
+
- پشتیبانی از اعداد فارسی، انگلیسی و هندی
|
|
18
|
+
- قابلیت تعیین جداکننده ارقام دلخواه (هزارگان)
|
|
19
|
+
- تبدیل خودکار اعداد محلی به اعداد انگلیسی
|
|
20
|
+
- استفاده آسان و پشتیبانی از React نسخههای 16 تا 19
|
|
21
|
+
|
|
22
|
+
### 🚀 نصب
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install persian-number-input
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### 💻 روش استفاده
|
|
29
|
+
|
|
30
|
+
مثال ساده:
|
|
31
|
+
|
|
32
|
+
```jsx
|
|
33
|
+
import React, { useState } from "react";
|
|
34
|
+
import PersianNumberInput from "persian-number-input";
|
|
35
|
+
|
|
36
|
+
const App = () => {
|
|
37
|
+
const [number, setNumber] = useState("");
|
|
38
|
+
|
|
39
|
+
return (
|
|
40
|
+
<PersianNumberInput
|
|
41
|
+
initialValue="123456"
|
|
42
|
+
separatorCount={3}
|
|
43
|
+
lang="fa"
|
|
44
|
+
onChangeValue={(val) => setNumber(val)}
|
|
45
|
+
/>
|
|
46
|
+
);
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
export default App;
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### 🔥 مثال خروجی
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
ورودی: 123456
|
|
56
|
+
خروجی نمایشی: ۱۲۳,۴۵۶
|
|
57
|
+
خروجی انگلیسی: 123456
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### 📚 مشخصات Props
|
|
61
|
+
|
|
62
|
+
| نام | نوع | پیشفرض | توضیح |
|
|
63
|
+
| -------------- | ------------------------------- | ------ | -------------------------------- |
|
|
64
|
+
| initialValue | string | "" | مقدار اولیه |
|
|
65
|
+
| separatorCount | number | 0 | تعداد ارقام جداشده (مثلاً ۳ رقم) |
|
|
66
|
+
| separatorChar | string | "," | کاراکتر جداکننده (مانند `,`) |
|
|
67
|
+
| lang | 'fa' \| 'in' \| 'en' | "fa" | زبان نمایش ارقام |
|
|
68
|
+
| onChangeValue | (englishNumber: string) => void | - | فراخوانی در تغییر مقدار |
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## 🇺🇸 English
|
|
73
|
+
|
|
74
|
+
React component to input numbers in Persian, Indic, or English with customizable digit separators and full localization.
|
|
75
|
+
|
|
76
|
+
✅ **Key Features:**
|
|
77
|
+
|
|
78
|
+
- Support for Persian, English, and Indic digits
|
|
79
|
+
- Customizable digit grouping separators
|
|
80
|
+
- Automatically converts localized digits to English
|
|
81
|
+
- Easy-to-use API supporting React versions 16 to 19
|
|
82
|
+
|
|
83
|
+
### 🚀 Installation
|
|
6
84
|
|
|
7
85
|
```bash
|
|
8
86
|
npm install persian-number-input
|
|
9
87
|
```
|
|
88
|
+
|
|
89
|
+
### 💻 Usage Example
|
|
90
|
+
|
|
91
|
+
Simple usage:
|
|
92
|
+
|
|
93
|
+
```jsx
|
|
94
|
+
import React, { useState } from "react";
|
|
95
|
+
import PersianNumberInput from "persian-number-input";
|
|
96
|
+
|
|
97
|
+
const App = () => {
|
|
98
|
+
const [number, setNumber] = useState("");
|
|
99
|
+
|
|
100
|
+
return (
|
|
101
|
+
<PersianNumberInput
|
|
102
|
+
initialValue="123456"
|
|
103
|
+
separatorCount={3}
|
|
104
|
+
lang="fa"
|
|
105
|
+
onChangeValue={(val) => setNumber(val)}
|
|
106
|
+
/>
|
|
107
|
+
);
|
|
108
|
+
};
|
|
109
|
+
|
|
110
|
+
export default App;
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
### 🔥 Output Example
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
Input: 123456
|
|
117
|
+
Displayed Output: ۱۲۳,۴۵۶
|
|
118
|
+
English Output: 123456
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### 📚 Props Reference
|
|
122
|
+
|
|
123
|
+
| Name | Type | Default | Description |
|
|
124
|
+
| -------------- | ------------------------------- | ------- | ------------------------------------ |
|
|
125
|
+
| initialValue | string | "" | Initial input value |
|
|
126
|
+
| separatorCount | number | 0 | Number of digits per group (e.g., 3) |
|
|
127
|
+
| separatorChar | string | "," | Digit grouping character |
|
|
128
|
+
| lang | 'fa' \| 'in' \| 'en' | "fa" | Digit localization language |
|
|
129
|
+
| onChangeValue | (englishNumber: string) => void | - | Callback function on value change |
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
### 📈 SEO Keywords
|
|
134
|
+
|
|
135
|
+
`Persian Number Input`, `React Persian input`, `localization`, `digit grouping`, `Persian digits`, `React numeric input`, `number formatter`
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
### 📄 License
|
|
140
|
+
|
|
141
|
+
[MIT License](LICENSE)
|
|
142
|
+
|
|
143
|
+
© 2024 Your Name. All rights reserved.
|
package/package.json
CHANGED