openvidu/openvidu-components-angular/projects/openvidu-angular
Carlos Santos 8c18f4b366 openvidu-components: Released v2.29.3 2023-12-11 13:41:01 +01:00
..
doc openvidu-components: Updated docs 2022-11-21 12:27:45 +01:00
src openvidu-components: Emitted event when broadcasting button is clicked 2023-12-11 13:02:02 +01:00
.browserslistrc openvidu-components: Added webcomponent E2E tests 2022-03-16 12:15:22 +01:00
.prettierrc openvidu-components: Renamed library to openvidu-angular 2022-01-20 09:58:12 +01:00
README.md openvidu-components: Updated README 2023-01-26 10:48:32 +01:00
karma.conf.js openvidu-components: Renamed library to openvidu-angular 2022-01-20 09:58:12 +01:00
ng-package.json openvidu-components: Renamed library to openvidu-angular 2022-01-20 09:58:12 +01:00
package-lock.json Update to version 2.29.0 2023-10-18 19:47:56 +00:00
package.json openvidu-components: Released v2.29.3 2023-12-11 13:41:01 +01:00
tsconfig.lib.json openvidu-components: Reduced openvidu-angular bundle size 2023-02-22 15:53:25 +01:00
tsconfig.lib.prod.json openvidu-components: Reduced openvidu-angular bundle size 2023-02-22 15:53:25 +01:00
tsconfig.spec.json openvidu-components: Renamed library to openvidu-angular 2022-01-20 09:58:12 +01:00

README.md

openvidu-angular

OpenVidu Components for Angular.

License badge OpenVidu Tests OpenVidu Tests Npm version Npm downloads

The easier way to build powerful OpenVidu videoconference frontend applications.

Requirements:

You will need NPM and Angular CLI to serve the Angular app. Check your installation with the following command:

npm -v
ng v

How to install it

  1. You need to install the openvidu-angular library in your Angular application:
npm install openvidu-angular

  1. Also you need Angular Material. Check the Angular Material documentation for installing it.

Configure it

You need to import the openvidu-angular module in your app.module.ts:

import { OpenViduAngularConfig, OpenViduAngularModule } from 'openvidu-angular';
import { environment } from 'src/environments/environment';

const config: OpenViduAngularConfig = {
    production: environment.production
};

@NgModule({
    imports: [
        ...
        OpenViduAngularModule.forRoot(config)
    ]
})

You can also add the default styles in your styles.scss file:

:root {
	--ov-primary-color: #303030;
	--ov-secondary-color: #3e3f3f;
	--ov-tertiary-color: #598eff;
	--ov-warn-color: #eb5144;
	--ov-accent-color: #ffae35;
	--ov-light-color: #e6e6e6;

	--ov-logo-background-color: #3a3d3d;

	--ov-text-color: #ffffff;

	--ov-panel-text-color: #1d1d1d;
	--ov-panel-background: #ffffff;

	--ov-buttons-radius: 50%;
	--ov-leave-button-radius: 10px;
	--ov-video-radius: 5px;
	--ov-panel-radius: 5px;
}

How to use it

OpenVidu team has created a few tutorials to help you to start using OpenVidu Angular components. You can find them here.

openvidu-angular API

openvidu-angular API documentation is available here.