https://github.com/ringcentral/ringcentral-js-widgets
RingCentral Integration Widget Library
https://github.com/ringcentral/ringcentral-js-widgets
integration ringcentral widget
Last synced: 5 months ago
JSON representation
RingCentral Integration Widget Library
- Host: GitHub
- URL: https://github.com/ringcentral/ringcentral-js-widgets
- Owner: ringcentral
- License: mit
- Created: 2016-05-06T01:45:07.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2026-01-15T07:28:10.000Z (5 months ago)
- Last Synced: 2026-01-15T08:40:18.830Z (5 months ago)
- Topics: integration, ringcentral, widget
- Language: TypeScript
- Homepage:
- Size: 108 MB
- Stars: 45
- Watchers: 28
- Forks: 41
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ringcentral-js-widgets
[](https://github.com/ringcentral/ringcentral-js-widgets/actions)
[](https://www.npmjs.com/package/@ringcentral-integration/commons)
[](https://www.npmjs.com/package/@ringcentral-integration/widgets)
## Introduction
RingCentral integration widgets aim to provide reusable RingCentral service module and UI components to allow developers to integrate RingCentral unified communication service into third party processes or tools more easily.
This project includes [RingCentral Integration Common Library](packages/ringcentral-integration/README.md) and [RingCentral Widgets Library](packages/ringcentral-widgets/README.md). The basic idea is to connect modules in RingCentral Integration Common Library with React components to provide ready to use UI widgets.
## Get Started
We use [RingCentral Widgets CLI](packages/ringcentral-widgets-cli/README.md) to startup a RingCentral Widgets based app.
```
$ npm install -g ringcentral-widgets-cli
$ rc-widgets -h
```
### Create a new project
```
rc-widgets new your_project_name
cd your_project_name
yarn install
```
[Update `.env` file in project root path](packages/ringcentral-widgets-cli/README.md#start-developement-server).
### Start development server
```
$ yarn start
```
Visit on [http://localhost:8080](http://localhost:8080) in browser.
For production build and deploy, please get more information in [here](packages/ringcentral-widgets-cli/README.md).
### Tutorials
This is a [demo](https://github.com/ringcentral-tutorials/ringcentral-widgets-demo) and [step-by-step tutorials](https://ringcentral-tutorials.github.io/ringcentral-widgets-demo/) show how to use this library.
## Contribution and Development
We use [Lerna.js](https://github.com/lerna/lerna) to manage packages source. And we require Node.js > 8.
Clone the repo:
```bash
$ git clone https://github.com/ringcentral/ringcentral-js-widgets.git
$ cd ringcentral-js-widgets
```
Install dependent libraries:
```bash
$ yarn
```
Test:
```bash
$ yarn test # Run tests
```
Commit:
```bash
$ git add .
$ yarn commit
or
$ yarn git-cz
```
### Play with Development Server
A development server is delivered with source so that developers can use it to get familiar with the project or do further development. To get development server running：
Create a file named `api-config.js` in following format in folder `packages/ringcentral-widgets-demo/dev-server` to specify app related info
```javascript
export default {
appKey: ${app key},
appSecret: ${app secret},
server: ${server url},
};
```
Run following command to start development server
```bash
$ yarn start
```
The development server is listening on port `8080` by default.
Open up your browser and access http://localhost:8080 to see how it works.
Note that the development server is using OAuth for authorization process.
Please make sure the app you specified in configuration above is setup with Redirect Uri `http://localhost:8080/redirect.html`.
## Projects which use this library
- [RingCentral Embeddable](https://github.com/ringcentral/ringcentral-embeddable)
- [RingCentral for Google Extension 4.0](https://chrome.google.com/webstore/detail/ringcentral-for-google/fddhonoimfhgiopglkiokmofecgdiedb)