A collection of JetBrains Web UI components
JavaScript HTML CSS
Switch branches/tags
ring-ui-gemini@0.2.3 ring-ui-gemini@0.2.2 ring-ui-gemini@0.2.1 ring-ui-gemini@0.2.1-beta.2 ring-ui-gemini@0.2.1-beta.1 ring-ui-gemini@0.2.1-beta.0 ring-ui-gemini@0.2.0 ring-ui-docs@0.2.6 ring-ui-docs@0.2.5 ring-ui-docs@0.2.4 ring-ui-docs@0.2.3 ring-ui-docs@0.2.2 ring-ui-docs@0.2.1 ring-ui-docs@0.2.0 ring-ui-docs@0.1.24 ring-ui-docs@0.1.23 ring-ui-docs@0.1.22 ring-ui-docs@0.1.21 ring-ui-docs@0.1.20 ring-ui-docs@0.1.19 ring-ui-docs@0.1.18 ring-ui-docs@0.1.17 ring-ui-docs@0.1.16 ring-ui-docs@0.1.15 ring-ui-docs@0.1.15-beta.5 ring-ui-docs@0.1.15-beta.4 ring-ui-docs@0.1.15-beta.3 ring-ui-docs@0.1.15-beta.2 ring-ui-docs@0.1.15-beta.1 ring-ui-docs@0.1.15-beta.0 ring-ui-docs@0.1.14 ring-ui-docs@0.1.13 ring-ui-docs@0.1.12 ring-ui-docs@0.1.11 ring-ui-docs@0.1.10 ring-ui-docs@0.1.9 ring-ui-docs@0.1.8 ring-ui-docs@0.1.7 ring-ui-docs@0.1.6 ring-ui-docs@0.1.5 ring-ui-docs@0.1.4 ring-ui-docs@0.1.3 ring-ui-docs@0.1.2 ring-ui-docs@0.1.1 legacy-2.6 legacy-2.5 legacy-2.4 legacy-2.3 legacy-2.2 legacy-2.1 legacy-2.0 legacy-1.1 legacy-1.0 @jetbrains/ring-ui@1.0.0-beta.5 @jetbrains/ring-ui@1.0.0-beta.4 @jetbrains/ring-ui@1.0.0-beta.3 @jetbrains/ring-ui@1.0.0-beta.2 @jetbrains/ring-ui@1.0.0-beta.1 @jetbrains/ring-ui@1.0.0-beta.0 @jetbrains/ring-ui@0.2.6 @jetbrains/ring-ui@0.2.5 @jetbrains/ring-ui@0.2.4 @jetbrains/ring-ui@0.2.3 @jetbrains/ring-ui@0.2.2 @jetbrains/ring-ui@0.2.1 @jetbrains/ring-ui@0.2.0 @jetbrains/ring-ui@0.1.25 @jetbrains/ring-ui@0.1.24 @jetbrains/ring-ui@0.1.23 @jetbrains/ring-ui@0.1.22 @jetbrains/ring-ui@0.1.21 @jetbrains/ring-ui@0.1.20 @jetbrains/ring-ui@0.1.19 @jetbrains/ring-ui@0.1.18 @jetbrains/ring-ui@0.1.17 @jetbrains/ring-ui@0.1.16 @jetbrains/ring-ui@0.1.15 @jetbrains/ring-ui@0.1.14 @jetbrains/ring-ui@0.1.13 @jetbrains/ring-ui@0.1.12 @jetbrains/ring-ui@0.1.11 @jetbrains/ring-ui@0.1.10 @jetbrains/ring-ui@0.1.9 @jetbrains/ring-ui@0.1.8 @jetbrains/ring-ui@0.1.7 @jetbrains/ring-ui@0.1.6 @jetbrains/ring-ui@0.1.5 @jetbrains/ring-ui@0.1.4 @jetbrains/ring-ui@0.1.3 @jetbrains/ring-ui@0.1.2 @jetbrains/generator-ring-ui@1.0.0-beta.5 @jetbrains/generator-ring-ui@1.0.0-beta.4 @jetbrains/generator-ring-ui@1.0.0-beta.3 @jetbrains/generator-ring-ui@1.0.0-beta.2 @jetbrains/generator-ring-ui@1.0.0-beta.1 @jetbrains/generator-ring-ui@1.0.0-beta.0 @jetbrains/generator-ring-ui@0.2.6 @jetbrains/generator-ring-ui@0.2.5 @jetbrains/generator-ring-ui@0.2.4 @jetbrains/generator-ring-ui@0.2.3
Nothing to show
Permalink
Failed to load latest commit information.
.idea RG-1493 Icon package should contain icons precompiled to React compon… Aug 22, 2017
components RG-1531 fixed selector in unit-test Aug 22, 2017
packages RING-UI-CR-2945 Regather gemini for logos Aug 22, 2017
test-helpers RG-1442 Discourage `expect(smth)` usage in favour of `smth.should()` Jul 6, 2017
.editorconfig Default .editorconfig Oct 16, 2014
.eslintignore [Publish] Stop using global angular Aug 2, 2017
.eslintrc RG-1435 Switch to glob-based ESLint config Jul 17, 2017
.flowconfig Add to Flow's ignore list: /node_modules/stylelint/lib Jul 3, 2017
.gitignore Commit package-lock.json files Aug 17, 2017
CHANGELOG.md RING-UI-CR-2945 Don't use import from `components/icon/logo` in examp… Aug 22, 2017
CONTRIBUTING.md RING-UI-CR-2921 Use component imports for icons and logos. Bump minor… Aug 10, 2017
LICENSE.txt update license text to correct text of Apache-2.0 Aug 2, 2017
README.md Update README.md Aug 10, 2017
icon-runtime-generator.js RING-UI-CR-2945 Get rid of one more circular dependency. Update "all … Aug 22, 2017
jslint-xml.js RG-1444 Merge eslint and stylelint reports Jul 7, 2017
karma-base.conf.js RG-1484 Drop hostname: it is not needed in docker Aug 2, 2017
karma-ci.conf.js Revert "RG-1484 dealing with tests in docker container" Aug 2, 2017
karma-crossbrowser.conf.js Update CI scripts. Temporarily turn off tests Aug 1, 2017
karma-watch.conf.js RING-UI-CR-1909 Update eslint config Apr 14, 2017
karma.conf.js RING-UI-CR-1909 Update eslint config Apr 14, 2017
lerna.json RG-1493 Icon package should contain icons precompiled to React compon… Aug 22, 2017
package-lock.json RING-UI-CR-2945 Get rid of circular dependency to fix tests with cove… Aug 22, 2017
package.json RG-1493 Icon package should contain icons precompiled to React compon… Aug 22, 2017
postcss.config.js RING-UI-CR-2898 drop unneeded cssnext settings line Aug 5, 2017
stylelint.config.js RG-1164 move to @jetbrains-scoped package Jun 20, 2017
wallaby.config.js RG-1395 Rewrite some commits in jetbrains-eslint-config and publish i… Jul 4, 2017
webpack-test.config.js RG-1512 Create a custom runtime generator for svg-sprite-loader Aug 10, 2017
webpack.config.js RG-1474 Do not import jetbrains-logos to ring ui itself – should be i… Aug 14, 2017

README.md

Ring UI — JetBrains Web UI components

Build Status Dependencies Status Dev Dependencies Status NPM version NPM downloads

This collection of UI components aims to provide all of the necessary building blocks for web-based products built inside JetBrains, as well as third-party plugins developed for JetBrains' products.

Quick start

  1. Install Yeoman and Ring UI generator: npm install -g yo @jetbrains/generator-ring-ui
  2. Go to the root directory of your project (create one if necessary) and run yo @jetbrains/ring-ui. After you enter the name of the project all the necessary npm dependencies will be installed.
  3. You project is ready to be developed. The following commands are available:
    • npm start to run a local development server
    • npm test to launch karma tests
    • npm run lint to lint your code
    • npm run build to build a production bundle
    • npm run create-component to create a new component template with styles and tests

Not-so-quick start

In case boilerplate generators are not your thing and you prefer to understand the inner workings a bit better.

  1. Install Ring UI with npm install @jetbrains/ring-ui --save-exact

  2. If you are building your app with webpack, make sure to import ring-ui components where needed. Otherwise, create an entry point (for example, /app/app__components.tpl.js) and import the components there.

    import React from 'react';
    import ReactDOM from 'react-dom';
    import LoaderInline from '@jetbrains/ring-ui/components/loader-inline/loader-inline';
    
    ReactDOM.render(<LoaderInline/>, document.getElementById('container'));
  3. Create webpack.config.js with the following contents (example):

    const ringConfig = require('@jetbrains/ring-ui/webpack.config').config;
    
    const webpackConfig = {
      entry: 'src/entry.js', // your entry point for webpack
      output: {
        path: 'path/to/dist',
        filename: '[name].js'
      },
      module: {
        rules: [
          ...ringConfig.module.rules,
          <Your rules here>
        ]
      }
    };
    
    module.exports = webpackConfig;

Links