Webex Widgets are a set of self-contained React components that follow the Webex products experience, aimed at developers that want to embed Webex into their applications.
The Webex Component System is considered to be in beta stage and it's not a generally available product from Webex at this time. This means that the Webex Component System is available for everyone to use but breaking changes may occur as we develop it. We try our best to minimize any breaking changes but they may occur. While the Webex Component System is not a GA product, we still offer support through all regular channels. However, bug priority is given to product already generally available. We love for you to use the Webex Component System and be part of the feedback process!
npm install --save webex @webex/widgetsNotice that the Webex Javascript SDK has to be installed as a peer dependency.
In addition to the Webex Widgets, we also offer the Webex Component System. The Webex Component System (sometimes shortened as Webex Components) is a set of React components that, while following Webex styling, allow for more granularity in terms of layout and source of data. To learn more on the Webex Component System head to its Github repository at https://github.com/webex/components.
Webex Widgets are based on Webex Components but include the adapter that uses our Javascript SDK to talk to Webex services for you. This means that the Webex Widgets use the SDK Component Adapter to inject the Webex data. All you need is a valid access token and a few parameters based on the widget you want to use.
You have to take the Widget layout as-is, but the benefit is that there are no configurations needed. Install, copy-paste and you have the power of Webex in your application!
In order to properly style Webex Widgets, you will need to import our CSS separately.
Import @webex/widgets/dist/webexWidgets.css into your main entry file.
There are two ways to do this:
In your App.js[x], add the following import:
import '@webex/widgets/dist/webexWidgets.css';
...In the <head> tag of your index.html, add the following tag:
<head>
...
<link rel="stylesheet" type="text/css" href="node_modules/@webex/widgets/dist/webexWidgets.css" />
</head>For this to work, make sure that your node_modules folder is served.
Alternately, you may copy the CSS file to your public folder and update the link
reference accordingly.
Please make sure to install the Webex Javascript SDK along with the Webex Widget package.
npm install --save webex @webex/widgetsTo use a Webex Widget, simply import the desired widget and render it into your React application.
import React from 'react';
import {WebexMeetingWidget} from '@webex/widgets';
import '@webex/widgets/dist/webexWidgets.css';
export default function App() {
return <WebexMeetingWidget accessToken="<YOUR_ACCESS_TOKEN>" meetingDestination="<MEETING_DESTINATION>" />;
}We'd love for you to contribute to our source code and to make the Webex Widgets even better than they are today! Here are some guidelines that we'd like you to follow.
Please open an issue and we will get to it in an orderly manner. Please leave as much as information as possible for a better understanding.
We are using Airbnb-style lint rules and prettier to lint the code. Make sure your code your code follows our lint rules before submitting!
For more information on contributions, please visit our contributing guide.
We are using commitlint to lint the commit messages. Please make sure to choose the appropriate commit type, scope and subject.
For more developer resources, tutorials and support, visit the Webex developer portal, https://developer.webex.com.