https://github.com/eleme/element-react

Element UI
https://github.com/eleme/element-react

css element-ui javascript react react-components ui-design

Last synced: about 1 month ago
JSON representation

Element UI

• Host: GitHub
• URL: https://github.com/eleme/element-react
• Owner: ElemeFE
• License: mit
• Created: 2016-10-18T06:56:20.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-14T21:13:08.000Z (over 1 year ago)
• Last Synced: 2024-08-13T03:06:23.673Z (about 1 month ago)
• Topics: css, element-ui, javascript, react, react-components, ui-design
• Language: JavaScript
• Homepage: https://elemefe.github.io/element-react/index
• Size: 18.5 MB
• Stars: 2,832
• Watchers: 89
• Forks: 444
• Open Issues: 259
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Element React

[![](https://travis-ci.org/eleme/element-react.svg?branch=master)](https://travis-ci.org/eleme/element-react)

[![](https://img.shields.io/npm/v/element-react.svg)](https://www.npmjs.com/package/element-react)

[![](https://img.shields.io/npm/dm/element-react.svg)](https://www.npmjs.com/package/element-react)

[Element](https://github.com/ElemeFE/element) was initially written in [Vue](https://vuejs.org/), which has many elegant UI components, but we also love [React](https://facebook.github.io/react/), so we forked it for the React community.

## Getting Started

### Install

```bash

npm install element-react --save

```

Before the building, you need a style theme, here we recommend you to pick up `element-theme-default`.

```bash

npm install element-theme-default --save

```

### Usage

We are die hard fans of ECMAScript 6, so we recommend you writing code in modern javascript.

```js

import { Button } from 'element-react';

```

Also we provide an advanced way to [tree shaking](https://blog.engineyard.com/2016/tree-shaking) the code with [Rollup.js](http://rollupjs.org/) and [Webpack 2](https://webpack.github.io/)

```js

import { Button } from 'element-react/next';

```

### Config

With webpack, you need additional loaders to build with `element-react`.

```js

const webpack = require('webpack');

module.exports = {

  entry: {

    src: 'path/to/src'

  },

  output: {

    path: 'path/to/output'

    publicPath: '/public',

    chunkFilename: '[chunkhash:12].js',

    filename: '[chunkhash:12].js'

  },

  plugins: [

    new webpack.DefinePlugin({ 'process.env.NODE_ENV': JSON.stringify('production') }),

    new webpack.optimize.UglifyJsPlugin({

      output: {

        comments: false

      }

    })

  ],

  resolve: {

    extensions: ['.js', '.jsx']

  },

  module: {

    loaders: [

      {

        test: /\.jsx?$/,

        loader: 'babel-loader',

        include: ['path/to/src']

      },

      {

        test: /\.css$/,

        loaders: ['style-loader', 'css-loader']

      },

      {

        test: /\.(ttf|eot|svg|woff|woff2)(\?.+)?$/,

        loader: 'file-loader?name=[hash:12].[ext]'

      }

    ]

  }

}

```

## Contributing

Please make sure to read the [Contributing Guide](https://github.com/eleme/element-react/blob/master/CONTRIBUTING.md) before making a pull request.

## Acknowledgments

* [@doxiaodong](https://github.com/doxiaodong) for adding typescript ambient declarations.

* [@cuining](https://github.com/cuining) for building the live code editor.

## Credits

* [Element](https://github.com/ElemeFE/element) Desktop UI elements for Vue.js 2.0.

## License

MIT