Builder.io Angular SDK

This is Builder's Gen2 Angular SDK.

Framework versions

The peerDependencies permit Angular core and common >=17.3.0. This installation range does not establish an actively supported minimum; see the framework version matrix.

Getting Started

npm install @builder.io/sdk-angular

To use the SDK, you need to:

• fetch the builder data using fetchOneEntry: you can see how to use it here https://www.builder.io/c/docs/content-api.
• pass that data to the Content component. Here is a simplified example showing how you would use both:

import { Component } from '@angular/core';
import { Content, fetchOneEntry, type BuilderContent } from '@builder.io/sdk-angular';

@Component({
  selector: 'app-catchall',
  standalone: true,
  imports: [Content],
  template: `
    @if (content) {
      <builder-content [model]="model" [content]="content" [apiKey]="apiKey"></builder-content>
    } @else {
      <div>404 - Content not found</div>
    }
  `,
})
export class CatchAllComponent {
  apiKey = 'YOUR_API_KEY';
  model = 'page';
  content: BuilderContent | null = null;

  async ngOnInit() {
    const urlPath = window.location.pathname || '';

    const content = await fetchOneEntry({
      apiKey: this.apiKey,
      model: this.model,
      userAttributes: {
        urlPath,
      },
    });

    if (!content) {
      return;
    }

    this.content = content;
  }
}

Mitosis

This SDK is generated by Mitosis. To see the Mitosis source-code, go here.

Feature Support

To check the status of the SDK, look at these tables.

Fetch

This Package uses fetch. See these docs for more information.

Version Support

This SDK supports Angular version >=17.3.0.