Merge pull request #1 from AlchemyCMS/rename-element_type

Rename element type
AlchemyCMS · Nov 6, 2020 · a4a817b · a4a817b
2 parents 00f5c05 + 7bd4d7c
commit a4a817b
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -23,13 +23,13 @@ export default {
 }
 ```
 
-You now have acces to the `page` prop and its `elements`. Also you have access to the `elementType()` method that you can use to dynamically render element components.
+You now have acces to the `page` prop and its `elements`. Also you have access to the `componentName()` method that you can use to dynamically render element components.
 
 ```html
 <template>
   <div :class="page.page_layout">
     <component
-      :is="elementType(element)"
+      :is="componentName(element)"
       v-for="element in page.elements"
       :key="element.id"
       :element="element"

diff --git a/src/components/FallbackElement.vue b/src/components/FallbackElement.vue
@@ -1,6 +1,6 @@
 <template>
   <div class="alchemy-fallback-element">
-    <h2>I am a dummy {{ element.element_type }} Alchemy element component</h2>
+    <h2>I am a dummy {{ element.name }} Alchemy element component</h2>
     <p>
       To replace me put a Vue component into
       <kbd>~/components/Alchemy/Elements/</kbd>

diff --git a/src/components/__tests__/fallback-element.spec.js b/src/components/__tests__/fallback-element.spec.js
@@ -5,15 +5,15 @@ function getComponent() {
   return shallowMount(FallbackElement, {
     propsData: {
       element: {
-        element_type: "main_header",
+        name: "main_header",
         essences: [
           {
             role: "headline",
           },
         ],
         nested_elements: [
           {
-            element_type: "header",
+            name: "header",
           },
         ],
       },

diff --git a/src/mixins/__tests__/element.spec.js b/src/mixins/__tests__/element.spec.js
@@ -9,7 +9,7 @@ const AlchemyElementComponent = {
 describe("Alchemy element mixin", () => {
   it("has access to the element", () => {
     const element = {
-      element_type: "content_page",
+      name: "content_page",
       essences: [],
     }
     const comp = shallowMount(AlchemyElementComponent, {
@@ -26,7 +26,7 @@ describe("Alchemy element mixin", () => {
         const comp = shallowMount(AlchemyElementComponent, {
           propsData: {
             element: {
-              element_type: "content_page",
+              name: "content_page",
               essences: [],
             },
           },
@@ -41,7 +41,7 @@ describe("Alchemy element mixin", () => {
         const comp = shallowMount(AlchemyElementComponent, {
           propsData: {
             element: {
-              element_type: "content_page",
+              name: "content_page",
               essences: [headline],
             },
           },
@@ -57,7 +57,7 @@ describe("Alchemy element mixin", () => {
         const comp = shallowMount(AlchemyElementComponent, {
           propsData: {
             element: {
-              element_type: "content_page",
+              name: "content_page",
               essences: [],
             },
           },
@@ -72,7 +72,7 @@ describe("Alchemy element mixin", () => {
         const comp = shallowMount(AlchemyElementComponent, {
           propsData: {
             element: {
-              element_type: "content_page",
+              name: "content_page",
               essences: [headline],
             },
           },

diff --git a/src/mixins/__tests__/page.spec.js b/src/mixins/__tests__/page.spec.js
@@ -11,7 +11,7 @@ const AlchemyPageComponent = {
   template: `
     <div class="alchemy-page">
       <component
-        :is="elementType(element)"
+        :is="componentName(element)"
         v-for="element in page.elements"
         :key="element.id"
         :element="element"
@@ -40,7 +40,7 @@ describe("Alchemy page mixin", () => {
   describe("elementByName", () => {
     describe("if element exists", () =>{
       it("returns element", () => {
-        const element = { element_type: "header" }
+        const element = { name: "header" }
         const component = shallowMount(AlchemyPageComponent, {
           propsData: {
             page: {
@@ -70,7 +70,7 @@ describe("Alchemy page mixin", () => {
   describe("elementsByName", () => {
     describe("if element exists", () =>{
       it("returns element", () => {
-        const elements = [{ element_type: "header" }]
+        const elements = [{ name: "header" }]
         const component = shallowMount(AlchemyPageComponent, {
           propsData: {
             page: {
@@ -97,13 +97,13 @@ describe("Alchemy page mixin", () => {
     })
   })
 
-  describe("elementType", () => {
+  describe("componentName", () => {
     describe("if element component has been registered", () => {
       it("returns the component name", () => {
         const component = shallowMount(AlchemyPageComponent, {
           propsData: {
             page: {
-              elements: [{ element_type: "element_component" }],
+              elements: [{ name: "element_component" }],
             },
           },
         })
@@ -118,7 +118,7 @@ describe("Alchemy page mixin", () => {
         const component = shallowMount(AlchemyPageComponent, {
           propsData: {
             page: {
-              elements: [{ element_type: "something" }],
+              elements: [{ name: "something" }],
             },
           },
         })

diff --git a/src/mixins/page.js b/src/mixins/page.js
@@ -9,8 +9,8 @@ export default {
     },
   },
   methods: {
-    elementType(element) {
-      const name = element.element_type
+    componentName(element) {
+      const name = element.name
       if (this.$options.components[name]) {
         return name
       }
@@ -20,7 +20,7 @@ export default {
       return this.elementsByName(name)[0]
     },
     elementsByName(name) {
-      return this.page.elements.filter((e) => e.element_type === name)
+      return this.page.elements.filter((e) => e.name === name)
     },
   },
 }