Open SmallStoneSK opened 5 years ago
一直以来都想做个组件库,一方面是对工作中常遇问题的总结,另一方面也确实能够提升工作效率(谁又不想造一个属于自己的轮子呢~),于是乎就有了本文的主角儿rn-components-kit。
rn-components-kit
市面上web的UI组件库如此之多,react相关的有antd,vue相关的有element。不过,今天介绍的是react-native的一个组件库。不同于上述组件库都有统一的视觉规范,rn-components-kit更注重的是在提供组件基本能力的同时尽可能多地赋予自定义样式的可能性。
web
react
antd
vue
element
react-native
放上仓库地址,欢迎star,欢迎提issue,欢迎提PR~
star
issue
PR
下面就让我们来认识一下rn-components-kit~
你可以通过下面的命令安装rn-components-kit:
npm install rn-components-kit --save
import React from 'react'; import {Badge} from ' @rn-components-kit/badge'; const TestComponent = () => <Badge/>;
上述的方法将会把所有的组件打进bundle内,即使你没有用到所有的组件。如果你想减少包大小,你可以这样引入:
bundle
npm install @rn-components-kit/badge --save
事实上,每个组件都是支持单独安装的,我们也推荐你使用这种方式引入组件。
我们创建了一个app专门用来演示每个组件的使用方法以及运行效果,你可以点击这里查看示例代码。如果你想运行这个例子,你需要先下载本仓库到本地。
app
# download repo git clone https://github.com/SmallStoneSK/rn-components-kit.git # install dependencies npm install # for iOS react-native run-ios # for android react-native run-android
以下是运行示例app后各界面的截图:
图标右上角的圆形徽标数字。支持以下特性:
详细API请查看文档
按钮组件,支持以下特性:
default
primary
success
warning
danger
small
large
square
round
icon
outline
block
link
npm install @rn-components-kit/button --save
轮播组件,就像"旋转木马"一样。支持以下特性:
注意
水平
width
itemWidth
垂直
height
itemHeight
data
npm install @rn-components-kit/carousel --save
复选框组件。
npm install @rn-components-kit/checkbox --save
DeckSwiper让你一次评估一个选项,而不是从一组选项中进行选择。
npm install @rn-components-kit/deck-swiper --save
分割线组件,支持两种方向: horizontal 和 vertical.
horizontal
vertical
npm install @rn-components-kit/divider --save
语义化的矢量图形。支持以下特性:
注意:确保你的项目已经集成了ART模块
如果你遇到诸如No component found for view with name "ARTXXX"之类的报错,那是因为你的项目还没有集成ART模块。你需要:
No component found for view with name "ARTXXX"
ART
Libraries
Add Files to
node_modules/react-native/Libraries/ART/ART.xcodeproj
Linked Frameworks and Libraries
+
libART.a
react-native run-ios/android
npm install @rn-components-kit/icon --save
进度条组件,展示当前操作进度,支持以下特性:
line
circle
normal
active
fail
由于本组件支持线性渐变选项,所以你的项目需要集成react-native-linear-gradient。如果你的项目还没集成,你可以参照这里的指示完成。
react-native-linear-gradient
npm install @rn-components-kit/progress --save
Radio组件让用户从一堆选项中选择一项,支持以下特性:
npm install @rn-components-kit/radio --save
评分组件,支持以下特性:
点选
滑动
类型
颜色
大小
npm install @rn-components-kit/rating --save
滚动选择器,支持以下特性:
Android
iOS
ScrollPicker.Item
npm install @rn-components-kit/scroll-picker --save
骨架屏,常在loading时起占位的作用,支持以下特性:
loading
avatar
title
paragraph
withSkeleton
当你使用装饰器的语法使用高阶组件withSkeleton时,确保你的项目安装了插件@babel/plugin-proposal-decorators.
装饰器
@babel/plugin-proposal-decorators
npm install @rn-components-kit/skeleton --save
以滑动的交互形式,从指定范围内选择值。支持以下特性:
1
2
npm install @rn-components-kit/slider --save
用于展示页面或区块的加载中状态。支持以下7种不同动画类型:
Ladder
Rainbow
Wave
RollingCubes
ChasingCircles
Pulse
FlippingCard
npm install @rn-components-kit/spin --save
iOS样式的滑动隐藏按钮组件,支持以下特性:
左
右
npm install @rn-components-kit/swipe-out --save
开关选择器,支持以下特性:
cupertino
material
npm install @rn-components-kit/switch --save
进行标记和分类的小标签。支持以下特性:
solid
npm install @rn-components-kit/tag --save
当用户点击某个元素,展示一个气泡框,支持以下特性:
top
bottom
npm install @rn-components-kit/tooltip --save
最后再次放上仓库地址,欢迎star,欢迎提issue,欢迎提PR~
你也可以关注我的Blog,欢迎一起交流学习~
大哥哥,你好久没更文章了~
1. 前言
一直以来都想做个组件库,一方面是对工作中常遇问题的总结,另一方面也确实能够提升工作效率(谁又不想造一个属于自己的轮子呢~),于是乎就有了本文的主角儿
rn-components-kit
。市面上
web
的UI组件库如此之多,react
相关的有antd
,vue
相关的有element
。不过,今天介绍的是react-native
的一个组件库。不同于上述组件库都有统一的视觉规范,rn-components-kit
更注重的是在提供组件基本能力的同时尽可能多地赋予自定义样式的可能性。放上仓库地址,欢迎
star
,欢迎提issue
,欢迎提PR
~下面就让我们来认识一下
rn-components-kit
~2. 快速开始
2.1 安装
你可以通过下面的命令安装
rn-components-kit
:2.2 按需加载
上述的方法将会把所有的组件打进
bundle
内,即使你没有用到所有的组件。如果你想减少包大小,你可以这样引入:事实上,每个组件都是支持单独安装的,我们也推荐你使用这种方式引入组件。
2.3 运行示例
我们创建了一个
app
专门用来演示每个组件的使用方法以及运行效果,你可以点击这里查看示例代码。如果你想运行这个例子,你需要先下载本仓库到本地。以下是运行示例app后各界面的截图:
3. 组件
3.1 Badge
图标右上角的圆形徽标数字。支持以下特性:
详细API请查看文档
3.2 Button
按钮组件,支持以下特性:
default
,primary
,success
,warning
和danger
5种主题small
,default
和large
3种大小square
,default
和round
3种形状icon
按钮和控制图标位置outline
样式按钮block
样式按钮link
样式按钮详细API请查看文档
3.3 Carousel
轮播组件,就像"旋转木马"一样。支持以下特性:
注意
水平
模式时,width
和itemWidth
必须设置。垂直
模式时,height
和itemHeight
必须设置。data
属性,不然轮播组件中的内容将不会更新。详细API请查看文档
3.4 CheckBox
复选框组件。
详细API请查看文档
3.5 DeckSwiper
DeckSwiper让你一次评估一个选项,而不是从一组选项中进行选择。
详细API请查看文档
3.6 Divider
分割线组件,支持两种方向:
horizontal
和vertical
.详细API请查看文档
3.7 Icon
语义化的矢量图形。支持以下特性:
注意:确保你的项目已经集成了ART模块
如果你遇到诸如
No component found for view with name "ARTXXX"
之类的报错,那是因为你的项目还没有集成ART
模块。你需要:Libraries
->Add Files to
->node_modules/react-native/Libraries/ART/ART.xcodeproj
。Linked Frameworks and Libraries
,点击+
选择libART.a
,然后重新编译工程。react-native run-ios/android
,重启项目。详细API请查看文档
3.8 Progress
进度条组件,展示当前操作进度,支持以下特性:
line
和circle
两种类型normal
,active
,success
和fail
四种状态line
类型)注意
由于本组件支持线性渐变选项,所以你的项目需要集成
react-native-linear-gradient
。如果你的项目还没集成,你可以参照这里的指示完成。详细API请查看文档
3.9 Radio
Radio组件让用户从一堆选项中选择一项,支持以下特性:
详细API请查看文档
3.10 Rating
评分组件,支持以下特性:
点选
和滑动
操作进行评分类型
,颜色
,大小
)详细API请查看文档
3.11 ScrollPicker
滚动选择器,支持以下特性:
Android
和iOS
平台的交互差异ScrollPicker.Item
支持自定义选项内容详细API请查看文档
3.12 Skeleton
骨架屏,常在
loading
时起占位的作用,支持以下特性:avatar
,title
,paragraph
三部分均支持定制化withSkeleton
完全定制化骨架屏的组成和样式注意
当你使用
装饰器
的语法使用高阶组件withSkeleton
时,确保你的项目安装了插件@babel/plugin-proposal-decorators
.详细API请查看文档
3.13 Slider
以滑动的交互形式,从指定范围内选择值。支持以下特性:
水平
或垂直
两种方向1
或2
个滑块详细API请查看文档
3.14 Spin
用于展示页面或区块的加载中状态。支持以下7种不同动画类型:
Ladder
Rainbow
Wave
RollingCubes
ChasingCircles
Pulse
FlippingCard
详细API请查看文档
3.15 SwipeOut
iOS样式的滑动隐藏按钮组件,支持以下特性:
左
和右
两个方向滑出详细API请查看文档
3.16 Switch
开关选择器,支持以下特性:
cupertino
和material
详细API请查看文档
3.17 Tag
进行标记和分类的小标签。支持以下特性:
outline
和solid
详细API请查看文档
3.18 Tooltip
当用户点击某个元素,展示一个气泡框,支持以下特性:
top
和bottom
两个方向详细API请查看文档
4. 写在最后
最后再次放上仓库地址,欢迎
star
,欢迎提issue
,欢迎提PR
~你也可以关注我的Blog,欢迎一起交流学习~