@builder.io/sdk-angular
v0.17.0
Published
This is Builder's Gen2 Angular SDK.
Downloads
1,498
Maintainers
Keywords
Readme
Builder.io Angular SDK
This is Builder's Gen2 Angular SDK.
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 { fetchOneEntry, type BuilderContent } from '@builder.io/sdk-angular';
@Component({
selector: 'app-catchall',
template: `
<ng-container *ngIf="content; else notFound">
<builder-content [model]="model" [content]="content" [apiKey]="apiKey"></builder-content>
</ng-container>
<ng-template #notFound>
<div>404 - Content not found</div>
</ng-template>
`,
})
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 >=16.2.12
.