Ring UI

A collection of JetBrains Web UI components

ReactComponent Toolkit
JetBrains/ring-uijetbrains.github.io/ring-ui

README

Ring UI — JetBrains Web UI components [![Storybook][storybook-img]][docsite] [![Build Status][ci-img]][ci-bt] [![Storybook][browserstack-img]][browserstack-build-page] [![Dependencies Status][deps-img]][deps] [![Dev Dependencies Status][dev-deps-img]][dev-deps] [![NPM version][npm-version-img]][npm-package] [![NPM downloads][npm-count-img]][npm-package]

official JetBrains project

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

Try now

Try the codesandbox, based oncreate-react-app tooling, to see and try the UI components
Check out list of examples for each component

Installation


npm install @jetbrains/ring-ui

Quick start


The easiest way is to import necessary components as ES modules:
  1. ``` js
  2. // You need to import RingUI styles once
  3. import '@jetbrains/ring-ui/dist/style.css';

  5. import alertService from '@jetbrains/ring-ui/dist/alert-service/alert-service';
  6. import Button from '@jetbrains/ring-ui/dist/button/button';

  8. ...

  10. export const Demo = () => {
  11.   return (
  12.     <Button onClick={() => alertService.successMessage('Hello world')}>
  13.       Click me
  14.     </Button>
  15.   );
  16. };

  18. ```

The bundle size will depend on the amount of components you imported.

Building Ring UI from source via Webpack


In case you have complex build, and you want to compile RingUI sources together with your sources
in a same build process, you can use the following configuration:

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.
  1. ``` javascript
  2.    import React from 'react';
  3.    import ReactDOM from 'react-dom';
  4.    import LoaderInline from '@jetbrains/ring-ui/components/loader-inline/loader-inline';
  5.   
  6.    ReactDOM.render(<LoaderInline/>, document.getElementById('container'));
  7. ```

3. Create webpack.config.js with the following contents (example):
  1. ``` javascript
  2.    const ringConfig = require('@jetbrains/ring-ui/webpack.config').config;
  3.   
  4.    const webpackConfig = {
  5.      entry: 'src/entry.js', // your entry point for webpack
  6.      output: {
  7.        path: 'path/to/dist',
  8.        filename: '[name].js'
  9.      },
  10.      module: {
  11.        rules: [
  12.          ...ringConfig.module.rules,
  13.          <Your rules here>
  14.        ]
  15.      }
  16.    };
  17.   
  18.    module.exports = webpackConfig;
  19. ```

Contributing


See CONTRIBUTING.md

Links


- [Living style guide][docsite]
- GitHub repository
- Issues in YouTrack
- Code review in Upsource
- [Builds in TeamCity][ci-project]
- [npm package][npm-package]

[docsite]: https://jetbrains.github.io/ring-ui
[ci-project]: https://teamcity.jetbrains.com/project.html?projectId=JetBrainsUi_RingUi&tab=projectOverview
[ci-bt]: https://teamcity.jetbrains.com/viewType.html?buildTypeId=JetBrainsUi_RingUi_GeminiTests&tab=buildTypeStatusDiv
[ci-img]:  https://teamcity.jetbrains.com/app/rest/builds/buildType:JetBrainsUi_RingUi_GeminiTests/statusIcon.svg
[deps]: https://david-dm.org/jetbrains/ring-ui
[deps-img]: https://img.shields.io/david/jetbrains/ring-ui.svg
[dev-deps]: https://david-dm.org/jetbrains/ring-ui?type=dev
[dev-deps-img]: https://img.shields.io/david/dev/jetbrains/ring-ui.svg
[npm-package]: https://www.npmjs.com/package/@jetbrains/ring-ui
[npm-version-img]: https://img.shields.io/npm/v/@jetbrains/ring-ui.svg
[npm-count-img]: https://img.shields.io/npm/dt/@jetbrains/ring-ui.svg
[storybook-img]: https://cdn.jsdelivr.net/gh/storybookjs/brand@master/badge/badge-storybook.svg
[browserstack-img]: https://automate.browserstack.com/badge.svg?badge_key=elc3S1IvemtCdHBjcHdmQzdRcm9xYWxTakFvSWFqT2lrOGtrTjZRbFVRaz0tLXE0VnpyUjRqSk1Xc2xIQ1NnL1pkbnc9PQ==--f96a555ca0fe3ce50d0770cb975be0f3b6a6cf79
[browserstack-build-page]: https://automate.browserstack.com/public-build/elc3S1IvemtCdHBjcHdmQzdRcm9xYWxTakFvSWFqT2lrOGtrTjZRbFVRaz0tLXE0VnpyUjRqSk1Xc2xIQ1NnL1pkbnc9PQ==--f96a555ca0fe3ce50d0770cb975be0f3b6a6cf79