TS 中文文档

ngx-facebook


This is a wrapper for the official Facebook JavaScript SDK. It makes it easier to use Facebook SDK with Angular by providing components, providers and types.

Installation


1. Install via NPM:


  1. ``` shell
  2. npm i -S ngx-facebook
  3. ```

2. Add the Facebook JavaScript SDK to your index.html


  1. ``` html
  2. <script type="text/javascript" src="https://connect.facebook.net/en_US/sdk.js"></script>
  3. ```

3. Import FacebookModule into your app's root module


  1. ``` ts
  2. import { FacebookModule } from 'ngx-facebook';

  4. @NgModule({
  5.   ...
  6.   imports: [
  7.     FacebookModule.forRoot()
  8.   ],
  9.   ...
  10. })
  11. export class AppModule { }
  12. ```

4. Inject FacebookService and call the init method (optional):


This method must be called before using login or api methods. It is not required for other methods/components.

  1. ``` ts
  2. import { FacebookService, InitParams } from 'ngx-facebook';

  4. ...

  6. export class MyComponentOrService {

  8.   constructor(private fb: FacebookService) {

  10.     const initParams: InitParams = {
  11.       appId: '1234566778',
  12.       xfbml: true,
  13.       version: 'v2.8'
  14.     };

  16.     fb.init(initParams);

  18.   }

  20. }
  21. ```

Documentation


You can view complete and detailed documentation by visiting https://zyra.github.io/ngx-facebook/.

Example Usage


You can view our example project here and/or view its source code here

Example of login with Facebook


  1. ``` ts
  2. import { FacebookService, LoginResponse } from 'ngx-facebook';

  4. @Component(...)
  5. export class MyComponent {

  7.   constructor(private fb: FacebookService) { }

  9.   loginWithFacebook(): void {

  11.     this.fb.login()
  12.       .then((response: LoginResponse) => console.log(response))
  13.       .catch((error: any) => console.error(error));
  14.   }

  16. }
  17. ```

Example of sharing on Facebook


  1. ``` ts
  2. import { FacebookService, UIParams, UIResponse } from 'ngx-facebook';

  4. ...

  6. share(url: string) {

  8.   const params: UIParams = {
  9.     href: 'https://github.com/zyra/ngx-facebook',
  10.     method: 'share'
  11.   };

  13.   this.fb.ui(params)
  14.     .then((res: UIResponse) => console.log(res))
  15.     .catch((e: any) => console.error(e));

  17. }
  18. ```

Example of adding a Facebook like button


  1. ``` html
  2. <fb-like href="https://github.com/zyra/ngx-facebook"></fb-like>
  3. ```

Example of playing a Facebook video


Basic video component usage:


  1. ``` html
  2. <fb-video href="https://www.facebook.com/facebook/videos/10153231379946729/"></fb-video>
  3. ```

Advanced video component usage:


  1. ``` html
  2. <fb-video href="https://www.facebook.com/facebook/videos/10153231379946729/" (paused)="onVideoPaused($event)"></fb-video>
  3. ```

  1. ``` ts
  2. import { Component, ViewChild } from '@angular/core';
  3. import { FBVideoComponent } from 'ngx-facebook';

  5. @Component(...)
  6. export class MyComponent {

  8.   @ViewChild(FBVideoComponent) video: FBVideoComponent;

  10.   ngAfterViewInit() {
  11.     this.video.play();
  12.     this.video.pause();
  13.     this.video.getVolume();
  14.   }

  16.   onVideoPaused(ev: any) {
  17.     console.log('User paused the video');
  18.   }

  20. }
  21. ```

Versioning


We use SemVer for versioning. For the versions available, see the tags on this repository.

Contribution


Having an issue? or looking for support? Open an issue and we will get you the help you need.
Got a new feature or a bug fix? Fork the repository, make your changes, and submit a pull request.

License


This project is licensed under the MIT License - see the LICENSE.md file for details

Support this project


If you find this project useful, please star the repository to let people know that it's reliable. Also, share it with friends and colleagues that might find this useful as well. Thank you 😄