omi/README.md

English | [简体中文](./README.CN.md)

# Omi

> Next generation web framework in 4KB javascript(Merge JSX, Web Components, Proxy, Path Updating together).

<p align="center"><img src="./assets/omi.png" alt="omi"/></p>

### Why Omi？

- Tiny size(4KB gzip)
- Support TypeScript    
- Reactive data-binding
- [Based on Shadow Dom](https://developers.google.cn/web/fundamentals/web-components/shadowdom)
- Compliance with browser trend and API design
- Merge JSX and Web Components into One Framework
- Web Components can also be a data-driven view, UI = fn(data)
- JSX is the best development experience (code intelligent  completion and tip) UI Expression with least [grammatical noise](https://github.com/facebook/jsx#why-not-template-literals)
- The original Path Updating system. Proxy-based automatic accurate update, low power consumption, high degree of freedom, excellent performance, easy integration of requestIdleCallback
- Say goodbye to `this.update` method when using store system! It will update partial UI automatically when data changed.
- Look at [Facebook React VS Web Components](https://softwareengineering.stackexchange.com/questions/225400/pros-and-cons-of-facebooks-react-vs-web-components-polymer)，Omi combines their advantages and gives developers the freedom to choose the way they like.
- Shadow DOM merges with Virtual DOM, Omi uses both virtual DOM and real Shadow DOM to make view updates more accurate and faster
- With a Store system, 99.9% of projects don't need time travel, and not only Redux can travel, please don't come up on redux, Omi store system can meet all projects
- Scoped CSS's best solution is Shadow DOM, the community churning out frameworks and libraries for Scoped CSS (using JS or JSON writing styles such as Radium, jsxstyle, react-style; binding to webpack using generated unique className `filename-classname-hash', such as CSS Modules, Vue), are hack technologies; and Shadow DOM Style is the perfect solution.

Compare TodoApp by Omi and React, Omi and React rendering DOM structure:

![](./assets/omi-render.jpg) ![](./assets/react-render.jpg)

On the left is Omi, the right side is React, and Omi uses Shadow DOM isolation style and semantic structure.

---

- [Docs](https://github.com/Tencent/omi/blob/master/docs/main-concepts.md)
- [Add Omi in One Minute](#add-omi-in-one-minute)
- [Getting Started](#getting-started)
    - [Install](#install)
	- [Hello Element](#hello-element)
    - [TodoApp](#todoapp)
    - [Store](#store)
	- [Lifecycle](#lifecycle)
- [Component Ecosystem](#component-ecosystem)
- [Browsers Support](#browsers-support)
- [Links](#links)
- [License](#license)

## Add Omi in One Minute

This page demonstrates using Omi with no build tooling.

* [Online Demo!](https://tencent.github.io/omi/assets/)
* [Omi.js CDN](https://unpkg.com/omi)

```html
<!DOCTYPE html>
<html>

<head>
  <meta charset="UTF-8" />
  <title>Add Omi in One Minute</title>
</head>

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

    class LikeButton extends WeElement {
      install() {
        this.data = { liked: false }
      }

      render() {
        if (this.data.liked) {
          return 'You liked this.'
        }

        return h(
          'button',
          {
            onClick: () => {
              this.data.liked = true
              this.update()
            }
          },
          'Like'
        )
      }
    }

    define('like-button', LikeButton)

    render(h('like-button'), 'body')
  </script>
</body>

</html>
```

## Getting Started


### Install

```bash
$ npm i omi-cli -g               # install cli
$ omi init your_project_name     # init project, you can also exec 'omi init' in an empty folder
$ cd your_project_name           # please ignore this command if you executed 'omi init' in an empty folder
$ npm start                      # develop
$ npm run build                  # release
```

Cli's auto-created project scaffolding is based on a single-page create-react-app to be converted into a multi-page one, with configuration issues to see [create-react-app user guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md)

### Hello Element

Define a custom element:

```js
import { tag, WeElement, render } from 'omi'

@tag('hello-element')
class HelloElement extends WeElement {

    onClick = (evt) => {
        //trigger CustomEvent
        this.fire('abc', { name : 'dntzhang', age: 12 })
        evt.stopPropagation()
    }

    css() {
        return `
         div{
             color: red;
             cursor: pointer;
         }`
    }

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

Using `hello-element`:

``` js
import { tag, WeElement, render } from 'omi'
import './hello-element'

@tag('my-app')
class MyApp extends WeElement {
    static get data() {
        return { abc: '', passToChild: '' }
    }

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

    css() {
        return `
         div{
             color: green;
         }`
    }

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

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

Tell Babel to transform JSX into Omi.h () call:

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

The following two NPM packages need to be installed to support the above configuration:

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

If you don't want to write CSS in js, you can use [to-string-loader](https://www.npmjs.com/package/to-string-loader),
For example, the following configuration:

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

If your CSS file starts with "_", CSS will use to-string-loader., such as:

``` js
import { tag, WeElement render } from 'omi'
//typeof cssStr is string
import cssStr from './_index.css'

@tag('my-app')
class MyApp extends WeElement {

  css() {
    return cssStr
  }
  ...
  ...
  ...
```

### TodoApp

Here is a relatively complete example of TodoApp:

```js
import { tag, WeElement, render } from 'omi'

@tag('todo-list')
class TodoList extends WeElement {
    render(props) {
        return (
            <ul>
                {props.items.map(item => (
                    <li key={item.id}>{item.text}</li>
                ))}
            </ul>
        );
    }
}

@tag('todo-app')
class TodoApp extends WeElement {
    static get data() {
        return { items: [], text: '' }
    }

    render() {
        return (
            <div>
                <h3>TODO</h3>
                <todo-list items={this.data.items} />
                <form onSubmit={this.handleSubmit}>
                    <input
                        id="new-todo"
                        onChange={this.handleChange}
                        value={this.data.text}
                    />
                    <button>
                        Add #{this.data.items.length + 1}
                    </button>
                </form>
            </div>
        );
    }

    handleChange = (e) => {
        this.data.text = e.target.value
    }

    handleSubmit = (e) => {
        e.preventDefault();
        if (!this.data.text.trim().length) {
            return;
        }
        this.data.items.push({
            text: this.data.text,
            id: Date.now()
        })
        this.data.text = '';
        this.update()
    }
}

render(<todo-app></todo-app>, 'body')
```

### Store

Say goodbye to `this.update` method when using store system! It will update partial UI automatically when data changed. The powerful Store architecture is high-performance because all data is mounted on the store, except for components that rely on props to determine the state of the component.

```js
export default {
  data: {
    items: [],
    text: '',
    firstName: 'dnt',
    lastName: 'zhang',
    fullName: function () {
      return this.firstName + this.lastName
    },
    globalPropTest: 'abc', //Change it will refresh all elements without changing the components and page declaring data dependency.
    ccc: { ddd: 1 } //Change it will refresh all elements without changing the components and page declaring data dependency.
  },
  globalData: ['globalPropTest', 'ccc.ddd'],
  add: function () {
    if (!this.data.text.trim().length) {
        return;
    }
    this.data.items.push({
      text: this.data.text,
      id: Date.now()
    })
    this.data.text = ''
  }
  //Default value is false, set to true will update all instances when data changing.
  //updateAll: true
}
```

Custom Element requires declaring dependent data so that Omi stores compute the dependency path based on the data declared on the custom component and update it locally as needed. Such as:

```js
class TodoApp extends WeElement {
    //If you use store, the data is only used to declare dependencies.
    static get data() {
        return { items: [], text: '' }
    }
    ...
    ...
    ...
    handleChange = (e) => {
        this.store.data.text = e.target.value
    }

    handleSubmit = (e) => {
        e.preventDefault()
        this.store.add()
    }
}
```

* the logic of data is encapsulated in the store definition method (such as store.add).
* views are only responsible for passing data to store, such as calling store.add or setting store.data.text on top.

You need to inject store from the root node at render time to use this. store:

```js
render(<todo-app></todo-app>, 'body', store)
```

[→ Store Full Code](https://github.com/Tencent/omi/blob/master/packages/omi/examples/store/main.js)


Summary：

* store.data is used to list all attributes and default values (except the components of the view decided by props).
* The data of the component and page is used to list the attributes of the dependent store.data (Omi will record path) and update on demand.
* If there are few simple components on the page, updateAll can be set to true, and components and pages don't need to declare data, and they don't update on demand
* The path declared in globalData refreshes all pages and components by modifying the value of the corresponding path, which can be used to list all pages or most of the public properties Path

### Lifecycle

| Lifecycle method            | When it gets called                              |
|-------------------------------|--------------------------------------------------|
| `install`        | before the component gets mounted to the DOM     |
| `installed`         | after the component gets mounted to the DOM      |
| `uninstall`      | prior to removal from the DOM                    |
| `beforeUpdate`       | before `render()`                                |
| `afterUpdate`        | after `render()`                                 |

## Component Ecosystem

* [https://www.webcomponents.org/](https://www.webcomponents.org/)
* [https://www.webcomponents.org/elements](https://www.webcomponents.org/elements)

I believe you can easily convert web components elements to omi elements.

## Browsers Support

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

![Browsers Support](./assets/browsers-support.png)

[→ polyfills](https://github.com/webcomponents/webcomponentsjs)

If you want to be compatible with IE11, use the Omi file of [→ this project](https://github.com/Tencent/omi/tree/master/packages/omi-ie11).This project uses JSON Diff + Timer instead of Proxy.

You can dynamically load the JS of this project in the IE9 environment, and the proxy version is still used in other environments.

## Links

- [westore](https://github.com/dntzhang/westore)
- [omijs.org](http://omijs.org/)

## License

MIT © Tencent

Please contact me[@dntzhang](https://github.com/dntzhang) for any questions.
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								English | [简体中文](./README.CN.md)
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
-												revert master to proxy

											
										
										
											2018-10-19 09:17:58 +08:00
+								# Omi
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												update readme

											
										
										
											2018-10-18 17:14:09 +08:00
+								> Next generation web framework in 4KB javascript(Merge JSX, Web Components, Proxy, Path Updating together).
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												update readme

											
										
										
											2018-10-17 18:40:18 +08:00
+								<p align="center"><img src="./assets/omi.png" alt="omi"/></p>
-												update readme

											
										
										
											2018-10-17 15:16:34 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								### Why Omi？
-												update readme

											
										
										
											2017-03-09 16:26:06 +08:00
-												Update README.md
											
										
										
											2018-10-16 20:30:03 +08:00
+								- Tiny size(4KB gzip)
-												update readme

											
										
										
											2018-10-17 09:28:02 +08:00
+								- Support TypeScript
 								- Reactive data-binding
-												Update README.md
											
										
										
											2018-10-19 11:21:46 +08:00
+								- [Based on Shadow Dom](https://developers.google.cn/web/fundamentals/web-components/shadowdom)
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								- Compliance with browser trend and API design
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								- Merge JSX and Web Components into One Framework
-												update readme

											
										
										
											2018-10-18 17:14:09 +08:00
+								- Web Components can also be a data-driven view, UI = fn(data)
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								- JSX is the best development experience (code intelligent  completion and tip) UI Expression with least [grammatical noise](https://github.com/facebook/jsx#why-not-template-literals)
-												Proxy Now!

											
										
										
											2018-10-16 13:38:24 +08:00
+								- The original Path Updating system. Proxy-based automatic accurate update, low power consumption, high degree of freedom, excellent performance, easy integration of requestIdleCallback
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								- Say goodbye to `this.update` method when using store system! It will update partial UI automatically when data changed.
-												update readme

											
										
										
											2018-10-18 17:14:09 +08:00
+								- Look at [Facebook React VS Web Components](https://softwareengineering.stackexchange.com/questions/225400/pros-and-cons-of-facebooks-react-vs-web-components-polymer)，Omi combines their advantages and gives developers the freedom to choose the way they like.
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								- Shadow DOM merges with Virtual DOM, Omi uses both virtual DOM and real Shadow DOM to make view updates more accurate and faster
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								- With a Store system, 99.9% of projects don't need time travel, and not only Redux can travel, please don't come up on redux, Omi store system can meet all projects
 								- Scoped CSS's best solution is Shadow DOM, the community churning out frameworks and libraries for Scoped CSS (using JS or JSON writing styles such as Radium, jsxstyle, react-style; binding to webpack using generated unique className `filename-classname-hash', such as CSS Modules, Vue), are hack technologies; and Shadow DOM Style is the perfect solution.
 								Compare TodoApp by Omi and React, Omi and React rendering DOM structure:
-												update readme

											
										
										
											2018-10-14 14:02:19 +08:00
-												update readme

											
										
										
											2018-10-14 14:05:06 +08:00
+								![](./assets/omi-render.jpg) ![](./assets/react-render.jpg)
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								On the left is Omi, the right side is React, and Omi uses Shadow DOM isolation style and semantic structure.
-												update readme

											
										
										
											2018-10-14 14:02:19 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								---
-												update readme

											
										
										
											2017-03-23 07:53:17 +08:00
-												update readme

											
										
										
											2018-10-18 16:40:51 +08:00
+								- [Docs](https://github.com/Tencent/omi/blob/master/docs/main-concepts.md)
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								- [Add Omi in One Minute](#add-omi-in-one-minute)
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								- [Getting Started](#getting-started)
-												update readme

											
										
										
											2018-10-16 19:40:30 +08:00
+								    - [Install](#install)
-												update readme

											
										
										
											2018-10-17 09:28:02 +08:00
+									- [Hello Element](#hello-element)
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								    - [TodoApp](#todoapp)
 								    - [Store](#store)
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+									- [Lifecycle](#lifecycle)
-												update readme

											
										
										
											2018-10-15 15:05:34 +08:00
+								- [Component Ecosystem](#component-ecosystem)
 								- [Browsers Support](#browsers-support)
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								- [Links](#links)
 								- [License](#license)
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								## Add Omi in One Minute
 								This page demonstrates using Omi with no build tooling.
-												update readme

											
										
										
											2018-10-17 12:59:27 +08:00
+								* [Online Demo!](https://tencent.github.io/omi/assets/)
 								* [Omi.js CDN](https://unpkg.com/omi)
-												update html

											
										
										
											2018-10-17 10:21:02 +08:00
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								```html
-												Syntax mistake with <!DOCTYPE html>

Changed `<<!DOCTYPE html>` to `<!DOCTYPE html>`
											
										
										
											2018-10-17 15:37:57 +08:00
+								<!DOCTYPE html>
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								<html>
 								<head>
 								  <meta charset="UTF-8" />
 								  <title>Add Omi in One Minute</title>
 								</head>
 								<body>
-												update cdn

											
										
										
											2018-10-17 12:26:08 +08:00
+								  <script src="https://unpkg.com/omi"></script>
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								  <script>
-												update readme

											
										
										
											2018-10-17 10:27:34 +08:00
+								    const { WeElement, h, render, define } = Omi
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
-												update readme

											
										
										
											2018-10-17 10:27:34 +08:00
+								    class LikeButton extends WeElement {
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
+								      install() {
 								        this.data = { liked: false }
 								      }
 								      render() {
 								        if (this.data.liked) {
 								          return 'You liked this.'
 								        }
 								        return h(
 								          'button',
 								          {
 								            onClick: () => {
 								              this.data.liked = true
 								              this.update()
 								            }
 								          },
 								          'Like'
 								        )
 								      }
 								    }
 								    define('like-button', LikeButton)
 								    render(h('like-button'), 'body')
 								  </script>
 								</body>
 								</html>
 								```
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
 								## Getting Started
-												update readme

											
										
										
											2018-10-16 19:40:30 +08:00
 								### Install
 								```bash
-												update readme

											
										
										
											2018-10-17 12:59:27 +08:00
+								$ npm i omi-cli -g               # install cli
 								$ omi init your_project_name     # init project, you can also exec 'omi init' in an empty folder
 								$ cd your_project_name           # please ignore this command if you executed 'omi init' in an empty folder
 								$ npm start                      # develop
 								$ npm run build                  # release
-												update readme

											
										
										
											2018-10-16 19:40:30 +08:00
+								```
-												update readme

											
										
										
											2018-10-18 14:16:55 +08:00
+								Cli's auto-created project scaffolding is based on a single-page create-react-app to be converted into a multi-page one, with configuration issues to see [create-react-app user guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md)
-												update readme

											
										
										
											2018-10-17 09:28:02 +08:00
+								### Hello Element
-												update readme

											
										
										
											2017-03-23 07:53:17 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Define a custom element:
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								```js
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								import { tag, WeElement, render } from 'omi'
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								@tag('hello-element')
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								class HelloElement extends WeElement {
 								    onClick = (evt) => {
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								        //trigger CustomEvent
 								        this.fire('abc', { name : 'dntzhang', age: 12 })
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								        evt.stopPropagation()
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
+								    }
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								    css() {
 								        return `
 								         div{
 								             color: red;
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								             cursor: pointer;
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								         }`
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
+								    }
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								    render(props) {
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								        return (
 								            <div onClick={this.onClick}>
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								                Hello {props.msg} {props.propFromParent}
 								                <div>Click Me!</div>
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								            </div>
 								        )
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								    }
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								}
 								```
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Using `hello-element`:
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
 								``` js
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								import { tag, WeElement, render } from 'omi'
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								import './hello-element'
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								@tag('my-app')
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								class MyApp extends WeElement {
-												fix props name

											
										
										
											2018-10-14 17:06:50 +08:00
+								    static get data() {
 								        return { abc: '', passToChild: '' }
 								    }
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								    //bind CustomEvent
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								    onAbc = (evt) => {
-												fix props name

											
										
										
											2018-10-14 17:06:50 +08:00
+								        // get evt data by evt.detail
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								        this.data.abc = ' by ' + evt.detail.name
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								        this.update()
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								    }
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								    css() {
 								        return `
 								         div{
 								             color: green;
 								         }`
-												omi v3.0.7 - fix staticStyle

											
										
										
											2018-09-14 14:55:26 +08:00
+								    }
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								    render(props, data) {
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								        return (
-												update readme

											
										
										
											2018-10-14 14:02:19 +08:00
+								            <div>
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								                Hello {props.name} {data.abc}
 								                <hello-element onAbc={this.onAbc} prop-from-parent={data.passToChild} msg="WeElement"></hello-element>
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								            </div>
 								        )
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
+								    }
 								}
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								render(<my-app name='Omi v4.0'></my-app>, 'body')
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								```
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Tell Babel to transform JSX into Omi.h () call:
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								``` json
 								{
 								    "presets": ["env", "omi"]
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
+								}
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								```
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								The following two NPM packages need to be installed to support the above configuration:
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								``` bash
 								"babel-preset-env": "^1.6.0",
 								"babel-preset-omi": "^0.1.1",
 								```
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								If you don't want to write CSS in js, you can use [to-string-loader](https://www.npmjs.com/package/to-string-loader),
 								For example, the following configuration:
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								``` js
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
+								{
 								    test: /[\\|\/]_[\S]*\.css$/,
 								    use: [
 								        'to-string-loader',
 								        'css-loader'
 								    ]
 								}
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								```
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								If your CSS file starts with "_", CSS will use to-string-loader., such as:
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
 								``` js
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								import { tag, WeElement render } from 'omi'
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								//typeof cssStr is string
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								import cssStr from './_index.css'
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								@tag('my-app')
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								class MyApp extends WeElement {
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								  css() {
 								    return cssStr
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
+								  }
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								  ...
 								  ...
 								  ...
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
+								```
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								### TodoApp
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Here is a relatively complete example of TodoApp:
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
 								```js
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								import { tag, WeElement, render } from 'omi'
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								@tag('todo-list')
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								class TodoList extends WeElement {
 								    render(props) {
 								        return (
 								            <ul>
 								                {props.items.map(item => (
 								                    <li key={item.id}>{item.text}</li>
 								                ))}
 								            </ul>
 								        );
 								    }
 								}
-												update readme

											
										
										
											2018-10-16 00:11:10 +08:00
+								@tag('todo-app')
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								class TodoApp extends WeElement {
-												fix props name

											
										
										
											2018-10-14 17:06:50 +08:00
+								    static get data() {
 								        return { items: [], text: '' }
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								    }
 								    render() {
 								        return (
 								            <div>
 								                <h3>TODO</h3>
 								                <todo-list items={this.data.items} />
 								                <form onSubmit={this.handleSubmit}>
 								                    <input
 								                        id="new-todo"
 								                        onChange={this.handleChange}
 								                        value={this.data.text}
 								                    />
 								                    <button>
 								                        Add #{this.data.items.length + 1}
 								                    </button>
 								                </form>
 								            </div>
 								        );
 								    }
 								    handleChange = (e) => {
 								        this.data.text = e.target.value
 								    }
 								    handleSubmit = (e) => {
 								        e.preventDefault();
-												update readme

											
										
										
											2018-10-15 06:16:51 +08:00
+								        if (!this.data.text.trim().length) {
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								            return;
 								        }
 								        this.data.items.push({
 								            text: this.data.text,
 								            id: Date.now()
 								        })
-												Update README.md
											
										
										
											2018-10-19 13:51:33 +08:00
+								        this.data.text = '';
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								        this.update()
 								    }
 								}
 								render(<todo-app></todo-app>, 'body')
 								```
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								### Store
-												update readme

											
										
										
											2018-10-16 13:44:49 +08:00
+								Say goodbye to `this.update` method when using store system! It will update partial UI automatically when data changed. The powerful Store architecture is high-performance because all data is mounted on the store, except for components that rely on props to determine the state of the component.
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
 								```js
 								export default {
 								  data: {
 								    items: [],
 								    text: '',
 								    firstName: 'dnt',
 								    lastName: 'zhang',
 								    fullName: function () {
 								      return this.firstName + this.lastName
 								    },
-												update readme

											
										
										
											2018-10-18 15:13:40 +08:00
+								    globalPropTest: 'abc', //Change it will refresh all elements without changing the components and page declaring data dependency.
 								    ccc: { ddd: 1 } //Change it will refresh all elements without changing the components and page declaring data dependency.
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								  },
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								  globalData: ['globalPropTest', 'ccc.ddd'],
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								  add: function () {
-												update readme

											
										
										
											2018-10-15 06:16:51 +08:00
+								    if (!this.data.text.trim().length) {
-												update readme

											
										
										
											2018-10-15 06:12:33 +08:00
+								        return;
 								    }
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								    this.data.items.push({
 								      text: this.data.text,
 								      id: Date.now()
 								    })
 								    this.data.text = ''
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								  }
 								  //Default value is false, set to true will update all instances when data changing.
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								  //updateAll: true
 								}
 								```
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Custom Element requires declaring dependent data so that Omi stores compute the dependency path based on the data declared on the custom component and update it locally as needed. Such as:
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
 								```js
 								class TodoApp extends WeElement {
-												update readme

											
										
										
											2018-10-16 19:10:13 +08:00
+								    //If you use store, the data is only used to declare dependencies.
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								    static get data() {
 								        return { items: [], text: '' }
 								    }
 								    ...
 								    ...
 								    ...
 								    handleChange = (e) => {
 								        this.store.data.text = e.target.value
 								    }
 								    handleSubmit = (e) => {
-												update readme

											
										
										
											2018-10-15 06:12:33 +08:00
+								        e.preventDefault()
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								        this.store.add()
 								    }
 								}
 								```
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								* the logic of data is encapsulated in the store definition method (such as store.add).
 								* views are only responsible for passing data to store, such as calling store.add or setting store.data.text on top.
-												update readme

											
										
										
											2018-10-15 06:12:33 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								You need to inject store from the root node at render time to use this. store:
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
 								```js
 								render(<todo-app></todo-app>, 'body', store)
 								```
-												add omi to packages

											
										
										
											2018-10-17 09:14:52 +08:00
+								[→ Store Full Code](https://github.com/Tencent/omi/blob/master/packages/omi/examples/store/main.js)
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
-												update readme

											
										
										
											2018-10-15 06:24:55 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								Summary：
-												update readme

											
										
										
											2018-10-14 21:57:20 +08:00
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								* store.data is used to list all attributes and default values (except the components of the view decided by props).
-												Proxy Now!

											
										
										
											2018-10-16 13:38:24 +08:00
+								* The data of the component and page is used to list the attributes of the dependent store.data (Omi will record path) and update on demand.
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								* If there are few simple components on the page, updateAll can be set to true, and components and pages don't need to declare data, and they don't update on demand
 								* The path declared in globalData refreshes all pages and components by modifying the value of the corresponding path, which can be used to list all pages or most of the public properties Path
-												update readme

											
										
										
											2018-10-14 21:57:20 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								### Lifecycle
-												omix

											
										
										
											2018-02-25 16:06:09 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								| Lifecycle method            | When it gets called                              |
 								|-------------------------------|--------------------------------------------------|
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
+								| `install`        | before the component gets mounted to the DOM     |
 								| `installed`         | after the component gets mounted to the DOM      |
 								| `uninstall`      | prior to removal from the DOM                    |
 								| `beforeUpdate`       | before `render()`                                |
 								| `afterUpdate`        | after `render()`                                 |
-												update readme

											
										
										
											2017-03-23 07:53:17 +08:00
-												update readme

											
										
										
											2018-10-15 15:05:34 +08:00
+								## Component Ecosystem
 								* [https://www.webcomponents.org/](https://www.webcomponents.org/)
 								* [https://www.webcomponents.org/elements](https://www.webcomponents.org/elements)
-												update readme

											
										
										
											2018-10-18 17:14:09 +08:00
+								I believe you can easily convert web components elements to omi elements.
-												update readme

											
										
										
											2018-10-15 15:05:34 +08:00
 								## Browsers Support
-												update readme

											
										
										
											2018-10-15 11:53:32 +08:00
-												Update README.md
											
										
										
											2018-10-18 21:18:17 +08:00
+								Omi 4.0+ works in the latest two versions of all major browsers: Safari 10+, IE 11+, and the evergreen Chrome, Firefox, and Edge.
-												update readme

											
										
										
											2018-10-15 11:53:32 +08:00
 								![Browsers Support](./assets/browsers-support.png)
 								[→ polyfills](https://github.com/webcomponents/webcomponentsjs)
-												update readme

											
										
										
											2018-10-19 09:22:03 +08:00
+								If you want to be compatible with IE11, use the Omi file of [→ this project](https://github.com/Tencent/omi/tree/master/packages/omi-ie11).This project uses JSON Diff + Timer instead of Proxy.
-												update readme

											
										
										
											2018-10-19 08:38:03 +08:00
 								You can dynamically load the JS of this project in the IE9 environment, and the proxy version is still used in other environments.
-												Update README.md
											
										
										
											2018-10-18 23:06:08 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								## Links
-												update readme

											
										
										
											2017-03-23 07:53:17 +08:00
-												update readme

											
										
										
											2018-10-14 07:45:53 +08:00
+								- [westore](https://github.com/dntzhang/westore)
-												omi 3.0
											
										
										
											2018-05-03 11:19:37 +08:00
+								- [omijs.org](http://omijs.org/)
-												update readme

											
										
										
											2017-03-23 07:53:17 +08:00
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								## License
-												update readme

											
										
										
											2017-03-09 16:26:06 +08:00
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								MIT © Tencent
-												update readme

											
										
										
											2018-10-14 08:23:31 +08:00
-												corrected typos in README.md

											
										
										
											2018-10-19 09:29:34 +08:00
+								Please contact me[@dntzhang](https://github.com/dntzhang) for any questions.