DataType
/
omi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
omi/README.CN.md

51 KiB
Raw Blame History

English | 简体中文

omi

Omi - 前端跨框架框架

使用 TypeScript 开发跨框架的按钮组件:

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>
  }
}

Omiu

Omi 打造的跨框架、跨主题 UI 组件库

Name Status Example Docs
@omiu/button omiu-button-status CodePen Button Docs
@omiu/icon omiu-icon-status Icon Online Icon Docs
@omiu/tabs omiu-tabs-status CodePen Tabs Docs
@omiu/radio omiu-radio-status CodePen Radio Docs
@omiu/link omiu-link-status CodePen Link Docs
@omiu/checkbox omiu-checkbox-status CodePen Checkbox Docs
@omiu/hamburger-menu omiu-hamburger-menu-status CodePen HamburgerMenu Docs
@omiu/input omiu-input-status CodePen Input Docs
@omiu/tree omiu-tree-status CodePen Tree Docs
@omiu/pagination omiu-pagination-status CodePen Pagination Docs
@omiu/loading omiu-loading-status CodePen Loading Docs
@omiu/toast omiu-toast-status CodePen Toast Docs
@omiu/action-sheet omiu-action-sheet-status CodePen ActionSheet Docs
@omiu/switch omiu-switch-status CodePen Switch Docs
@omiu/color-picker omiu-color-picker-status CodePen ColorPicker Docs
@omiu/chart omiu-chart-status CodePen Chart Docs
@omiu/toggle-icon omiu-toggle-icon-status CodePen ToggleIcon Docs
@omiu/o-icon omiu-o-icon-status CodePen OIcon Docs
@omiu/badge omiu-badge-status CodePen Badge Docs
@omiu/avatar omiu-avatar-status CodePen Avatar Docs
@omiu/breadcrumb omiu-breadcrumb-status CodePen Breadcrumb Docs
@omiu/bottom-nav omiu-bottom-nav-status CodePen BottomNav Docs
@omiu/transition omiu-transition-status CodePen Transition Docs
@omiu/dialog omiu-dialog-status CodePen Dialog Docs
@omiu/dialog-extention omiu-dialog-extention-status CodePen DialogExtention Docs
Coming...
Coming...

Omi 生态

→ Omi 生态学习路线图

基础生态

项目 描述
omi-docs 和 例子 和 webcomponents.dev Omi 官方文档
omi-router Omi 官方路由,超级小的尺寸，只有 1KB 的 js
omi-devtools 谷歌浏览器开发工具扩展
omi-cli 项目脚手架工具，各种模板任你选 → 基础模板 and → 其他模板
CEE custom-elements-everywhere 评分

Snake MVP

Project Description
omi-snake omi 写的 MVP 架构的贪吃蛇游戏
omi-kbone-snake omi-kbone 写的 MVP 架构的跨端贪吃蛇游戏，支持小程序和 H5
Preact-snake & → Touch the demo Preact + Preact-CSS + Omis 写的贪吃蛇
[P]react-snake & → Touch the demo react/preact 写的 MVP 架构的贪吃蛇游戏
omix-snake Omix 写的 MVP 架构贪吃蛇

其他

项目 描述
omi-piano Omi 钢琴, 开始演奏吧!
md2site 用 markdown 生成静态网站文档.
omi-chart 一个 chart-x 标签搞定报表
omi-30-seconds 30 秒理解一段有用的 Omi 代码片段.
omi-swiper Omi + Swiper
omi-vscode VSCode extension for omi, Install now!
omi-sprite Web Components, JSX 和 Canvas 的完美融合
omi-canvas Web Components, JSX 和 Canvas 的完美融合
omi-ex Omi.js 扩展(TypeScript)
omi-transform Omi 和 css3transform 完美结合. 让 css3 transform 在你的 Omi 项目中变得超级简单.
omi-finger Omi 官方手势库
omi-touch 丝般顺滑的触摸运动
omi-snap 预渲染骨架屏
omi-i18n Omi 国际化解决方案
omi-page 基于 page.js 的 Omi 路由
omie Omi.js 和 Electron.js 打造跨平台桌面应用
Soo 和 Omi 一样的 API，但是更小且没有 JSX, virtual DOM 和 store

特性

  • 框架无关，任何框架可以使用 Omi 自定义元素
  • 提供桌面、移动和小程序整体解决方案
  • 无状态视图的架构设计
  • 小巧的尺寸和高性能
  • 对 custom elements 友好, 通过字符串 '0'或者'false'传递 false，通过:和Omi.$传递任意复杂类型
  • 拥有官方跨框架 UI 组件库 - omim
  • 使用 omio 可以兼容到 IE8
  • 很容易通过 extend api 实现双向绑定
  • 支持 TypeScript
  • 响应式数据绑定
  • 增强了 CSS, 支持 rpx 单位，基于 750 屏幕宽度
  • 原生支持 tap 事件
  • 基于 Shadow/Light Dom 设计
  • 利用 Chrome 开发工具扩展 轻松调试，从 Chrome 应用商店安装
  • 符合浏览器的发展趋势以及 API 设计理念
  • Web Components + JSX 融合为一个框架 Omi
  • Web Components 也可以数据驱动视图, UI = fn(data)
  • JSX 是开发体验最棒(智能提示)、语法噪音最少、图灵完备的 UI 表达式，模板引擎不完备，模板字符串完备但是语法噪音太大
  • 看看 Facebook React 和 Web Components 对比优势，Omi 融合了各自的优点，而且给开发者自由的选择喜爱的方式
  • Shadow/Light DOM 与 Virtual DOM 融合，Omi 既使用了虚拟 DOM，也是使用真实 Shadow DOM，让视图更新更准确更迅速
  • 局部 CSS 最佳解决方案(Shadow DOM)，社区为局部 CSS 折腾了不少框架和库(使用 js 或 json 写样式，如:Radium，jsxstyle，react-style；与 webpack 绑定使用生成独特的 className 文件名—类名—hash值，如：CSS Modules，Vue)，还有运行时注入scoped atrr 的方式，都是 hack 技术；Shadow DOM Style 是最完美的方案
  • 独创的 Path Updating的 store 系统，基于 Proxy 全自动化的精准更新，功耗低，自由度高，性能卓越，方便集成 requestIdleCallback，自动化按需更新局部视图

对比同样开发 TodoApp， Omi 和 React 渲染完的 DOM 结构，Omi 使用 Shadow/Light DOM 隔离样式和语义化结构:

Omi React Omio
Omi React Omio

TypeScript 智能提示

import { h, WeElement, tag, classNames } from 'omi';
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'

declare global {
  namespace JSX {
    interface IntrinsicElements {
      [TAG]: Omi.Props & ButtonProps
    }
  }
}

@tag(TAG)
export default class oButton extends WeElement<ButtonProps> {
...
...
...
omi

必须收藏的资源

目录

一个 HTML 完全上手

下面这个页面不需要任何构建工具就可以执行

<!DOCTYPE html>
<html>

<head>
  <title>Omi demo without transpiler</title>
</head>

<body>
  <script src="https://unpkg.com/omi"></script>
  <script>
    const { define, render, h } = Omi

    class Store {
      data = {
        count: 1
      }
      sub = () => {
        this.data.count--
      }
      add = () => {
        this.data.count++
      }
    }

    define('my-counter', _ => (
      h(h.f, null,
        h('button', {
          onClick: _.store.sub
        }, '-'),
        h('span', null, _.store.data.count),
        h('button', {
          onClick: _.store.add
        }, '+')
      )
    ), {
      use: ['count'],
      //or using useSelf, useSelf will update self only, exclude children components
      //useSelf: ['count'],
      css: `span { color: red; }`,
      installed() {
        console.log('installed')
      }
    })

    render(h('my-counter'), 'body', new Store)

  </script>
</body>

</html>

通过上面脚本的执行，你已经定义好了一个自定义标签，可以不使用 render 方法，直接使用 <my-counter></my-counter> 标签：

<body>
  <my-counter></my-counter>
</body>

快速入门

安装

$ 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+)

目录说明:

├─ config
├─ public
├─ scripts
├─ src
│  ├─ assets
│  ├─ elements    //存放所有 custom elements
│  ├─ store       //存放所有页面的 store
│  ├─ admin.js    //入口文件，会 build 成  admin.html
│  └─ index.js    //入口文件，会 build 成  index.html

Scripts

"scripts": {
    "start": "node scripts/start.js",
    "build": "PUBLIC_URL=. node scripts/build.js",
    "build-windows": "set PUBLIC_URL=.&& node scripts/build.js",
    "fix": "eslint src --fix"
}

你也可以设置 PUBLIC_URL, 比如：

...
"build": "PUBLIC_URL=https://fe.wxpay.oa.com/dv node scripts/build.js",
"build-windows": "set PUBLIC_URL=https://fe.wxpay.oa.com/dv&& node scripts/build.js",
...

切换 omi, omio 和 reomi

增加或删除 package.json 里的 alias config 可以切换 omi 和 omio 渲染:

"alias": {
  "omi": "omio"
}

项目模板

Template Type Command Describe
基础模板(v3.3.0+) omi init my-app 基础模板，支持 omi 和 omio(IE8+)
小程序模板(v3.3.5+) omi init-p my-app Omi 开发小程序
基础模板(v3.3.9+) omi init-o my-app 支持 IE8 的基础模板，只是 build 的时候支持 IE8，开发调试请用 IE9
Kbone Template omi init-kbone my-app 使用 omi 开发小程序或者 Web
支持预渲染快照骨架的模板 omi init-snap my-app 基础模板，支持 omi 和 omio(IE8+)，内置预渲染
TypeScript Template(omi-cli v3.3.0+) omi init-ts my-app 使用 TypeScript 的模板
Mobile Template omi init-weui my-app 使用了 weui 和 omi-router 的移动 web app 模板

Hello Element

先创建一个自定义元素:

import { define, WeElement } from 'omi'

define('hello-element', class extends WeElement {
  onClick = evt => {
    // trigger CustomEvent
    this.fire('Abc', { name: 'dntzhang', age: 12 })
    evt.stopPropagation()
  }

  //如果需要在 html 里直接使用 <hello-element></hello-element>，必须声明 propTypes
  static propTypes = {
    msg: String
  }

  static css = `
      div {
        color: red;
        cursor: pointer;
      }`

  render(props) {
    return (
      <div onClick={this.onClick}>
        Hello {props.msg}
        <div>Click Me!</div>
      </div>
    )
  }
})

使用该元素:

import { define, render, WeElement } from 'omi'
import './hello-element'

define('my-app', class extends WeElement {
  data = { abc: 'abc' }

  // define CustomEvent Handler
  onAbc = evt => {
    // get evt data by evt.detail
    this.data.abc = ' by ' + evt.detail.name
    this.update()
  }

  static css = `
      div{
          color: green;
      }`

  render(props) {
    return (
      <div>
        Hello {this.data.abc}
        <hello-element
          onAbc={this.onAbc}
          msg="WeElement"
        />
      </div>
    )
  }
})

render(<my-app name="Omi v4.0" />, 'body')

告诉 Babel 把 JSX 转化成 Omi.h() 的调用:

{
    "presets": ["env", "omi"]
}

需要安装下面两个 npm 包支持上面的配置:

"babel-preset-env": "^1.6.0",
"babel-preset-omi": "^0.1.1",

如果你使用 babel7，也可以使用如下包和配置：

npm install --save-dev @babel/preset-env
npm install --save-dev @babel/preset-react

{
  "presets": [
    "@babel/preset-env",
    [
      "@babel/preset-react",
      {
        "pragma": "Omi.h",
        "pragmaFrag": "Omi.h.f"
      }
    ]
  ]
}

如果不想把 css 写在 js 里，你可以使用 webpack to-string-loader, 比如下面配置:

{
    test: /[\\|\/]_[\S]*\.css$/,
    use: [
        'to-string-loader',
        'css-loader'
    ]
}

如果你的 css 文件以 _ 开头, css 会使用 to-string-loader, 如：

import { tag, WeElement render } from 'omi'

define('my-app', class extends WeElement {

  css = require('./_index.css')
  ...
  ...
  ...

你也可以忘掉这一对繁琐的配置直接使用 omi-cli，不需要你配置任何东西。

生命周期

钩子方法 触发时机
install 初始化安装
installed 插入到文档之后且安装完成
uninstall 从文档中卸载移除
beforeUpdate update 之前
updated update 之后
beforeRender render() 之前
receiveProps 父组件更新时候触发, 返回 false 可以阻止更新

调试工具

使用 Omi 开发工具 可以非常简单地调试和管理你的 UI。不需要任何配置，你只要安装然后就能调试。

既然 Omi 使用了 Web Components 和 Shadow-DOM, 所以不需要像 React 一样安装其他元素面板，只需要使用 Chrome 自带的 Elements' sidebar 便可，它和 React 开发者工具一样强大。

Omi DevTools

查看所有注册的元素

console.log(Omi.elements)

浏览器兼容

Omio - 兼容老浏览器的 Omi 版本(支持到 IE8+)

Omi works in the latest two versions of all major browsers: Safari 10+, IE 11+, and the evergreen Chrome, Firefox, and Edge.

→ Browsers Support

→ polyfills

<script src="https://unpkg.com/@webcomponents/webcomponentsjs@2.0.0/webcomponents-bundle.js"></script>

贡献

Build a example:

npm start example_name

Build omi:

npm run build

Unit testing

npm run test

贡献者们

感谢所有贡献者，欢迎更多人加入一起贡献。

核心维护者

任何 Omi 相关问题欢迎联系我们。也可以加入 Omi QQ 群进行讨论交流。

感谢

License

MIT © Tencent