Skip to content

Commit adceb7f

Browse files
ajkshfjkajmaikai (A)
andauthored
style: 按照模板修改readme文档 (#18)
Co-authored-by: maikai (A) <mWX1352063@china.huawei.com>
1 parent 1390eb6 commit adceb7f

File tree

2 files changed

+183
-191
lines changed

2 files changed

+183
-191
lines changed

LICENSE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

README.md

Lines changed: 7 additions & 191 deletions
Original file line numberDiff line numberDiff line change
@@ -1,197 +1,13 @@
1-
# react-native-picker
1+
# @react-native-oh-tpl/react-native-picker
22

3-
[![npm version](https://img.shields.io/npm/v/react-native-picker.svg?style=flat-square)](https://www.npmjs.com/package/react-native-picker) <a href="https://david-dm.org/beefe/react-native-picker"><img src="https://david-dm.org/beefe/react-native-picker.svg?style=flat-square" alt="dependency status"></a>
3+
This project is based on [react-native-picker](https://github.com/beefe/react-native-picker)
44

5-
![ui3](./doc/ui3.jpg)
6-
![ui4](./doc/ui4.jpg)
5+
## Documentation
76

8-
### Documentation
7+
- [中文](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-picker.md)
98

10-
#### Params
9+
- [English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/en/react-native-picker.md)
1110

12-
|Key | Type | Default| Support | Description |
13-
| --- | --- | ---- | ------ | ----------- |
14-
|isLoop | Boolean | false | Android | |
15-
|pickerTextEllipsisLen | number | 6 | Android | |
16-
|pickerConfirmBtnText | string | confirm | iOS/Android | |
17-
|pickerCancelBtnText | string | cancel | iOS/Android | |
18-
|pickerTitleText | string | pls select | iOS/Android | |
19-
|pickerConfirmBtnColor | array | [1, 186, 245, 1] | iOS/Android | |
20-
|pickerCancelBtnColor | array | [1, 186, 245, 1] | iOS/Android | |
21-
|pickerTitleColor | array | [20, 20, 20, 1] | iOS/Android | |
22-
|pickerToolBarBg | array | [232, 232, 232, 1] | iOS/Android | |
23-
|pickerBg | array | [196, 199, 206, 1] | iOS/Android | |
24-
|pickerToolBarFontSize | number | 16 | iOS/Android | |
25-
|wheelFlex | array | [1, 1, 1] | iOS/Android | |
26-
|pickerFontSize | number | 16 | iOS/Android | |
27-
|pickerFontColor | array | [31, 31, 31, 1] | iOS/Android | |
28-
|pickerFontFamily | string | | iOS/Android | |
29-
|pickerRowHeight | number | 24 | iOS | |
30-
|pickerData | array | | iOS/Android | |
31-
|selectedValue | array | | iOS/Android | |
32-
|onPickerConfirm | function| | iOS/Android | |
33-
|onPickerCancel | function| | iOS/Android | |
34-
|onPickerSelect | function| | iOS/Android | |
11+
## License
3512

36-
#### Methods
37-
38-
|Key | Support | Description |
39-
| --- | ---- | ----------- |
40-
|init | iOS/Android |init and pass parameters to picker |
41-
|toggle | iOS/Android |show or hide picker |
42-
|show | iOS/Android |show picker |
43-
|hide | iOS/Android |hide picker |
44-
|select | iOS/Android |select a row |
45-
|isPickerShow | iOS/Android |get status of picker, return a boolean |
46-
47-
48-
### Usage
49-
50-
#### Step 1 - install
51-
52-
```javascript
53-
npm install react-native-picker --save
54-
```
55-
56-
#### Step 2 - link
57-
58-
```
59-
react-native link
60-
```
61-
62-
#### Step 3 - import and use in project
63-
64-
```javascript
65-
import Picker from 'react-native-picker';
66-
let data = [];
67-
for(var i=0;i<100;i++){
68-
data.push(i);
69-
}
70-
71-
Picker.init({
72-
pickerData: data,
73-
selectedValue: [59],
74-
onPickerConfirm: data => {
75-
console.log(data);
76-
},
77-
onPickerCancel: data => {
78-
console.log(data);
79-
},
80-
onPickerSelect: data => {
81-
console.log(data);
82-
}
83-
});
84-
Picker.show();
85-
86-
```
87-
88-
### Integration With Existing Apps (`iOS`)
89-
The `Podfile` will like below:
90-
``` ruby
91-
platform :ios, '8.0'
92-
target 'YourTarget' do
93-
pod 'React', :path => '../YOUR_REACT_NATIVE_PROJECT/node_modules/react-native', :subspecs => [
94-
'Core',
95-
...
96-
]
97-
pod 'Picker', :path => '../YOUR_REACT_NATIVE_PROJECT/node_modules/react-native-picker'
98-
end
99-
```
100-
After you have updated the `Podfile` of the existing app, you can install `react-native-picker` like below:
101-
``` bash
102-
$ pod install
103-
```
104-
105-
### Notice
106-
107-
#### support two modes:
108-
109-
<b>1. parallel:</b> such as time picker, wheels have no connection with each other
110-
111-
<b>2. cascade:</b> such as date picker, address picker .etc, when front wheel changed, the behind wheels will all be reset
112-
113-
#### parallel:
114-
115-
- single wheel:
116-
117-
```javascript
118-
pickerData = [1,2,3,4];
119-
selectedValue = 3;
120-
```
121-
122-
- two or more wheel:
123-
124-
```javascript
125-
pickerData = [
126-
[1,2,3,4],
127-
[5,6,7,8],
128-
...
129-
];
130-
selectedValue = [1, 5];
131-
```
132-
133-
#### cascade:
134-
135-
- two wheel
136-
137-
```javascript
138-
pickerData = [
139-
{
140-
a: [1, 2, 3, 4]
141-
},
142-
{
143-
b: [5, 6, 7, 8]
144-
},
145-
...
146-
];
147-
selectedValue = ['a', 2];
148-
```
149-
150-
- three wheel
151-
152-
```javascript
153-
pickerData = [
154-
{
155-
a: [
156-
{
157-
a1: [1, 2, 3, 4]
158-
},
159-
{
160-
a2: [5, 6, 7, 8]
161-
},
162-
{
163-
a3: [9, 10, 11, 12]
164-
}
165-
]
166-
},
167-
{
168-
b: [
169-
{
170-
b1: [11, 22, 33, 44]
171-
},
172-
{
173-
b2: [55, 66, 77, 88]
174-
},
175-
{
176-
b3: [99, 1010, 1111, 1212]
177-
}
178-
]
179-
},
180-
{
181-
c: [
182-
{
183-
c1: ['a', 'b', 'c']
184-
},
185-
{
186-
c2: ['aa', 'bb', 'cc']
187-
},
188-
{
189-
c3: ['aaa', 'bbb', 'ccc']
190-
}
191-
]
192-
},
193-
...
194-
]
195-
```
196-
197-
### For pure javascript version -> [v3.0.5](https://github.com/beefe/react-native-picker/tree/pure-javascript-version)
13+
This library is licensed under [Apache License 2.0](https://github.com/react-native-oh-library/react-native-picker/blob/sig/LICENSE)

0 commit comments

Comments
 (0)