Euler-ui NPM | npm.io

Euler UI widgets & utilities, powered by React.

Introduction

Euler UI is a library including a set of UI widgets & utilities, it aims to speed up front end development.

Topics

Quick start

Node.js

npm install euler-ui

Then:

var euler = require("euler-ui");

or es6

import * as euler from 'euler-ui'
import { request, i18n, Notification, Select } from 'euler-ui'

Features

Request

Aren't you tired of configuring nginx server to test with different back-end server?
Aren't you tired of creating an express server to start your app?
With simple configuration, you can count on Request module and be able to test with different back-end server, without configuring nginx server or creating an express server.

Start server

create e_conf/req folder at your project root

add conf.json at e_conf/req.

{
    "STATIC_FOLDER": ["/", "/src"], // static folders that be used at request server
    "WEBPACK_CONF_FILE": "webpack.config.js", // webpack config file path
    "BUILD_ENV": "DEV", // build env, default is DEV, options are DEV, SIT, UAT, PROD, it will be mapped with different proxy file.
    "INDEX_HTML": "src/public/index.html", // index html that be used at request server
}

run
```
npm estart
```

Sending a request

create proxy folder at e_conf/req
create differnt request proxy for different environment, e.g., proxy.json or proxy_dev.json, proxy_sit.json, proxy_uat.json, proxy_prod.json
```
proxy.json
    [
        "proxy": "http://localhost:8000" // global proxy setting
    ]
```

request

actions/login.js
    import { request } from 'euler-ui'
    export const loginUser = (userName, pwd) => {
        request({
          url: "/portal/login",
          method: "post",
          data: {
            userName: userName,
            password: pwd
          }
        }, (err, response) => {
          if (err) {
            error();
            return;
          }
          successs();
        })
    }

components/login.js
    import {loginUser} from '../actions/login'
    ...
      login() {
        loginUser();
      }
    ...

request API Simply speaking, use below api to send a request, the request will be sent to the proxy server.

request({
    url: "/portal/login",
    method: 'get', //post or get or put or delete
    queryParams: { // query parameters, the request url will be /portal/login?param1=value1&param2=value2
      parma1: 'value1',
      parma2: 'value2'
    },
    restParams: {
      productId: "1000"
      // if url path is '/issues/product/:productId/groupbystatus', the real path will be 
      // '/issues/product/1000/groupbystatus'
    },
    loadingMask: true,// display load mask, default is false
    data: { // post data
      userName: 'Tom',
      age: 28
    },
    proxy: true, // default is true, if set as false, the url won't get proxied, useful for retrieving local resources
    headers: { //header data
      'Context-type': "text"
    }
}, (err, response) => { //http://visionmedia.github.io/superagent/#response-properties
    if (err) {
        error()
        return;
    }
    success();
})

Moreover, you can specify a request at proxy.json with the same identifier sent by request

proxy.json
    [
        "proxy": "http://localhost:8000", // global proxy setting
        "requests": {
            "LOGIN": {
                "path": "login", // path will be used to send request by browser
                "source": "localhost:8001/login"// real path the request will be sent to
            }
        }
    ]

request({
    id: "USER_LOGIN", // key at e_conf/req/proxy/proxy*.json#requests
    method: 'get', //post or get or put or delete
    queryParams: { // query parameters, the request url will be /portal/login?param1=value1&param2=value2
      parma1: 'value1',
      parma2: 'value2'
    },
    restParams: {
      productId: "1000"
      // if url path is '/issues/product/:productId/groupbystatus', the real path will be 
      // '/issues/product/1000/groupbystatus'
    }
    data: { // post data
      userName: 'Tom',
      age: 28
    },
    headers: { //header data
      'Context-type': "text"
    }
}, (err, response) => { //http://visionmedia.github.io/superagent/#response-properties
    if (err) {
        error()
        return;
    }
    success();
})

Notification

A simple notification creator for you to create information/warning/error/success notificaiton.

// Create a hello world notificaiton as information.
Notification.create({
  message: "Hello World!"
})

// you can specify notification type with type configuraiton
Notification.create({
  message: "Hello World!",
  type: "warning"// default is info, options are info, warning, success, error
})

// By default, the notification will be automatically closed in 3 seconds
// you can use timeout configuration to specify the time before the notificaiton be closed
// if timeout is smaller than or equal 0, the notificaiton will just keep still, and only can be closed manually.
Notification.create({
  message: "Hello World!",
  timeout: -1 // this notificaiton won't get closed unless manully click its close button.
})

I18N

Module for internationalization and localization purpose. Switch differnt locale at runtime!

create e_conf/i18n folder at your project root.

add conf.json at e_conf/i18n.

{
    "default": "zh_cn", // default locale name, you can append url query "locale=xxx" to overwrite this settings
    // locale maps will be used to map locale file, 
    // the key is local name, the value is local file suffix, 
    // e.g., if locale is zh, locales map is {"zh", "zh_cn"}, i18n/locale_zh_cn.json will be used.
    "locales": {
      "zh": "zh_cn",
      "zh_cn": "zh_cn",
      "en": "en_us",
      "en_us": "en_us"
    }
}

add your locale*.json.

locale_en_us.json
    {
      "notification": {
        "success": "Success",
        "error": "Error",
        "info": "Information",
        "warning": "Warning"
      }
    }

locale_zh_cn.json
    {
      "notification": {
        "success": "成功",
        "error": "错误",
        "info": "通知",
        "warning": "警告"
      }
    }

After above steps, you are now free to use our i18n module!

main.js
    import { i18n} from 'euler-ui'
    console.log(Localization.get("notification.info"));

Spinner

Widget for show or display loading mask.

```js 
import {Spinner} from 'euler-ui'
var spinner = Spinner.show({
  type: 'ring', // spinner type, default is dot
  at: domElement // specify where to show the spinner, default is document.body
})
Spinner.hide([spinner]); // hide the spinner, if the spinner is not passed in, it will just hide last spinner created by spinner.show.
```

Select

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

React Components

bluebird lodash react-select shelljs spin.js superagent

@infinitebrahmanuniverse/nolb-eu @everything-registry/sub-chunk-1620 @zalastax/nolb-eu

8 years ago

8 years ago

8 years ago

8 years ago