commit | b3598ebd9f7c5218a0be02a4d683cc5c76762a78 | [log] [tgz] |
---|---|---|
author | Volker E <[email protected]> | Wed Dec 20 13:48:34 2017 -0800 |
committer | Bartosz DziewoĆski <[email protected]> | Wed Dec 20 21:56:38 2017 +0000 |
tree | 433a7d45c00716bfc01ad78784254b45172b488c | |
parent | 461ba6987e80e0c995b08f27af3dbf91526d7a5b [diff] |
Tag v0.24.4 Change-Id: I0f7364af86f7b4d9b64de0cb74d6fd22c6ec04e2
OOjs UI is a component-based JavaScript UI library. Key features:
It is the standard library for Web products at the Wikimedia Foundation, having been originally created for use by VisualEditor.
The library is available on npm. To install:
Once installed, include the following scripts and styles to get started:
While the distribution directory is chock-full of files, you will normally load only the following three:
oojs-ui.js
, containing the full library;oojs-ui-wikimediaui.css
or oojs-ui-apex.css
, containing theme-specific styles; andoojs-ui-wikimediaui.js
or oojs-ui-apex.js
, containing theme-specific codeYou can load additional icon packs from files named oojs-ui-wikimediaui-icons-*.css
or oojs-ui-apex-icons-*.css
.
The remaining files make it possible to load only parts of the whole library.
Furthermore, every CSS file has a right-to-left (RTL) version available, to be used on pages using right-to-left languages if your environment doesn't automatically flip them as needed.
Found a bug or missing feature? Please report it in our issue tracker Phabricator!
We are always delighted when people contribute patches. To setup your development environment:
Clone the repo: $ git clone https://phabricator.wikimedia.org/diffusion/GOJU/oojs-ui.git oojs-ui
Move into the library directory:$ cd oojs-ui
Install composer and make sure running composer
will execute it (e.g. add it to $PATH
in POSIX environments).
Install dev dependencies:$ npm install
Build the library (you can alternatively use grunt quick-build
if you don't need to rebuild the PNGs):$ grunt build
You can see a suite of demos in /demos
by executing:$ npm run-script demos
You can also copy the distribution files from the dist directory into your project.
We use Gerrit for code review, and Phabricator to track issues. To contribute patches or join discussions all you need is a developer account.
npm test
and composer test
locally before pushing changes. SVG files should be squashed in advance of committing with SVGO using svgo --pretty --disable=removeXMLProcInst --disable=cleanupIDs <filename>
.A new version of the library is released most weeks on Tuesdays.
Get updates, ask questions and join the discussion with maintainers and contributors:
#wikimedia-dev
on irc.freenode.net
.We use the Semantic Versioning guidelines.
Releases will be numbered in the following format:
<major>.<minor>.<patch>
Release process: