ReactNative在npm上发布自己的组件库

一、组件库使用方式

npm install --save 组件库名称

二、创建组件库

1、安装 react-native-create-library
npm install -g react-native-create-library
2、创建组件模板
react-native-create-library --package-identifier com.rabbits.ui --platforms android,ios rabbits-ui
  • 操作符说明
Usage: react-native-create-library [options] <name>

Options:

  -h, --help                                output usage information
  -V, --version                             output the version number
  -p, --prefix <prefix>                     The prefix for the library (Default: `RN`)
  --module-prefix <modulePrefix>            The module prefix for the library (Default: `react-native`)
  --package-identifier <packageIdentifier>  (Android only!) The package name for the Android module (Default: `com.reactlibrary`)
  --namespace <namespace>                   (Windows only!) The namespace for the Windows module
   (Default: The name as PascalCase)
  --platforms <platforms>                   Platforms the library will be created for. (comma separated; default: `ios,android,windows`)
  --github-account <github_account>         The github account where the library is hosted (Default: `github_account`)
  --author-name <name>                      The author's name (Default: `Your Name`)
  --author-email <email>                    The author's email (Default: `yourname@email.com`)
  --license <license>                       The license type of this library (Default: `Apache-2.0`)
  --generate-example <shouldGenerate>       Will generate a RN example project and link the new library to it (Default: `false`)
  • 项目结构
└── react-native-rabbits-ui
    ├── .gitignore        // git忽略文件
    ├── .npmignore        // npm忽略文件
    ├── README.md
    ├── android
    │   ├── build.gradle
    │   └── src
    │       └── main
    │           ├── AndroidManifest.xml
    │           └── java
    │               └── com
    │                   └── rabbits
    │                       └── ui
    │                           ├── RNRabbitsUiModule.java
    │                           └── RNRabbitsUiPackage.java
    ├── index.js
    ├── ios
    │   ├── RNRabbitsUi.h
    │   ├── RNRabbitsUi.m
    │   ├── RNRabbitsUi.podspec
    │   ├── RNRabbitsUi.xcodeproj
    │   │   └── project.pbxproj
    │   └── RNRabbitsUi.xcworkspace
    │       └── contents.xcworkspacedata
    └── package.json

.gitignore.npmignore根据自己需求选择自创建

3、编写组件代码
  • 在根目录创建 src 文件夹,创建自己组件 js 文件,这里创建一个名为 TouchableRabbit 的组件,代码如下:
/**
 * 防抖按钮
 * @author lawrence
 */
import React, {PureComponent} from "react";
import {TouchableOpacity, ViewPropTypes} from "react-native";

type Props = {
    effectTime: number,                     // 防抖时间
    disabledStyle: ViewPropTypes.style      // 按钮未激活样式
}

type State = {}

const DEBOUNCE_MILLISECOND = 300;   // 多次点击,响应间隔时间

export default class TouchableRabbit extends PureComponent<Props, State> {

    static defaultProps = {
        effectTime: DEBOUNCE_MILLISECOND,
        disableStyle: null,
    };

    _lastClickTime = 0;    // 最后一次点击按钮时间

    render() {
        const {disabled, disabledStyle, onPress, style, activeOpacity} = this.props;
        return (
            <TouchableOpacity
                {...this.props}
                style={disabled ? disabledStyle : style}
                activeOpacity={activeOpacity ? activeOpacity : 0.8}
                onPress={() => !disabled && this._debouncePress(onPress)}
            >
                {this.props.children}
            </TouchableOpacity>
        )
    }

    _enable = () => {
        const {props: {effectTime}, _lastClickTime} = this;
        const time = Date.now();
        const enable = !_lastClickTime || Math.abs(_lastClickTime - time) > effectTime;
        enable && (this._lastClickTime = time);
        return enable;
    };

    _debouncePress = onPress => {
        this._enable() && !!onPress && onPress();
    }

}

  • 在根目录 index.js 中导出,代码如下:
/**
 * 组件导出
 * @author lawrence
 */
import TouchableRabbit from "./src/TouchableRabbit";

export {
    TouchableRabbit
}
  • 项目中使用方式
import {TouchableRabbit} from "react-native-rabbits-ui";

export default class App extends Component<Props> {
    render() {
        return (
            <TouchableRabbit effectTime={400} onPress={()=>{}}
                style={styles.enable} disabledStyle={styles.disable} disabled>
                ......其他组件
            </TouchableRabbit>
        );
    }
}

三、在 npm 上发布组件

1、修改根目录中 package.json 文件,以组件库react-native-rabbits-ui 为例,内容如下:
{
  "name": "react-native-rabbits-ui",
  "version": "1.0.0",
  "description": "common component library for android and iOS",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "react",
    "react-native"
  ],
  "author": "lawrence",
  "license": "MIT",
  "devDependencies": {},
  "peerDependencies": {
    "react": ">=16.0.0",
    "react-native": ">=0.55.0",
    "prop-types": ">=15.0.0"
  }
}
2、上传npm
1、注册账号 https://www.npmjs.com/
2、终端执行命令npm adduser --registry http://registry.npmjs.org
3、根据提示输入第一步中注册好的账号、密码、邮箱
4、将当前路径切换到要发布的模板的文件夹中(保证有package.json文件)
5、终端执行命令npm publish --registry http://registry.npmjs.org进行发布
6、发布成功后通过【https://www.npmjs.com/+ 组件名 】可以在网页访问

四、本地测试

测试方法很多,这里只提供一种。

yarn add file:../react-native-rabbits-ui
react-native link react-native-rabbits-ui
  • yarn add + 路径 会自动将 react-native-rabbits-ui内容拷贝到 node_modules 目录下
  • react-native link + 组件名称 会自动将 react-native-rabbits-ui 中的androidiOS原生代码链接到项目中

执行命令后,会在 package.json 中增加一行 "react-native-rabbits-ui": "file:../react-native-rabbits-ui" 依赖,如下:

{
  "name": "RabbitsUiExample",
  "version": "0.0.1",
  "private": true,
  "scripts": {
    "start": "node node_modules/react-native/local-cli/cli.js start",
    "test": "jest"
  },
  "dependencies": {
    "react": "16.8.3",
    "react-native": "0.59.1",
    "react-native-rabbits-ui": "file:../react-native-rabbits-ui"
  },
  "devDependencies": {
    "@babel/core": "^7.3.4",
    "@babel/runtime": "^7.3.4",
    "babel-jest": "^24.5.0",
    "jest": "^24.5.0",
    "metro-react-native-babel-preset": "^0.53.1",
    "react-test-renderer": "16.8.3"
  },
  "jest": {
    "preset": "react-native"
  }
}

到这里创建自己的npm组件库就算结束
组件库示例代码:https://gitee.com/ak-star/rn-rabbits-ui

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342