@builder.io/sdk-vue 0.0.1-5 → 0.0.1-52

package/CHANGELOG.md

@@ -0,0 +1,26 @@
+### 0.0.1-51
+
+⚠️ Deprecation notice: Registering components via `registerComponent(component, info)` is now deprecated. 
+To register your custom components in Builder, you must now provide a `customComponents` array to the `RenderContent` component containing `[{ component, info }]`.
+See [builder-registered-components.ts](/packages/sdks/src/constants/builder-registered-components.ts) for examples of how to do so, or see the example provided for this SDK.
+
+### 0.0.1-50
+
+- feat: 🎸 export `isPreviewing()` (https://github.com/BuilderIO/builder/pull/951)
+- feat: 🎸 Add support for Symbols (https://github.com/BuilderIO/builder/pull/951)
+- feat: 🎸 Add support for Data Bindings https://github.com/BuilderIO/builder/pull/970
+
+- BREAKING CHANGE: 🧨 RenderContent must now be provided the `apiKey` as a prop (https://github.com/BuilderIO/builder/pull/951)
+### 0.0.1-49
+
+- Fix: show the "+ add block" button on empty pages https://github.com/BuilderIO/builder/pull/934
+- Add `getBuilderSearchParams` helper export to easily view current drafts on your production site. https://github.com/BuilderIO/builder/pull/883
+
+### 0.0.1-48
+
+Changes:
+
+- Adds support for Columns https://github.com/BuilderIO/builder/pull/717
+- Add preliminary support for Children within custom components https://github.com/BuilderIO/builder/pull/753
+- Seeds classnames to reduce variation in changes https://github.com/BuilderIO/builder/pull/703
+- Fixes `getAllContent` to traverse all symbols/references https://github.com/BuilderIO/builder/pull/718

package/README.md

@@ -0,0 +1,48 @@
+# Builder.io Vue 2.0 SDK (BETA)
+
+This is the 2.0 Vue SDK. It is currently in beta.
+
+NOTE: If you are looking for the stable 1.0 Vue SDK, you can find it [here](/packages/vue)
+
+## Feature Support
+
+To check the status of the SDK, look at [these tables](../../README.md#feature-implementation).
+
+## Version Support
+
+Legend:
+
+- ✅: implemented
+- 🏗: currently in progress
+- ⚠️: not-yet implemented
+- N/A : does not apply
+
+| Platform | Support |
+| -------- | ------- |
+| Vue 2    | 🏗       |
+| Nuxt 2   | 🏗       |
+| Vue 3    | ⚠️      |
+| Nuxt 3   | ⚠️      |
+
+## Getting Started
+
+```
+npm install @builder.io/sdk-vue@dev
+```
+
+## Usage with Nuxt
+
+> Requires nuxt >= @2.15
+
+Add to your `nuxt.config.js`:
+
+```js
+buildModules: ['@builder.io/sdk-vue/nuxt'];
+```
+
+Then register built in and custom components as seen [here](/examples/vue/nuxt-2/scripts/register-builder-components.js)
+
+You can see examples of using Builder.io:
+
+- with Nuxt [here](/examples/vue/nuxt-2/)
+- with Vue Storefront [here](/examples/vue/vue-storefront-2)

package/nuxt.js

@@ -0,0 +1,24 @@
+import { join } from 'path';
+
+export default function () {
+  // Make sure components is enabled
+  if (!this.nuxt.options.components) {
+    throw new Error(
+      'Please set `components: true` inside `nuxt.config` and ensure using `nuxt >= 2.13.0`'
+    );
+  }
+
+  this.nuxt.hook('components:dirs', (dirs) => {
+    // Add ./components dir to the list
+    dirs.push({
+      path: join(__dirname, 'nuxt2/src/components'),
+      prefix: 'builder',
+    });
+    // Add ./blocks dir to the list
+    dirs.push({
+      path: join(__dirname, 'nuxt2/src/blocks'),
+      prefix: 'builder',
+      pattern: "**/index.*",
+    });
+  });
+}

package/nuxt2/src/blocks/button/button.vue

@@ -0,0 +1,19 @@
+<template>
+  <a
+    v-bind="attributes"
+    role="button"
+    v-if="link"
+    :href="link"
+    :target="openLinkInNewTab ? '_blank' : undefined"
+  >
+    {{ text }}
+  </a>
+  <span v-bind="attributes" v-else="">{{ text }}</span>
+</template>
+<script>
+export default {
+  name: "builder-button",
+
+  props: ["attributes", "text", "link", "openLinkInNewTab"],
+};
+</script>

package/nuxt2/src/blocks/button/component-info.js

@@ -0,0 +1,48 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+__export(exports, {
+  componentInfo: () => componentInfo
+});
+const componentInfo = {
+  name: "Core:Button",
+  builtIn: true,
+  image: "https://cdn.builder.io/api/v1/image/assets%2FIsxPKMo2gPRRKeakUztj1D6uqed2%2F81a15681c3e74df09677dfc57a615b13",
+  defaultStyles: {
+    appearance: "none",
+    paddingTop: "15px",
+    paddingBottom: "15px",
+    paddingLeft: "25px",
+    paddingRight: "25px",
+    backgroundColor: "#000000",
+    color: "white",
+    borderRadius: "4px",
+    textAlign: "center",
+    cursor: "pointer"
+  },
+  inputs: [
+    {
+      name: "text",
+      type: "text",
+      defaultValue: "Click me!",
+      bubble: true
+    },
+    {
+      name: "link",
+      type: "url",
+      bubble: true
+    },
+    {
+      name: "openLinkInNewTab",
+      type: "boolean",
+      defaultValue: false,
+      friendlyName: "Open link in new tab"
+    }
+  ],
+  static: true,
+  noWrap: true
+};

package/nuxt2/src/blocks/columns/columns.vue

@@ -0,0 +1,107 @@
+<template>
+  <div class="builder-columns div-4wbls88y960" :style="columnsCssVars">
+    <div
+      class="builder-column div-4wbls88y960-2"
+      v-for="(column, index) in columns"
+      :style="{
+        width: getColumnCssWidth(index),
+        marginLeft: `${index === 0 ? 0 : getGutterSize()}px`,
+        ...columnCssVars,
+      }"
+      :key="index"
+    >
+      <render-blocks :blocks="column.blocks"></render-blocks>
+    </div>
+  </div>
+</template>
+<script>
+import RenderBlocks from "../../components/render-blocks";
+
+export default {
+  name: "builder-columns",
+  components: { "render-blocks": async () => RenderBlocks },
+  props: ["space", "columns", "stackColumnsAt", "reverseColumnsWhenStacked"],
+
+  computed: {
+    columnsCssVars() {
+      const flexDir =
+        this.stackColumnsAt === "never"
+          ? "inherit"
+          : this.reverseColumnsWhenStacked
+          ? "column-reverse"
+          : "column";
+      return {
+        "--flex-dir": flexDir,
+        "--flex-dir-tablet": this.maybeApplyForTablet(flexDir),
+      };
+    },
+    columnCssVars() {
+      const width = "100%";
+      const marginLeft = "0";
+      return {
+        "--column-width": width,
+        "--column-margin-left": marginLeft,
+        "--column-width-tablet": this.maybeApplyForTablet(width),
+        "--column-margin-left-tablet": this.maybeApplyForTablet(marginLeft),
+      };
+    },
+  },
+
+  methods: {
+    getGutterSize() {
+      return typeof this.space === "number" ? this.space || 0 : 20;
+    },
+    getColumns() {
+      return this.columns || [];
+    },
+    getWidth(index) {
+      const columns = this.getColumns();
+      return columns[index]?.width || 100 / columns.length;
+    },
+    getColumnCssWidth(index) {
+      const columns = this.getColumns();
+      const gutterSize = this.getGutterSize();
+      const subtractWidth =
+        (gutterSize * (columns.length - 1)) / columns.length;
+      return `calc(${this.getWidth(index)}% - ${subtractWidth}px)`;
+    },
+    maybeApplyForTablet(prop) {
+      const _stackColumnsAt = this.stackColumnsAt || "tablet";
+
+      return _stackColumnsAt === "tablet" ? prop : "inherit";
+    },
+  },
+};
+</script>
+<style scoped>
+.div-4wbls88y960 {
+  display: flex;
+  align-items: stretch;
+  line-height: normal;
+}
+@media (max-width: 999px) {
+  .div-4wbls88y960 {
+    flex-direction: var(--flex-dir-tablet);
+  }
+}
+@media (max-width: 639px) {
+  .div-4wbls88y960 {
+    flex-direction: var(--flex-dir);
+  }
+}
+.div-4wbls88y960-2 {
+  flex-grow: 1;
+}
+@media (max-width: 999px) {
+  .div-4wbls88y960-2 {
+    width: var(--column-width-tablet) !important;
+    margin-left: var(--column-margin-left-tablet) !important;
+  }
+}
+@media (max-width: 639px) {
+  .div-4wbls88y960-2 {
+    width: var(--column-width) !important;
+    margin-left: var(--column-margin-left) !important;
+  }
+}
+</style>

package/nuxt2/src/blocks/columns/component-info.js

@@ -0,0 +1,224 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+__export(exports, {
+  componentInfo: () => componentInfo
+});
+const componentInfo = {
+  name: "Columns",
+  builtIn: true,
+  inputs: [
+    {
+      name: "columns",
+      type: "array",
+      broadcast: true,
+      subFields: [
+        {
+          name: "blocks",
+          type: "array",
+          hideFromUI: true,
+          defaultValue: [
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto",
+                  minHeight: "20px",
+                  minWidth: "20px",
+                  overflow: "hidden"
+                }
+              },
+              component: {
+                name: "Image",
+                options: {
+                  image: "https://builder.io/api/v1/image/assets%2Fpwgjf0RoYWbdnJSbpBAjXNRMe9F2%2Ffb27a7c790324294af8be1c35fe30f4d",
+                  backgroundPosition: "center",
+                  backgroundSize: "cover",
+                  aspectRatio: 0.7004048582995948
+                }
+              }
+            },
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto"
+                }
+              },
+              component: {
+                name: "Text",
+                options: {
+                  text: "<p>Enter some text...</p>"
+                }
+              }
+            }
+          ]
+        },
+        {
+          name: "width",
+          type: "number",
+          hideFromUI: true,
+          helperText: "Width %, e.g. set to 50 to fill half of the space"
+        },
+        {
+          name: "link",
+          type: "url",
+          helperText: "Optionally set a url that clicking this column will link to"
+        }
+      ],
+      defaultValue: [
+        {
+          blocks: [
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto",
+                  minHeight: "20px",
+                  minWidth: "20px",
+                  overflow: "hidden"
+                }
+              },
+              component: {
+                name: "Image",
+                options: {
+                  image: "https://builder.io/api/v1/image/assets%2Fpwgjf0RoYWbdnJSbpBAjXNRMe9F2%2Ffb27a7c790324294af8be1c35fe30f4d",
+                  backgroundPosition: "center",
+                  backgroundSize: "cover",
+                  aspectRatio: 0.7004048582995948
+                }
+              }
+            },
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto"
+                }
+              },
+              component: {
+                name: "Text",
+                options: {
+                  text: "<p>Enter some text...</p>"
+                }
+              }
+            }
+          ]
+        },
+        {
+          blocks: [
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto",
+                  minHeight: "20px",
+                  minWidth: "20px",
+                  overflow: "hidden"
+                }
+              },
+              component: {
+                name: "Image",
+                options: {
+                  image: "https://builder.io/api/v1/image/assets%2Fpwgjf0RoYWbdnJSbpBAjXNRMe9F2%2Ffb27a7c790324294af8be1c35fe30f4d",
+                  backgroundPosition: "center",
+                  backgroundSize: "cover",
+                  aspectRatio: 0.7004048582995948
+                }
+              }
+            },
+            {
+              "@type": "@builder.io/sdk:Element",
+              responsiveStyles: {
+                large: {
+                  display: "flex",
+                  flexDirection: "column",
+                  alignItems: "stretch",
+                  flexShrink: "0",
+                  position: "relative",
+                  marginTop: "30px",
+                  textAlign: "center",
+                  lineHeight: "normal",
+                  height: "auto"
+                }
+              },
+              component: {
+                name: "Text",
+                options: {
+                  text: "<p>Enter some text...</p>"
+                }
+              }
+            }
+          ]
+        }
+      ],
+      onChange: "        function clearWidths() {          columns.forEach(col => {            col.delete('width');          });        }        const columns = options.get('columns') as Array<Map<String, any>>;        if (Array.isArray(columns)) {          const containsColumnWithWidth = !!columns.find(col => col.get('width'));          if (containsColumnWithWidth) {            const containsColumnWithoutWidth = !!columns.find(col => !col.get('width'));            if (containsColumnWithoutWidth) {              clearWidths();            } else {              const sumWidths = columns.reduce((memo, col) => {                return memo + col.get('width');              }, 0);              const widthsDontAddUp = sumWidths !== 100;              if (widthsDontAddUp) {                clearWidths();              }            }          }        }      "
+    },
+    {
+      name: "space",
+      type: "number",
+      defaultValue: 20,
+      helperText: "Size of gap between columns",
+      advanced: true
+    },
+    {
+      name: "stackColumnsAt",
+      type: "string",
+      defaultValue: "tablet",
+      helperText: "Convert horizontal columns to vertical at what device size",
+      enum: ["tablet", "mobile", "never"],
+      advanced: true
+    },
+    {
+      name: "reverseColumnsWhenStacked",
+      type: "boolean",
+      defaultValue: false,
+      helperText: "When stacking columns for mobile devices, reverse the ordering",
+      advanced: true
+    }
+  ]
+};

package/nuxt2/src/blocks/custom-code/component-info.js

@@ -0,0 +1,38 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+__export(exports, {
+  componentInfo: () => componentInfo
+});
+const componentInfo = {
+  name: "Custom Code",
+  static: true,
+  builtIn: true,
+  requiredPermissions: ["editCode"],
+  inputs: [
+    {
+      name: "code",
+      type: "html",
+      required: true,
+      defaultValue: "<p>Hello there, I am custom HTML code!</p>",
+      code: true
+    },
+    {
+      name: "replaceNodes",
+      type: "boolean",
+      helperText: "Preserve server rendered dom nodes",
+      advanced: true
+    },
+    {
+      name: "scriptsClientOnly",
+      type: "boolean",
+      defaultValue: false,
+      helperText: "Only print and run scripts on the client. Important when scripts influence DOM that could be replaced when client loads",
+      advanced: true
+    }
+  ]
+};

package/nuxt2/src/blocks/custom-code/custom-code.vue

@@ -0,0 +1,79 @@
+<template>
+  <div
+    ref="elem"
+    :class="
+      _classStringToObject(
+        'builder-custom-code' + (this.replaceNodes ? ' replace-nodes' : '')
+      )
+    "
+    v-html="code"
+  ></div>
+</template>
+<script>
+export default {
+  name: "builder-custom-code",
+
+  props: ["replaceNodes", "code"],
+
+  data: () => ({ scriptsInserted: [], scriptsRun: [] }),
+
+  mounted() {
+    this.findAndRunScripts();
+  },
+
+  methods: {
+    findAndRunScripts() {
+      // TODO: Move this function to standalone one in '@builder.io/utils'
+      if (this.$refs.elem && typeof window !== "undefined") {
+        /** @type {HTMLScriptElement[]} */
+        const scripts = this.$refs.elem.getElementsByTagName("script");
+
+        for (let i = 0; i < scripts.length; i++) {
+          const script = scripts[i];
+
+          if (script.src) {
+            if (this.scriptsInserted.includes(script.src)) {
+              continue;
+            }
+
+            this.scriptsInserted.push(script.src);
+            const newScript = document.createElement("script");
+            newScript.async = true;
+            newScript.src = script.src;
+            document.head.appendChild(newScript);
+          } else if (
+            !script.type ||
+            [
+              "text/javascript",
+              "application/javascript",
+              "application/ecmascript",
+            ].includes(script.type)
+          ) {
+            if (this.scriptsRun.includes(script.innerText)) {
+              continue;
+            }
+
+            try {
+              this.scriptsRun.push(script.innerText);
+              new Function(script.innerText)();
+            } catch (error) {
+              console.warn("`CustomCode`: Error running script:", error);
+            }
+          }
+        }
+      }
+    },
+    _classStringToObject(str) {
+      const obj = {};
+      if (typeof str !== "string") {
+        return obj;
+      }
+      const classNames = str.trim().split(/\s+/);
+      for (const name of classNames) {
+        obj[name] = true;
+      }
+      return obj;
+    },
+  },
+};
+</script>

package/nuxt2/src/blocks/embed/component-info.js

@@ -0,0 +1,31 @@
+var __defProp = Object.defineProperty;
+var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
+var __export = (target, all) => {
+  __markAsModule(target);
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+__export(exports, {
+  componentInfo: () => componentInfo
+});
+const componentInfo = {
+  name: "Embed",
+  static: true,
+  builtIn: true,
+  inputs: [
+    {
+      name: "url",
+      type: "url",
+      required: true,
+      defaultValue: "",
+      helperText: "e.g. enter a youtube url, google map, etc",
+      onChange: "        const url = options.get('url');        if (url) {          options.set('content', 'Loading...');          // TODO: get this out of here!          const apiKey = 'ae0e60e78201a3f2b0de4b';          return fetch(`https://iframe.ly/api/iframely?url=${url}&api_key=${apiKey}`)            .then(res => res.json())            .then(data => {              if (options.get('url') === url) {                if (data.html) {                  options.set('content', data.html);                } else {                  options.set('content', 'Invalid url, please try another');                }              }            })            .catch(err => {              options.set(                'content',                'There was an error embedding this URL, please try again or another URL'              );            });        } else {          options.delete('content');        }      "
+    },
+    {
+      name: "content",
+      type: "html",
+      defaultValue: '<div style="padding: 20px; text-align: center">(Choose an embed URL)<div>',
+      hideFromUI: true
+    }
+  ]
+};