快速上手

开始之前

使用 FirstUI UNI版前，请确保你已经学习并熟练使用过 uni-app (opens new window)，nvue开发可先查看WEEX文档 (opens new window) 。

安装

方式一 ：通过 npm 安装

使通过 npm 安装，需要先通过 vue-cli 创建 uni-app 项目，详见 。

// # Using npm（目前仅开源组件支持，会员组件需要通过方式二使用）
npm install firstui-uni

注意

通过 npm 安装，建议使用easycom组件规范，在 pages.json 中 添加配置：

"easycom": {
	"autoscan": true,
	"custom": {
		"fui-(.*)": "firstui-uni/firstui/fui-$1/fui-$1.vue"
	}
}

方式二 ：通过下载代码

通过 GitHub 或者 FirstUI官网(VIP) 下载 First UI 的代码，然后 将 components/firstui/ 目录拷贝到自己的项目中。

// # GitHub
git clone https://github.com/FirstUI/FirstUI.git

// # VIP 代码下载：官网个人中心订单处

方式三 ：选择需要的模块引入

下载 First UI 的代码，在 components/firstui/ 目录下找到需要的组件拷贝到自己的项目中。

如何使用

按照以下的方式使用组件，以 Button 为例，其它组件在对应的文档页查看。

第一种：在页面中引用、注册（npm安装建议使用easycom组件规范）

import fuiButton from "@/components/firstui/fui-button/fui-button.vue"
export default {
	components:{
		fuiButton
	}
}

第二种：easycom组件规范

传统vue组件，需要安装、引用、注册，三个步骤后才能使用组件。easycom将其精简为一步，如果不了解easycom，可先查看 官网文档 。

在 pages.json 中 添加配置，确保路径引入正确：

// 下载安装时easycom配置
"easycom": {
		"autoscan": true,
		"custom": {
			"fui-(.*)": "@/components/firstui/fui-$1/fui-$1.vue"
		}
	}

// 使用npm安装时easycom配置（配置完成后重新编译运行）
"easycom": {
		"autoscan": true,
		"custom": {
			"fui-(.*)": "firstui-uni/firstui/fui-$1/fui-$1.vue"
		}
	}

使用组件

引入组件后，可以在 页面 中直接使用组件

<fui-button text="默认按钮"></fui-button>

其他说明

组件示例项目中使用的this.fui.xx 等 api 使用（nvue端暂不支持）。

/*
   1、将文件 fui-app.js 引入项目中（示例中路径 common/fui-app.js）

   2、在根目录main.js 中 引入 fui-app.js，并挂载即可使用
*/

import fui from './common/fui-app'

// #ifndef VUE3
import Vue from 'vue'

Vue.config.productionTip = false
Vue.prototype.fui = fui
App.mpType = 'app'

const app = new Vue({
	store,
	...App
})
app.$mount()
// #endif

// #ifdef VUE3
import {
	createSSRApp
} from 'vue'
export function createApp() {
	const app = createSSRApp(App)
	app.use(store)
	app.config.globalProperties.fui = fui;
	return {
		app
	}
}
// #endif