Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitmalina/w2ui
UI widgets for modern apps. Data table, forms, toolbars, sidebar, tabs, tooltips, popups. All under 120kb (gzipped).
https://github.com/vitmalina/w2ui
Last synced: 24 days ago
JSON representation
UI widgets for modern apps. Data table, forms, toolbars, sidebar, tabs, tooltips, popups. All under 120kb (gzipped).
- Host: GitHub
- URL: https://github.com/vitmalina/w2ui
- Owner: vitmalina
- License: mit
- Created: 2011-04-12T14:26:20.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T15:28:11.000Z (7 months ago)
- Last Synced: 2024-04-15T13:54:39.569Z (7 months ago)
- Language: JavaScript
- Homepage: http://w2ui.com
- Size: 52.5 MB
- Stars: 2,606
- Watchers: 178
- Forks: 732
- Open Issues: 302
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
- awesome-game-engine-dev - w2ui - Gui widgets for modern web apps. (Libraries / JavaScript)
README
## Road to 2.0
The `master` branch has a new, in-progress version of w2ui. You might want to consider [1.5 branch](https://github.com/vitmalina/w2ui/tree/w2ui-1.5) that is stable and supports older browsers. Here are the goals for the new version of w2ui.
[Road to 2.0 discussion](https://github.com/vitmalina/w2ui/discussions/1955)
**W2UI v.2 no longer requires jQuery as a dependency**. You can download it from the master branch and at the moment, it is stable enough to be considrered for a Release Candidate. All [demos](https://w2ui.com/web/demos) have been updated to work as ES6 modules without any dependencies.
## About W2UI
W2UI is a modern JavaScript UI library for building rich web applications. It aims to let you define your UI in a declarative way via JSON data structures.
The library has a small footprint (120KB gzipped) and has **NO DEPENDENCIES** (as of v2.0). W2UI can be used in Vanilla JS projects, ES6 modules, as well as in Angular, React, and Vue based projects.
The library implements the following UI controls:
* **[w2grid](http://w2ui.com/web/docs/1.5/layout/grid)** - an advanced Grid component - *[demo](http://w2ui.com/web/demos/#/grid/1)*
* **[w2toolbar](http://w2ui.com/web/docs/1.5/toolbar)** - a Toolbar component - *[demo](http://w2ui.com/web/demos/#/toolbar/1)*
* **[w2sidebar](http://w2ui.com/web/docs/1.5/sidebar)** - a Tree/Sidebar component - *[demo](http://w2ui.com/web/demos/#/sidebar/1)*
* **[w2tabs](http://w2ui.com/web/docs/1.5/tabs)** - Tabs - *[demo](http://w2ui.com/web/demos/#/tabs/1)*
* **[w2form](http://w2ui.com/web/docs/1.5/form)** - Forms - *[demo](http://w2ui.com/web/demos/#/form/1)*
* **[w2fields](http://w2ui.com/web/docs/1.5/fields)** - various Fields - *[demo](http://w2ui.com/web/demos/#/fields/1)*
* **[w2popup](http://w2ui.com/web/docs/1.5/popup)** - a Popup component - *[demo](http://w2ui.com/web/demos/#/popup/1)*
* **[w2layout](http://w2ui.com/web/docs/1.5/layout)** - a Layout component - *[demo](http://w2ui.com/web/demos/#/layout/1)*
* **[w2utils](http://w2ui.com/web/docs/1.5/utils)** - various utilities - *[demo](http://w2ui.com/web/demos/#/utils/1)*
The complete library is under **100Kb** (minified & gzipped).
## Quick Start
Current stable version is 1.5 (supports older browsers).
Current development version is 2.0.
[Getting Started Guide](http://w2ui.com/web/get-started)
You can download latest stable version here: [http://w2ui.com](http://w2ui.com). If you want to use the dev version, see the `dist/` folder in the master branch.
To start using the library you need to include into your page:
- w2ui.js (or w2ui.min.js)
- w2ui.css (or w2ui.min.css)
All the controls and their css classes are defined inside of these two files. There are no image dependencies. Some images and font icons are embedded into the CSS file.
There is no requirement for a server side language. Node, Java, PHP, ASP, Perl or .NET will all work, as long as you can
return JSON format from the server (or write a converter into JSON format on the client). Some server side example implementations
can be found [here](https://github.com/vitmalina/w2ui/tree/master/server).
## Documentation & Demos
You can find documentation and demos here:
* [http://w2ui.com/web/docs](http://w2ui.com/web/docs) - documentation
* [http://w2ui.com/web/demos](http://w2ui.com/web/demos) - detailed demos
## Bug Tracking
Have a bug or a feature request? Please open an issue here [https://github.com/vitmalina/w2ui/issues](https://github.com/vitmalina/w2ui/issues).
Please make sure that the same issue was not previously submitted by someone else.
## Building
It is a Node.JS repository, so you need to have node installed to install all dependencies and compile w2ui.
```
npm install
```
To compile JS and CSS, run
```
gulp
```
It will bundle all necessary files into `dist/w2ui.min.js` and `dist/w2ui.min.css`
## File Structure
```
- demos - all demos, same as on w2ui.com
- dist - compiled JS and CSS files
- docs - stand alone documentation, same as on w2ui.com
- es6mods - ES6 modules playground
- libs - external libs, some used in demos, etc.
- server - server api samples (to get you started)
- specs - test automation
- src - source JS files
- less - LESS files (source for css)
- locale - int18n - translation to other languages
- test - manual testing files
```
## Who Is Using W2UI
[List of projects that use **`w2ui`**](https://github.com/vitmalina/w2ui/wiki/Projects-that-use-w2ui)!
If you're using **`w2ui`**, I'd love to hear about it, please email to `[email protected]` the name of your project and a link to a public website or demo, and I will add it to the list.
## Contributing
Your contributions are welcome. However, a few things you need to know before contributing:
1. Please check out the latest code before changing anything. It is harder to merge if your changes will not merge cleanly.
2. If you are changing JS files - do all changes in /src folder
3. If you are changing CSS files - do all changes in LESS in /src/less/src
4. If you want to help with unit test - do all changes in /qa
5. If you want to change documentation - do all changes in /docs
6. If you want to add demos - do all changes in /demos