acs

angular-contentful-service

[![GitHub release](https://img.shields.io/github/release/UseAllFive/angular-contentful-service.svg)]() [![GitHub license](https://img.shields.io/github/license/UseAllFive/angular-contentful-service.svg)](https://github.com/UseAllFive/angular-contentful-se

Showing:

Popularity

Downloads/wk

17

Maintenance

No Maintenance Data Available

Package

Dependencies

0

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

GitHub release GitHub license GitHub issues Twitter

Angular Contentful Service

A contentful.js wrapper for Angular that makes our lives just a bit easier. Also, requests to the Contentful API are cached for improved performance!

Installation

Install with NPM

npm i --save angular-contentful-service

Install contentful

If you haven't already, make sure you install contentful

npm i --save contentful

Add to your app module

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { ContentfulModule } from 'angular-contentful-service';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    ContentfulModule.forRoot({
      space: 'yadj1kx9rmg0', // your space ID
      accessToken: 'fdb4e7a3102747a02ea69ebac5e282b9e44d28fb340f778a4f5e788625a61abe', // your access token
    }),
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

Use the Contentful Service

import { Component } from '@angular/core';
import { ContentfulService } from 'angular-contentful-service'

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.css']
})
export class AppComponent {

  constructor(private cs: ContentfulService) {}

  getEntries(query?: any) {
    this.cs.getEntries(query).then(res => console.log(res));
  }

  getEntry(id: string, query?: any) {
    this.cs.getEntry(id, query).then(res => console.log(res));
  }
}

Configuration options

{
  space: string;
  accessToken: string;
  insecure?: boolean;
  host?: string;
  basePath?: string;
  httpAgent?: any;
  httpsAgent?: any;
  proxy?: {
    host: string;
    port?: number;
    auth?: {
      username: string;
      password: string;
    };
  };
  headers?: any;
  application?: string;
  integration?: string;
  resolveLinks?: boolean;
  retryOnError?: boolean;
}

Service methods

getEntries()

Return all entries filtered by Contentful query

getEntries(query?: any): Promise<EntryCollection<any>>

Information on EntryCollection type found here: https://github.com/contentful/contentful.js/blob/master/index.d.ts#L34

Example:

this.cs.getEntries({include: 2});

getEntry()

Return a single entry object based on id and optional query params

getEntry(id: string, query?: any): Promise<Entry<any>>

Information on Entry type found here: https://github.com/contentful/contentful.js/blob/master/index.d.ts#L65

Example:

this.cs.getEntry('3xd57HfJlSM2qmm8C6cueK', {include: 2})

Contribute

Please feel free to contribute to this repository. To do so, simply clone this repository and run ng serve to get the project working locally.

Brought to you by

Use All Five

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial