@builder.io/sdk-react 0.6.2 → 0.6.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@builder.io/sdk-react",
3
3
  "description": "Builder.io SDK for React",
4
- "version": "0.6.2",
4
+ "version": "0.6.4",
5
5
  "files": [
6
6
  "lib",
7
7
  "types"
@@ -1 +1 @@
1
- export declare const SDK_VERSION = "0.6.2";
1
+ export declare const SDK_VERSION = "0.6.4";
@@ -35,6 +35,19 @@ type GetBuilderPropsOptions = (Omit<GetContentOptions, 'model'> & {
35
35
  /**
36
36
  * Given an `apiKey` and `url` (or `path` + `searchParams`), provides all props that `Content` needs to render Builder Content.
37
37
  *
38
+ * @example
39
+ * ```jsx
40
+ * const builderProps = await fetchBuilderProps({
41
+ * apiKey: 'API_KEY',
42
+ * // provide `url`
43
+ * url: yourPageUrl,
44
+ * // OR provide `path` + `searchParams`
45
+ * path: yourPath,
46
+ * searchParams: yourSearchParams,
47
+ * });
48
+ *
49
+ * return <Content {...builderProps} />;
50
+ * ```
38
51
  */
39
52
  export declare const fetchBuilderProps: (_args: GetBuilderPropsOptions) => Promise<ContentVariantsPrps>;
40
53
  export {};
@@ -97,7 +97,6 @@ export interface ComponentInfo {
97
97
  */
98
98
  query?: any;
99
99
  };
100
- /** not yet implemented */
101
100
  friendlyName?: string;
102
101
  /**
103
102
  * Use to restrict access to your component based on a the current user permissions