Skip to content

Latest commit

 

History

History
179 lines (139 loc) · 6.29 KB

react-native-mask-text.md

File metadata and controls

179 lines (139 loc) · 6.29 KB

模板版本：v0.2.2

react-native-mask-text

Supported platforms License

[!TIP] Github 地址

安装与使用

进入到工程目录并输入以下命令：

npm

npm install react-native-mask-text@0.14.2

yarn

yarn add react-native-mask-text@0.14.2

下面的代码展示了这个库的基本使用场景：

[!WARNING] 使用时 import 的库名不变。

import React, { useState } from "react";
import { StyleSheet, Text, View } from "react-native";
import { MaskedTextInput, MaskedText } from "react-native-mask-text";

export default function App() {
	const [maskedValue, setMaskedValue] = useState("");
	const [unMaskedValue, setUnmaskedValue] = useState("");

	const [currencyMaskedValue, setCurrencyMaskedValue] = useState("");
	const [currencyUnMaskedValue, setCurrencyUnmaskedValue] = useState("");

	return (
		<View style={styles.container}>
			<Text style={styles.title}>MaskedTextInput Component:</Text>
			<MaskedTextInput
				mask="AAA-999"
				onChangeText={(text, rawText) => {
					setMaskedValue(text);
					setUnmaskedValue(rawText);
				}}
				style={styles.input}
				keyboardType="numeric"
			/>
			<Text style={styles.paragraph}>Raw Text: {unMaskedValue}</Text>
			<Text style={styles.paragraph}>Masked Text: {maskedValue}</Text>

			<Text style={styles.title}>MaskedTextInput Component with Currency:</Text>
			<MaskedTextInput
				type="currency"
				options={{
					prefix: "$",
					decimalSeparator: ".",
					groupSeparator: ",",
					precision: 2
				}}
				onChangeText={(text, rawText) => {
					setCurrencyMaskedValue(text);
					setCurrencyUnmaskedValue(rawText);
				}}
				style={styles.input}
				keyboardType="numeric"
			/>
			<Text style={styles.paragraph}>Raw Text: {currencyUnMaskedValue}</Text>
			<Text style={styles.paragraph}>Masked Text: {currencyMaskedValue}</Text>

			<Text style={styles.title}>MaskedText Component:</Text>
			<MaskedText mask="99/99/9999" style={styles.paragraph}>
				30081990
			</MaskedText>
		</View>
	);
}

const styles = StyleSheet.create({
	container: {
		flex: 1,
		justifyContent: "center",
		backgroundColor: "#ecf0f1",
		padding: 8
	},
	title: {
		margin: 24,
		fontSize: 24,
		textAlign: "center",
		fontWeight: "bold"
	},
	paragraph: {
		margin: 24,
		fontSize: 18,
		textAlign: "center"
	},
	input: {
		height: 40,
		margin: 12,
		borderWidth: 1
	}
});

约束与限制

兼容性

本文档内容基于以下版本验证通过：

  1. RNOH: 0.72.27; SDK: HarmonyOS-Next-DB1 5.0.0.25; IDE: DevEco Studio 5.0.3.400SP7; ROM: 3.0.0.25;
  2. RNOH：0.72.33; SDK：OpenHarmony 5.0.0.71(API Version 12 Release); IDE：DevEco Studio 5.0.3.900; ROM：NEXT.0.0.71;

属性

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

Name Description Type Default Required Platform HarmonyOS Support
type Show type String (enum) custom, date, time,currency custom no All yes
mask Custom Mask. Pattern used in masked components 9 - accept digit. A - accept alpha. S - accept alphanumeric. null no All yes

Date Mask

These options only are used if you use prop type="date" in your component:

Name Description Type Default Required Platform HarmonyOS Support
dateFormat Date Format string yyyy/mm/dd no All yes

Time Mask

These options only are used if you use prop type="time" in your component:

Name Description Type Default Required Platform HarmonyOS Support
timeFormat Time Format string HH:mm:ss no All yes

Currency Mask

These options only are used if you use prop type="currency" in your component:

Name Description Type Default Required Platform HarmonyOS Support
prefix String to prepend string null No All yes
decimalSeparator Separation for decimals string null No All yes
groupSeparator Grouping separator of the integer part string null No All yes
precision Precision for fraction part (cents) number 0 No All yes
groupSize Primary grouping size of the integer part number 3 No All yes
secondaryGroupSize Secondary grouping size of the integer part number null No All yes
fractionGroupSeparator Grouping separator of the fraction part string null No All yes
fractionGroupSize Grouping size of the fraction part number null No All yes
suffix String to append string null No All yes

遗留问题

其他

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。