omi/README.md

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

<p align="center"><img src="./assets/omi-logo.svg" alt="omi" width="300"/></p>
<h2 align="center">Omi: Next Generation Web Framework in 4kb JavaScript</h2>
<p align="center"><b>Merge JSX, Web Components, Proxy, Path Updating together</b></p>

## Why Omi?

- Tiny size. *(**4kb** gzipped)*
- Supports TypeScript.
- Reactive data-binding
- [Based on Shadow DOM](https://developers.google.cn/web/fundamentals/web-components/shadowdom)
- Easy to debug via [Omi DevTools Extension](https://github.com/f/omi-devtools) [[Install from Chrome WebStore](https://chrome.google.com/webstore/detail/omijs-devtools/pjgglfliglbhpcpalbpeloghnbceocmd/related)]
- 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 automatically update UI partially when data is 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:

| **Omi** | **React** |
|-|-|
| ![Omi](./assets/omi-render.jpg) | ![React](./assets/react-render.jpg) |

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

---

- [Why Omi?](#why-omi)
- [Add Omi in One Minute](#add-omi-in-one-minute)
- [Getting Started](#getting-started)
    - [Install](#install)
    - [Hello Element](#hello-element)
    - [TodoApp](#todoapp)
    - [Store](#store)
        - [Summary：](#summary)
    - [Lifecycle](#lifecycle)
- [Component Ecosystem](#component-ecosystem)
- [Browsers Support](#browsers-support)
- [Links](#links)
- [License](#license)
- [Contribution](#contribution)

## 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>
```

You can also use `like-button` tag directly in HTML：

```jsx
<body>
  <like-button></like-button>
</body>
```

## 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
```

Directory description:

```
├─ config
├─ public
├─ scripts
├─ src
│  ├─ assets
│  ├─ elements    //Store all custom elements
│  ├─ store       //Store all this store of pages
│  ├─ admin.js    //Entry js of compiler，will build to admin.html
│  └─ index.js    //Entry js of compiler，will build to index.html
```

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 by extending **`WeElement`** base class and name it using **`@tag`** decorator:

```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/>, 'body')
```

### Store

Say goodbye to `this.update` method when using store system! It will automatically update the UI partially when data is changed. The powerful **Store architecture** is high-performanced since all the 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/>, 'body', store)
```

[→ Store Source 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

- [omijs.org](http://omijs.org/)
- [Omi.js DevTools](https://github.com/f/omi-devtools)

## License

MIT © Tencent

## Contribution

## Contributing

1. Fork it (https://github.com/Tencent/omi/fork)
2. Create your branch (`git checkout -b my-urgent-hotfix`)
3. Commit your changes (`git commit -am 'Fixed something'`)
4. Push to the branch (`git push origin my-urgent-hotfix`)
5. Create a new Pull Request

Please contact us for any questions:

* [@f](https://github.com/f)
* [@dntzhang](https://github.com/dntzhang)
-												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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								<p align="center"><img src="./assets/omi-logo.svg" alt="omi" width="300"/></p>
 								<h2 align="center">Omi: Next Generation Web Framework in 4kb JavaScript</h2>
 								<p align="center"><b>Merge JSX, Web Components, Proxy, Path Updating together</b></p>
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								## Why Omi?
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								- Tiny size. *(**4kb** gzipped)*
 								- Supports TypeScript.
-												update readme

											
										
										
											2018-10-17 09:28:02 +08:00
+								- Reactive data-binding
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								- [Based on Shadow DOM](https://developers.google.cn/web/fundamentals/web-components/shadowdom)
 								- Easy to debug via [Omi DevTools Extension](https://github.com/f/omi-devtools) [[Install from Chrome WebStore](https://chrome.google.com/webstore/detail/omijs-devtools/pjgglfliglbhpcpalbpeloghnbceocmd/related)]
 								- 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 automatically update UI partially when data is 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*.
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
 								Compare TodoApp by Omi and React, Omi and React rendering DOM structure:
-												update readme

											
										
										
											2018-10-14 14:02:19 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								| **Omi** | **React** |
 								|-|-|
 								| ![Omi](./assets/omi-render.jpg) | ![React](./assets/react-render.jpg) |
-												update readme

											
										
										
											2018-10-14 14:05:06 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								On the left is Omi, the right side is React, and Omi uses Shadow DOM based style isolation 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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								- [Why Omi?](#why-omi)
-												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)
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								    - [Hello Element](#hello-element)
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								    - [TodoApp](#todoapp)
 								    - [Store](#store)
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								        - [Summary：](#summary)
 								    - [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)
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								- [Contribution](#contribution)
-												omi 3.0

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

											
										
										
											2018-10-17 10:13:28 +08:00
+								## Add Omi in One Minute
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								This page demonstrates using Omi **with no build tooling**.
-												update readme

											
										
										
											2018-10-17 10:13:28 +08:00
-												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
-												update readme

											
										
										
											2018-10-19 15:51:45 +08:00
+								You can also use `like-button` tag directly in HTML：
 								```jsx
 								<body>
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  <like-button></like-button>
-												update readme

											
										
										
											2018-10-19 15:51:45 +08:00
+								</body>
 								```
-												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-19 18:39:06 +08:00
+								Directory description:
 								```
 								├─ config
 								├─ public
 								├─ scripts
 								├─ src
 								│  ├─ assets
 								│  ├─ elements    //Store all custom elements
 								│  ├─ store       //Store all this store of pages
 								│  ├─ admin.js    //Entry js of compiler，will build to admin.html
 								│  └─ index.js    //Entry js of compiler，will build to index.html
 								```
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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-18 14:16:55 +08:00
-												update readme

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

											
										
										
											2017-03-23 07:53:17 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								Define a custom element by extending **`WeElement`** base class and name it using **`@tag`** decorator:
-												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) => {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								        // trigger CustomEvent
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
+								        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() {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								      return `
 								        div {
 								          color: red;
 								          cursor: pointer;
 								        }`
-												omix

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

											
										
										
											2018-10-14 07:50:55 +08:00
+								    render(props) {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								      return (
 								        <div onClick={this.onClick}>
 								          Hello {props.msg} {props.propFromParent}
 								          <div>Click Me!</div>
 								        </div>
 								      )
 								    }
-												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 {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  static get data() {
 								      return { abc: '', passToChild: '' }
 								  }
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  // bind CustomEvent
 								  onAbc = (evt) => {
 								      // get evt data by evt.detail
 								      this.data.abc = ` by ${evt.detail.name}`
 								      this.update()
 								  }
-												update readme

											
										
										
											2018-10-14 07:50:55 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  css() {
 								    return `
 								      div {
 								        color: green;
 								      }`
 								  }
-												ready for 4.0

											
										
										
											2018-10-13 22:55:38 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  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>
 								    )
 								  }
-												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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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
 								{
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  "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",
 								```
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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),
-												update readme

											
										
										
											2018-10-15 10:19:45 +08:00
+								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
+								{
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  test: /[\\|\/]_[\S]*\.css$/,
 								  use: [
 								    'to-string-loader',
 								    'css-loader'
 								  ]
-												update readme

											
										
										
											2018-05-09 10:18:53 +08:00
+								}
-												omi 3.0

											
										
										
											2018-05-03 10:46:34 +08:00
+								```
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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'
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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 {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  static get data() {
 								    return { items: [], text: '' }
 								  }
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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>
 								    );
 								  }
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  handleChange = (e) => {
 								    this.data.text = e.target.value
 								  }
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  handleSubmit = (e) => {
 								    e.preventDefault();
 								    if (!this.data.text.trim().length) {
 								      return;
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								    }
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
 								    this.data.items.push({
 								      text: this.data.text,
 								      id: Date.now()
 								    })
 								    this.data.text = '';
 								    this.update()
 								  }
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								}
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								render(<todo-app/>, 'body')
-												build and update readme

											
										
										
											2018-10-14 13:47:23 +08:00
+								```
-												omi 3.0

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

											
										
										
											2018-10-14 21:33:46 +08:00
+								### Store
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								Say goodbye to `this.update` method when using store system! It will automatically update the UI partially when data is changed. The powerful **Store architecture** is high-performanced since all the 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
 								    },
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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) {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								      return;
-												update readme

											
										
										
											2018-10-15 06:12:33 +08:00
+								    }
-												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
+								  }
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  // Default value is false, set to true will update all instances when data changing.
 								  // updateAll: true
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								}
 								```
-												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 {
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  // 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
 								  }
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								  handleSubmit = (e) => {
 								    e.preventDefault()
 								    this.store.add()
 								  }
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								}
 								```
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								render(<todo-app/>, 'body', store)
-												update readme & build

											
										
										
											2018-10-14 21:33:46 +08:00
+								```
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								[→ Store Source 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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								#### Summary：
-												update readme

											
										
										
											2018-10-14 21:57:20 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								* `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
-												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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								| 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()` |
-												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)
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								[→ Polyfills](https://github.com/webcomponents/webcomponentsjs)
-												update readme

											
										
										
											2018-10-15 11:53:32 +08:00
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +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
-												omi 3.0
											
										
										
											2018-05-03 11:19:37 +08:00
+								- [omijs.org](http://omijs.org/)
-												add devtools links to readme
											
										
										
											2018-10-20 08:45:50 +08:00
+								- [Omi.js DevTools](https://github.com/f/omi-devtools)
-												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
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								## Contribution
-												update contribution part
											
										
										
											2018-10-20 10:56:09 +08:00
+								## Contributing
 . Fork it (https://github.com/Tencent/omi/fork)
 . Create your branch (`git checkout -b my-urgent-hotfix`)
 . Commit your changes (`git commit -am 'Fixed something'`)
 . Push to the branch (`git push origin my-urgent-hotfix`)
 . Create a new Pull Request
-												some readme fixes to be fancier
											
										
										
											2018-10-20 10:52:43 +08:00
+								Please contact us for any questions:
 								* [@f](https://github.com/f)
 								* [@dntzhang](https://github.com/dntzhang)