omi/README.CN.md

704 lines
24 KiB
Markdown
Raw Normal View History

2019-05-26 09:08:12 +08:00
[English](./README.md) | 简体中文
2018-10-15 10:19:45 +08:00
2020-04-26 22:30:14 +08:00
<p align="center"><img src="https://tencent.github.io/omi/assets/logo.svg" alt="omi" width="100"/></p>
2021-07-30 17:36:23 +08:00
<h2 align="center">Omi - 前端跨框架跨平台框架</h2>
2018-10-15 09:45:24 +08:00
2021-08-19 12:53:17 +08:00
> Omiu - 使用 Omi 打造的跨框架、[跨主题](https://omi.cdn-go.cn/admin/latest/index.html#/docs/theme) UI 组件库
* [💯国内加速访问 Omi Admin](https://omi.cdn-go.cn/admin/latest/index.html)
* [💯Omiu 打造的 Omi Admin](https://tencent.github.io/omi/packages/admin/dist/index.html)
2021-06-11 09:36:49 +08:00
2021-06-24 18:10:45 +08:00
使用 TypeScript 开发跨框架的按钮组件:
2021-06-11 09:36:49 +08:00
```ts
import { tag, WeElement, h, extractClass } from 'omi'
import * as css from './index.scss'
interface Props {
size?: 'medium' | 'small' | 'mini',
type?: 'primary' | 'success' | 'warning' | 'danger' | 'info' | 'text'
plain?: boolean,
round?: boolean,
circle?: boolean,
loading?: boolean,
disabled?: boolean,
icon?: string,
autofocus?: boolean,
nativeType?: 'button' | 'submit' | 'reset',
block?: boolean
text?: string
}
@tag('o-button')
export default class Button extends WeElement<Props>{
static css = css
static defaultProps = {
plain: false,
round: false,
circle: false,
loading: false,
disabled: false,
autofocus: false,
nativeType: 'button',
block: false
}
static propTypes = {
size: String,
type: String,
plain: Boolean,
round: Boolean,
circle: Boolean,
loading: Boolean,
disabled: Boolean,
icon: String,
autofocus: Boolean,
nativeType: String,
block: Boolean,
text: String
}
render(props) {
return <button disabled={props.disabled} {...extractClass(props, 'o-button', {
['o-button-' + props.type]: props.type,
['o-button-' + props.size]: props.size,
'is-plain': props.plain,
'is-round': props.round,
'is-circle': props.circle,
'is-disabled': props.disabled,
'is-block': props.block
})} type={props.nativeType} >
{props.loading && <i class='icon-loading'></i>}
{props.text}
<slot></slot>
</button>
}
}
```
2021-08-05 18:52:10 +08:00
## 快速开始开发项目
```bash
$ npm i omi-cli -g # install cli
$ omi init my-app # 初始化项目,也可以在空目录里执行 'omi init'
$ cd my-app # 如果在空目录里执行 'omi init' 忽略这条命令
$ npm start # 开发
$ npm run build # 编译发布
```
> `npx omi-cli init my-app` 也支持(要求 npm v5.2.0+)
## 快速开始开发跨框架组件
```bash
$ npm i omi-cli -g # install cli
$ omi init-component my-component # 初始化项目,也可以在空目录里执行 'omi init'
$ cd my-app # 如果在空目录里执行 'omi init' 忽略这条命令
$ npm start # 开发
$ npm run build # 编译发布
```
> `npx omi-cli init-component my-component` 也支持(要求 npm v5.2.0+)
2018-11-05 14:47:11 +08:00
## Omi 生态
2018-12-24 10:16:10 +08:00
[→ Omi 生态学习路线图](https://github.com/Tencent/omi/tree/master/assets/rm.md)
2018-12-24 10:06:38 +08:00
2019-04-05 15:51:49 +08:00
#### 基础生态
2018-11-05 14:47:11 +08:00
| **项目** | **描述** |
| ------------------------------- | ----------------------------------- |
2019-10-02 08:14:54 +08:00
| [omi-docs](https://tencent.github.io/omi/site/docs/cn.html) 和 [例子](https://codepen.io/collection/DrMYgV/) 和 [webcomponents.dev](https://webcomponents.dev/)| Omi 官方文档 |
2019-04-28 14:35:22 +08:00
| [omi-router ](https://github.com/Tencent/omi/tree/master/packages/omi-router) |Omi 官方路由,超级小的尺寸,只有 1KB 的 js|
| [omi-cli](https://github.com/Tencent/omi/tree/master/packages/omi-cli)| 项目脚手架工具,各种模板任你选 [→ 基础模板](https://github.com/Tencent/omi/tree/master/packages/omi-cli/template) |
2021-06-23 21:23:31 +08:00
| [CEE](https://omijs.github.io/cee/out/)| custom-elements-everywhere 评分 |
2021-06-23 21:20:31 +08:00
2019-08-22 10:56:19 +08:00
#### Snake MVP
| **Project** | **Description** |
| ------------------------------- | ----------------------------------- |
2019-11-04 12:31:44 +08:00
| [omi-snake![](https://dntzhang.github.io/cax/asset/hot.png) ](https://github.com/Tencent/omi/tree/master/packages/omi-snake)| omi 写的 MVP 架构的贪吃蛇游戏 |
2019-11-09 09:36:56 +08:00
| [omi-kbone-snake![](https://dntzhang.github.io/cax/asset/hot.png) ](https://github.com/Tencent/omi/tree/master/packages/omi-kbone)| omi-kbone 写的 MVP 架构的跨端贪吃蛇游戏,支持小程序和 H5 |
2019-11-04 12:33:36 +08:00
| [Preact-snake](https://github.com/Tencent/omi/tree/master/packages/preact-css/examples/snake) & [→ Touch the demo](https://tencent.github.io/omi/packages/preact-css/examples/snake/build/)| Preact + [Preact-CSS](https://github.com/Tencent/omi/tree/master/packages/preact-css) + Omis 写的贪吃蛇 |
| [[P]react-snake ](https://github.com/Tencent/omi/tree/master/packages/react-snake) & [→ Touch the demo](https://tencent.github.io/omi/packages/react-snake/build/index.html)| react/preact 写的 MVP 架构的贪吃蛇游戏 |
2019-11-04 12:31:44 +08:00
| [omix-snake![](https://dntzhang.github.io/cax/asset/hot.png)](https://github.com/Tencent/omi/tree/master/packages/omix-snake) | Omix 写的 MVP 架构贪吃蛇 |
2021-05-17 13:37:04 +08:00
<!-- | [vue-snake](https://github.com/Tencent/omi/tree/master/packages/vue-snake) | Vue + Omiv 写的 MVP 架构的贪吃蛇游戏 | -->
2019-08-22 10:56:19 +08:00
2019-04-05 15:51:49 +08:00
#### 其他
| **项目** | **描述** |
| ------------------------------- | ----------------------------------- |
2019-11-04 12:31:44 +08:00
| [omi-piano![](https://dntzhang.github.io/cax/asset/hot.png)](https://github.com/Wscats/piano) |Omi 钢琴, [开始演奏吧!](https://wscats.github.io/piano/build/)|
| [omi-devtools](https://github.com/f/omi-devtools)| 谷歌浏览器开发工具扩展|
2019-02-27 15:45:44 +08:00
| [md2site](https://tencent.github.io/omi/assets/md2site/)| 用 markdown 生成静态网站文档.|
2018-12-19 11:25:40 +08:00
| [omi-chart](https://github.com/Tencent/omi/tree/master/packages/omi-chart)| 一个 chart-x 标签搞定报表|
| [omi-30-seconds](https://github.com/Tencent/omi/tree/master/packages/omi-30-seconds)| 30 秒理解一段有用的 Omi 代码片段.|
2019-02-26 20:19:16 +08:00
| [omi-swiper](https://github.com/loo41/Omi-Swiper)| Omi + Swiper |
2019-08-18 22:02:49 +08:00
| [omi-vscode](https://github.com/ZainChen/omi-vscode)| VSCode extension for omi, [Install now!](https://marketplace.visualstudio.com/items?itemName=ZainChen.omi) |
2018-12-11 14:06:36 +08:00
| [omi-sprite](https://github.com/Tencent/omi/tree/master/packages/omi-sprite)| Web Components, JSX 和 Canvas 的完美融合|
2018-11-26 13:09:56 +08:00
| [omi-canvas](https://github.com/Tencent/omi/tree/master/packages/omi-canvas)| Web Components, JSX 和 Canvas 的完美融合|
2018-12-09 15:46:37 +08:00
| [omi-ex](https://github.com/Tencent/omi/tree/master/packages/omi-ex)| Omi.js 扩展(TypeScript) |
2019-08-19 09:50:12 +08:00
| [omi-transform](https://github.com/Tencent/omi/tree/master/packages/omi-transform)|Omi 和 [css3transform](https://tencent.github.io/omi/packages/omi-transform/css3transform/) 完美结合. 让 css3 transform 在你的 Omi 项目中变得超级简单.|
2018-11-05 14:47:11 +08:00
| [omi-finger](https://github.com/Tencent/omi/tree/master/packages/omi-finger)|Omi 官方手势库|
| [omi-touch](https://github.com/Tencent/omi/tree/master/packages/omi-touch)|丝般顺滑的触摸运动|
2019-03-04 10:21:59 +08:00
| [omi-snap](https://github.com/Tencent/omi/blob/master/tutorial/omi-snap.cn.md)|预渲染骨架屏|
2018-11-10 14:05:26 +08:00
|[omi-i18n](https://github.com/i18next/omi-i18n)| Omi 国际化解决方案 |
2019-08-18 22:02:49 +08:00
| [omie](https://github.com/Wscats/omi-electron) | Omi.js 和 Electron.js 打造跨平台桌面应用 |
2019-10-24 09:07:06 +08:00
| [Soo](https://github.com/tonis2/Soo)| 和 Omi 一样的 API但是更小且没有 JSX, virtual DOM 和 store|
2018-10-15 09:45:24 +08:00
2019-02-26 15:49:06 +08:00
### 特性
2019-05-07 11:33:24 +08:00
- 框架无关,任何框架可以使用 Omi 自定义元素
2019-03-25 16:56:40 +08:00
- 提供桌面、移动和小程序整体解决方案
2019-09-26 16:00:17 +08:00
- 无状态视图的架构设计
2019-07-28 10:33:43 +08:00
- 小巧的尺寸和[高性能](https://tencent.github.io/omi/packages/omi/examples/perfs/)
2019-07-28 10:35:22 +08:00
- 对 custom elements 友好, 通过字符串 `'0'`或者`'false'`传递 `false`[通过`:`和`Omi.$`传递任意复杂类型](https://github.com/Tencent/omi/releases/tag/v6.8.0)
2019-05-19 20:01:26 +08:00
- 拥有官方跨框架 UI 组件库 - [omim](https://tencent.github.io/omi/packages/omim/docs/build/cn.html)
2019-08-21 11:46:58 +08:00
- [很容易通过 extend api 实现双向绑定](https://codepen.io/omijs/pen/aeLYjx)
2019-02-26 15:49:06 +08:00
- 增强了 CSS, [支持 rpx 单位](https://github.com/Tencent/omi/releases/tag/v4.0.26),基于 **750** 屏幕宽度
2020-05-01 20:45:00 +08:00
- [基于 Shadow/Light Dom 设计](https://developers.google.cn/web/fundamentals/web-components/shadowdom?hl=zh-cn)
2019-08-18 22:02:49 +08:00
- 利用 [Chrome 开发工具扩展 ](https://github.com/f/omi-devtools)轻松调试,[从 Chrome 应用商店安装](https://chrome.google.com/webstore/detail/omijs-devtools/pjgglfliglbhpcpalbpeloghnbceocmd/related)
- 符合浏览器的发展趋势以及 API 设计理念
2019-11-07 10:58:06 +08:00
- [**Web Components**](https://developers.google.com/web/fundamentals/web-components/) + [**JSX**](https://reactjs.org/docs/introducing-jsx.html) 融合为一个框架 Omi
2019-02-26 15:49:06 +08:00
- Web Components 也可以数据驱动视图, `UI = fn(data)`
- JSX 是开发体验最棒(智能提示)、[语法噪音最少](https://github.com/facebook/jsx#why-not-template-literals)、图灵完备的 UI 表达式,模板引擎不完备,模板字符串完备但是语法噪音太大
2019-08-18 22:02:49 +08:00
- 看看 [Facebook React 和 Web Components 对比优势](https://www.cnblogs.com/rubylouvre/p/4072979.html)Omi 融合了各自的优点,而且给开发者自由的选择喜爱的方式
2020-05-01 20:45:00 +08:00
- `Shadow/Light DOM``Virtual DOM` 融合Omi 既使用了`虚拟 DOM`,也是使用真实 `Shadow DOM`,让视图更新更准确更迅速
2019-08-18 22:02:49 +08:00
- 局部 CSS 最佳解决方案(`Shadow DOM`),社区为局部 CSS 折腾了不少框架和库(使用 js 或 json 写样式,如:`Radium``jsxstyle``react-style`;与 webpack 绑定使用生成独特的 className `文件名—类名—hash值`,如:`CSS Modules``Vue`),还有运行时注入`scoped atrr` 的方式,都是 hack 技术;`Shadow DOM Style` 是最完美的方案
2019-02-26 15:49:06 +08:00
2020-05-01 20:45:00 +08:00
对比同样开发 TodoApp Omi 和 React 渲染完的 DOM 结构Omi 使用 Shadow/Light DOM 隔离样式和语义化结构:
2019-02-26 15:49:06 +08:00
2021-08-19 12:56:53 +08:00
| **Omi** | **React** |
| ------------------------------- | ----------------------------------- |
| ![Omi](https://tencent.github.io/omi/assets/omi-render.jpg) | ![React](https://tencent.github.io/omi/assets/react-render.jpg) |
2019-02-26 15:49:06 +08:00
2019-04-22 17:52:08 +08:00
### TypeScript 智能提示
```jsx
import { h, WeElement, tag, classNames } from 'omi';
2019-04-23 09:34:26 +08:00
import * as styles from './_index.less';
interface ButtonProps {
href?: string,
disabled?: boolean,
type?: 'default' | 'primary' | 'danger',
htmltype?: 'submit' | 'button' | 'reset',
onClick?: (e: any) => void
}
const TAG = 'o-button'
2019-04-22 17:52:08 +08:00
declare global {
namespace JSX {
interface IntrinsicElements {
2019-04-30 10:09:41 +08:00
[TAG]: Omi.Props & ButtonProps
2019-04-22 17:52:08 +08:00
}
}
}
2019-04-23 09:34:26 +08:00
@tag(TAG)
2019-09-25 10:56:48 +08:00
export default class oButton extends WeElement<ButtonProps> {
2019-04-23 09:34:26 +08:00
...
2019-04-22 17:52:08 +08:00
...
...
```
2019-04-23 09:40:15 +08:00
<img src="./assets/ts.png" alt="omi" width="427"/>
2019-04-22 17:52:08 +08:00
2018-11-06 08:39:32 +08:00
## 必须收藏的资源
2019-09-02 10:29:32 +08:00
* [使用 MVP 架构和 Web Components(Omi) 开发贪吃蛇](https://github.com/Tencent/omi/blob/master/tutorial/omi-web-components-snake-game-mvp.cn.md)
2019-08-14 10:55:16 +08:00
* [Web Components 规范](https://github.com/w3c/webcomponents)
2019-04-09 11:26:52 +08:00
* [Comi 原理揭秘](https://github.com/Tencent/omi/blob/master/tutorial/comi-principle.md)
2019-03-25 16:56:40 +08:00
* [Omip 编译 H5 原理揭秘](https://github.com/Tencent/omi/blob/master/tutorial/omip-h5.md)
2019-04-10 11:41:15 +08:00
* [如何通过小程序实现跨平台开发](https://developers.weixin.qq.com/community/develop/article/doc/00002cda45c930d87a380a74351813)
2019-01-08 10:41:39 +08:00
* [你必须收藏 ES6 Spread Operator 技巧](https://github.com/Tencent/omi/blob/master/tutorial/spread-operator.cn.md)
2019-03-25 16:56:40 +08:00
* [Omi snap 骨架屏与快照](https://github.com/Tencent/omi/blob/master/tutorial/omi-snap.cn.md)
2018-12-24 14:58:36 +08:00
* [Omio 兼容 IE8 踩坑之路](https://github.com/Tencent/omi/blob/master/tutorial/omio.cn.md)
2019-03-25 16:56:40 +08:00
* [Omi 生态发布](https://github.com/Tencent/omi/blob/master/tutorial/ecosystem.cn.md)
2018-11-30 13:10:11 +08:00
* [深入浅出 Shadow Dom](https://github.com/Tencent/omi/blob/master/tutorial/shadow-dom-in-depth.cn.md)
2018-11-22 10:27:01 +08:00
* [HTM - JSX 的替代品?还是另一种选择?](https://github.com/Tencent/omi/blob/master/tutorial/omi-html.cn.md)
2019-03-25 16:56:40 +08:00
* [MVVM 王者归来](https://github.com/Tencent/omi/blob/master/tutorial/omi-mvvm.cn.md)
2018-11-13 16:21:22 +08:00
* [60FPS Animation In Omi](https://github.com/Tencent/omi/blob/master/tutorial/omi-transform.cn.md)
2018-11-07 09:40:39 +08:00
* [Render Web Components To Native](https://github.com/Tencent/omi/blob/master/tutorial/render-web-components-to-native.cn.md)
2018-11-06 08:39:32 +08:00
* [Web Components MDN](https://developer.mozilla.org/zh-CN/docs/Web/Web_Components)
* [Web Components Google](https://developers.google.com/web/fundamentals/web-components/)
* [Web Components Org](https://www.webcomponents.org/introduction)
* [Proxy MDN](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Proxy)
* [CSS Variables](https://developer.mozilla.org/zh-CN/docs/Web/CSS/Using_CSS_variables)
* [CSS Shadow Parts](https://drafts.csswg.org/css-shadow-parts-1/)
* [Part Theme Explainer](https://meowni.ca/posts/part-theme-explainer/)
2018-11-14 10:29:07 +08:00
* [Platform HTML5](https://platform.html5.org/)
2018-11-28 17:59:50 +08:00
* [使用 requestIdleCallback](https://div.io/topic/1370)
* [A requestIdleCallback polyfill](https://gist.github.com/paullewis/55efe5d6f05434a96c36)
2019-03-25 16:56:40 +08:00
* [Web Components 的力量](https://github.com/Tencent/omi/blob/master/tutorial/the-power-of-web-components.cn.md)
2018-11-28 17:59:50 +08:00
* [ShadowRoot](https://developer.mozilla.org/zh-CN/docs/Web/API/ShadowRoot)
2018-12-04 14:41:00 +08:00
* [Developer Tools support for Web Components in Firefox 63](https://blog.nightly.mozilla.org/2018/09/06/developer-tools-support-for-web-components-in-firefox-63/)
2021-06-18 09:11:25 +08:00
* [Web Components中引入外部CSS的3种方法](https://www.zhangxinxu.com/wordpress/2021/02/web-components-import-css/)
2018-10-15 09:45:24 +08:00
---
2018-11-06 08:54:17 +08:00
# 目录
2018-10-26 22:18:48 +08:00
- [Omi 生态](#omi-生态)
2018-11-06 08:39:32 +08:00
- [必须收藏的资源](#必须收藏的资源)
2018-10-20 11:38:02 +08:00
- [快速入门](#快速入门)
2018-11-25 21:34:42 +08:00
- [项目模板](#项目模板)
2018-10-25 21:30:18 +08:00
- [Hello Element](#hello-element)
- [生命周期](#生命周期)
2018-10-15 15:05:34 +08:00
- [浏览器兼容](#浏览器兼容)
2018-10-20 11:38:02 +08:00
- [相关链接](#相关链接)
2018-11-26 19:10:02 +08:00
- [贡献者们](#贡献者们)
2018-12-14 09:08:04 +08:00
- [维护者](#维护者)
2018-10-29 14:58:04 +08:00
- [感谢](#感谢)
2018-10-15 09:45:24 +08:00
- [License](#license)
2018-10-31 19:44:01 +08:00
2018-10-20 11:38:02 +08:00
## 快速入门
2018-10-15 09:45:24 +08:00
2019-01-08 11:57:08 +08:00
<!-- 关于编译网站的 url 前缀的设置,可以参考两个地址:
2018-10-29 11:55:16 +08:00
* [build problem](https://stackoverflow.com/questions/42686149/create-react-app-build-with-public-url)
2018-10-29 14:51:38 +08:00
* [build env doc](https://facebook.github.io/create-react-app/docs/adding-custom-environment-variables#referencing-environment-variables-in-the-html)
2018-10-29 11:55:16 +08:00
比如在 windows 下:
```json
"scripts": {
"start": "node scripts/start.js",
"_build": "node scripts/build.js",
"build":"set PUBLIC_URL=https://fe.wxpay.oa.com/dv&& npm run _build"
}
```
2018-11-06 22:37:08 +08:00
在 mac os 中:
```json
"scripts": {
"start": "node scripts/start.js",
"_build": "node scripts/build.js",
"build":"PUBLIC_URL=https://fe.wxpay.oa.com/dv npm run _build",
"fix": "eslint src --fix"
},
```
2018-10-29 11:55:16 +08:00
2018-12-13 15:47:26 +08:00
如果你只想使用相对地址:
```
"build":"set PUBLIC_URL=.&& npm run _build" //windows
"build":"PUBLIC_URL=. npm run _build", //mac os
2019-08-18 22:02:49 +08:00
``` -->
2018-12-13 15:47:26 +08:00
2018-11-25 21:33:52 +08:00
### 项目模板
| **Template Type**| **Command**| **Describe**|
| ------------ | -----------| ----------------- |
2019-01-11 11:39:12 +08:00
|基础模板(v3.3.0+)|`omi init my-app`| 基础模板,支持 omi 和 omio(IE8+)|
2019-09-30 12:40:09 +08:00
|Kbone Template|`omi init-kbone my-app` | 使用 omi 开发小程序或者 Web|
2018-10-18 14:16:55 +08:00
2018-10-17 09:28:02 +08:00
### Hello Element
2018-10-15 09:45:24 +08:00
先创建一个自定义元素:
2019-09-20 16:48:28 +08:00
```js
2018-10-30 09:08:59 +08:00
import { define, WeElement } from 'omi'
2018-10-15 09:45:24 +08:00
2018-10-30 09:08:59 +08:00
define('hello-element', class extends WeElement {
onClick = evt => {
// trigger CustomEvent
this.fire('Abc', { name: 'dntzhang', age: 12 })
2018-10-30 09:08:59 +08:00
evt.stopPropagation()
}
2018-10-15 09:45:24 +08:00
2019-06-01 08:57:23 +08:00
//如果需要在 html 里直接使用 <hello-element></hello-element>,必须声明 propTypes
static propTypes = {
msg: String
}
2019-03-25 16:56:40 +08:00
static css = `
2019-01-15 11:41:00 +08:00
div {
color: red;
cursor: pointer;
}`
2018-10-15 09:45:24 +08:00
2018-10-30 09:08:59 +08:00
render(props) {
return (
<div onClick={this.onClick}>
2019-06-01 08:57:23 +08:00
Hello {props.msg}
2018-10-30 09:08:59 +08:00
<div>Click Me!</div>
</div>
)
}
})
2018-10-15 09:45:24 +08:00
```
使用该元素:
2018-10-30 09:08:59 +08:00
```js
import { define, render, WeElement } from 'omi'
2018-10-15 09:45:24 +08:00
import './hello-element'
2018-10-30 09:08:59 +08:00
define('my-app', class extends WeElement {
2019-06-01 08:57:23 +08:00
data = { abc: 'abc' }
2018-10-15 09:45:24 +08:00
2018-10-30 09:08:59 +08:00
// define CustomEvent Handler
onAbc = evt => {
// get evt data by evt.detail
this.data.abc = ' by ' + evt.detail.name
this.update()
}
2018-10-15 09:45:24 +08:00
2019-06-01 08:57:23 +08:00
static css = `
2019-01-15 11:41:00 +08:00
div{
color: green;
}`
2018-10-15 09:45:24 +08:00
render(props) {
2018-10-30 09:08:59 +08:00
return (
<div>
Hello {this.data.abc}
2018-10-30 09:08:59 +08:00
<hello-element
onAbc={this.onAbc}
msg="WeElement"
/>
</div>
)
}
})
2018-10-15 09:45:24 +08:00
2018-10-30 09:08:59 +08:00
render(<my-app name="Omi v4.0" />, 'body')
2018-10-15 09:45:24 +08:00
```
告诉 Babel 把 JSX 转化成 Omi.h() 的调用:
``` json
{
"presets": ["env", "omi"]
}
```
需要安装下面两个 npm 包支持上面的配置:
``` bash
"babel-preset-env": "^1.6.0",
"babel-preset-omi": "^0.1.1",
```
2018-10-27 16:08:24 +08:00
如果你使用 babel7也可以使用如下包和配置
```bash
npm install --save-dev @babel/preset-env
npm install --save-dev @babel/preset-react
```
```js
{
"presets": [
"@babel/preset-env",
[
"@babel/preset-react",
{
2019-10-15 19:27:43 +08:00
"pragma": "Omi.h",
"pragmaFrag": "Omi.h.f"
2018-10-27 16:08:24 +08:00
}
]
]
}
```
2018-10-15 09:45:24 +08:00
2018-10-23 09:18:59 +08:00
如果不想把 css 写在 js 里,你可以使用 webpack [to-string-loader](https://www.npmjs.com/package/to-string-loader), 比如下面配置:
2018-10-15 09:45:24 +08:00
``` js
{
test: /[\\|\/]_[\S]*\.css$/,
use: [
'to-string-loader',
'css-loader'
]
}
```
2019-09-26 16:29:08 +08:00
如果你的 css 文件以 `_` 开头, css 会使用 to-string-loader, 如:
2018-10-15 09:45:24 +08:00
``` js
2018-10-16 00:11:10 +08:00
import { tag, WeElement render } from 'omi'
2018-10-15 09:45:24 +08:00
2019-01-15 11:41:00 +08:00
define('my-app', class extends WeElement {
2018-10-15 09:45:24 +08:00
2019-01-15 11:41:00 +08:00
css = require('./_index.css')
2018-10-15 09:45:24 +08:00
...
...
...
```
2018-10-27 16:12:05 +08:00
你也可以忘掉这一对繁琐的配置直接使用 omi-cli不需要你配置任何东西。
2019-09-30 12:01:52 +08:00
<!-- ### TodoApp
2018-10-15 09:45:24 +08:00
下面列举一个相对完整的 TodoApp 的例子:
```js
2018-11-03 06:49:36 +08:00
import { define, render, WeElement } from 'omi'
2018-10-15 09:45:24 +08:00
2019-06-01 09:01:35 +08:00
define('todo-list', class extends WeElement {
static propTypes = {
items: Array
}
render(props) {
return (
<ul>
{props.items.map(item => (
<li key={item.id}>{item.text}</li>
))}
</ul>
)
}
2018-10-30 06:42:07 +08:00
})
define('todo-app', class extends WeElement {
2019-08-06 12:30:44 +08:00
items = []
text = ''
2018-10-30 07:01:01 +08:00
render() {
return (
<div>
<h3>TODO</h3>
2019-08-06 12:30:44 +08:00
<todo-list items={this.items} />
2018-10-30 07:01:01 +08:00
<form onSubmit={this.handleSubmit}>
<input
id="new-todo"
onChange={this.handleChange}
2019-08-06 12:30:44 +08:00
value={this.text}
2018-10-30 07:01:01 +08:00
/>
2019-08-06 12:30:44 +08:00
<button>Add #{this.items.length + 1}</button>
2018-10-30 07:01:01 +08:00
</form>
</div>
)
}
handleChange = e => {
2019-08-06 12:30:44 +08:00
this.text = e.target.value
2018-10-30 07:01:01 +08:00
}
handleSubmit = e => {
e.preventDefault()
2019-08-06 12:30:44 +08:00
if (!this.text.trim().length) {
2018-10-30 07:01:01 +08:00
return
}
2019-08-06 12:30:44 +08:00
this.items.push({
text: this.text,
2018-10-30 07:01:01 +08:00
id: Date.now()
})
2019-08-06 12:30:44 +08:00
this.text = ''
this.update()
2018-10-30 07:01:01 +08:00
}
2018-10-30 06:42:07 +08:00
})
render(<todo-app />, 'body')
2019-09-30 12:01:52 +08:00
``` -->
<!--
2018-10-16 13:44:49 +08:00
使用 Store 体系可以告别 update 方法,基于 Proxy 的全自动属性追踪和更新机制。强大的 Store 体系是高性能的原因,除了靠 props 决定组件状态的组件,其余组件所有 data 都挂载在 store 上,
2018-10-15 09:45:24 +08:00
```js
export default {
data: {
items: [],
text: '',
firstName: 'dnt',
lastName: 'zhang',
fullName: function () {
return this.firstName + this.lastName
},
globalPropTest: 'abc', //更改我会刷新所有页面,不需要再组件和页面声明data依赖
ccc: { ddd: 1 } //更改我会刷新所有页面,不需要再组件和页面声明data依赖
},
2018-10-15 10:19:45 +08:00
globalData: ['globalPropTest', 'ccc.ddd'],
2018-10-15 09:45:24 +08:00
add: function () {
if (!this.data.text.trim().length) {
return;
}
this.data.items.push({
text: this.data.text,
id: Date.now()
})
this.data.text = ''
2018-10-15 10:19:45 +08:00
}
2018-10-15 09:45:24 +08:00
//默认 false为 true 会无脑更新所有实例
//updateAll: true
}
```
自定义 Element 需要声明依赖的 data这样 Omi store 根据自定义组件上声明的 data 计算依赖 path 并会按需局部更新。如:
```js
2018-10-30 09:15:43 +08:00
define('todo-app', class extends WeElement {
2018-10-15 09:45:24 +08:00
static get data() {
2018-10-16 19:10:13 +08:00
//如果你用了 store这个只是用来声明依赖按需 Path Updating
2018-10-15 09:45:24 +08:00
return { items: [], text: '' }
}
...
...
...
handleChange = (e) => {
this.store.data.text = e.target.value
}
handleSubmit = (e) => {
e.preventDefault()
this.store.add()
}
2018-10-30 09:15:43 +08:00
})
2018-10-15 09:45:24 +08:00
```
* 数据的逻辑都封装在了 store 定义的方法里 (如 store.add)
* 视图只负责传递数据给 store (如上面调用 store.add 或设置 store.data.text
需要在 render 的时候从根节点注入 store 才能在所有自定义 Element 里使用 this.store:
```js
render(<todo-app></todo-app>, 'body', store)
```
2018-10-17 09:14:52 +08:00
[→ Store 完整的代码](https://github.com/Tencent/omi/blob/master/packages/omi/examples/store/main.js)
2018-10-15 09:45:24 +08:00
总结一下:
* store.data 用来列出所有属性和默认值(除去 props 决定的视图的组件)
2019-08-18 22:02:49 +08:00
* 组件和页面的 data 用来列出依赖的 store.data 的属性 (omi 会记录 path),按需更新
2018-10-15 09:45:24 +08:00
* 如果页面简单组件很少,可以 updateAll 设置成 true并且组件和页面不需要声明 data也就不会按需更新
* globalData 里声明的 path只要修改了对应 path 的值就会刷新所有页面和组件globalData 可以用来列出所有页面或大部分公共的属性 Path -->
2019-03-25 16:59:37 +08:00
<!--
2018-11-21 09:19:12 +08:00
## Mitt
如果不想使用 store 的 data 体系,也可以使用发布订阅模式。比如在 Omi 中使用 [mitt](https://github.com/developit/mitt) 跨组件通讯:
2019-03-25 16:59:37 +08:00
* [cross-component-communication](https://github.com/Tencent/omi/blob/master/packages/omi-30-seconds/README.md#cross-component-communication) -->
2018-11-21 09:19:12 +08:00
2018-12-24 09:47:09 +08:00
<!--
2018-11-01 15:12:52 +08:00
如果你想要兼容 IE11,请使用 `omi-mobx` 代替 omi 自带的 observe往下看..
2018-10-21 17:19:49 +08:00
2018-10-28 08:19:56 +08:00
### Omi Mobx
2018-10-21 17:19:49 +08:00
```js
2018-10-28 08:19:56 +08:00
import { tag, WeElement } from "omi"
import { observe } from "omi-mobx"
2018-10-21 17:19:49 +08:00
@observe
2018-10-28 08:19:56 +08:00
@tag("my-app")
2018-10-21 17:19:49 +08:00
class MyApp extends WeElement {
install() {
2018-10-28 08:19:56 +08:00
this.data.name = "omi"
2018-10-21 17:19:49 +08:00
}
onClick = () => {
2018-10-28 08:19:56 +08:00
this.data.name = "Omi V4.0"
2018-10-21 17:19:49 +08:00
}
render(props, data) {
return (
<div onClick={this.onClick}>
2018-10-28 08:19:56 +08:00
<h1>Welcome to {data.name}</h1>
2018-10-21 17:19:49 +08:00
</div>
)
}
}
2019-08-18 22:02:49 +08:00
``` -->
2018-10-21 17:19:49 +08:00
2018-10-28 08:19:56 +08:00
### 生命周期
2019-06-07 15:30:24 +08:00
| 钩子方法 | 触发时机 |
2018-10-28 08:19:56 +08:00
| ---------------- | -------------------------------------------- |
2019-06-07 15:30:24 +08:00
| `install` | 初始化安装 |
| `installed` | 插入到文档之后且安装完成 |
| `uninstall` | 从文档中卸载移除 |
| `beforeUpdate` | update 之前 |
| `updated` | update 之后 |
| `beforeRender` | `render()` 之前 |
| `receiveProps` | 父组件更新时候触发, 返回 false 可以阻止更新 |
2018-10-28 08:19:56 +08:00
2019-05-26 09:08:12 +08:00
### 查看所有注册的元素
2019-09-20 16:48:28 +08:00
```js
2019-05-26 09:08:12 +08:00
console.log(Omi.elements)
```
2019-03-25 16:58:16 +08:00
<!--
2018-11-05 13:14:43 +08:00
## React 组件转成 Omi
举个例子,下面是吧 weui react 的 button 转成 weui omi 的 button 的例子 :
![react to omi](./assets/react-to-omi.png)
* [Diff Split](https://github.com/Tencent/omi/commit/9790fadaaf20cfede80bcf9213756a83fc8c3949?diff=split)
* [Diff Unified](https://github.com/Tencent/omi/commit/9790fadaaf20cfede80bcf9213756a83fc8c3949?diff=unified)
* [Before](https://github.com/Tencent/omi/blob/c8af654f1d5865dc557c0b4b8ad524f702a69be5/packages/omi-weui/src/omi-weui/elements/button/button.js)
2019-03-25 16:58:16 +08:00
* [After](https://github.com/Tencent/omi/blob/9790fadaaf20cfede80bcf9213756a83fc8c3949/packages/omi-weui/src/omi-weui/elements/button/button.js) -->
2018-11-05 13:14:43 +08:00
2018-10-15 15:05:34 +08:00
## 浏览器兼容
2018-10-15 11:53:32 +08:00
2019-08-18 22:02:49 +08:00
> [Omio](https://github.com/Tencent/omi/tree/master/packages/omio) - 兼容老浏览器的 Omi 版本(支持到 IE8+)
2018-12-13 16:15:47 +08:00
2019-09-13 09:17:25 +08:00
Omi works in the latest two versions of all major browsers: Safari 10+, IE 11+, and the evergreen Chrome, Firefox, and Edge.
2018-10-15 11:53:32 +08:00
2018-10-23 06:47:28 +08:00
![→ Browsers Support](./assets/browsers-support.png)
2018-10-15 11:53:32 +08:00
[→ polyfills](https://github.com/webcomponents/webcomponentsjs)
2018-12-11 14:56:28 +08:00
```html
<script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.0.0/webcomponents-bundle.js"></script>
```
## 贡献
Build a example:
```bash
npm start example_name
```
Build omi:
```bash
npm run build
```
Unit testing
```
npm run test
```
2018-11-26 19:10:02 +08:00
## 贡献者们
<a href="https://github.com/Tencent/omi/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Tencent/omi" />
</a>
2019-05-12 18:37:14 +08:00
2020-04-18 20:21:14 +08:00
感谢所有贡献者,欢迎更多人加入一起贡献。
2019-10-03 16:20:25 +08:00
2019-07-25 20:16:12 +08:00
## 核心维护者
2018-10-20 09:30:19 +08:00
2021-08-07 18:23:19 +08:00
- [@dntzhang](https://github.com/dntzhang)
2019-07-25 20:16:12 +08:00
- [@Wscats](https://github.com/Wscats)
2018-11-01 10:43:37 +08:00
- [@LeeHyungGeun](https://github.com/LeeHyungGeun)
2018-10-25 11:38:56 +08:00
- [@xcatliu](https://github.com/xcatliu)
2021-08-07 18:23:19 +08:00
- [AlloyTeam](http://alloyteam.com/)
2018-10-20 11:12:43 +08:00
2018-11-11 14:03:54 +08:00
任何 Omi 相关问题欢迎联系我们。也可以[加入 Omi QQ 群](https://github.com/Tencent/omi/issues/169)进行讨论交流。
2018-11-10 14:44:23 +08:00
2018-10-29 14:58:04 +08:00
## 感谢
* [preact](https://github.com/developit/preact)
2018-11-12 15:53:48 +08:00
* [JSX](https://github.com/facebook/jsx)
2018-10-29 14:58:04 +08:00
2018-10-20 11:12:43 +08:00
## License
2018-10-25 20:23:25 +08:00
MIT © Tencent