-
Notifications
You must be signed in to change notification settings - Fork 911
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(react-gen1): support block level personalization and scheduling (#…
- Loading branch information
Showing
13 changed files
with
1,281 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| "@builder.io/react": patch | ||
| "@builder.io/sdk": patch | ||
| --- | ||
|
|
||
| Add built-in personalization container to suppoert block level personalization |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,257 @@ | ||
| import React from 'react'; | ||
| import { Builder, builder, BuilderElement } from '@builder.io/sdk'; | ||
| import { useEffect, useState } from 'react'; | ||
| import { BuilderBlocks } from '../components/builder-blocks.component'; | ||
| import { | ||
| filterWithCustomTargeting, | ||
| filterWithCustomTargetingScript, | ||
| Query, | ||
| } from '../functions/filter-with-custom-targeting'; | ||
|
|
||
| export type PersonalizationContainerProps = { | ||
| children: React.ReactNode; | ||
| previewingIndex: number | null; | ||
| builderBlock?: BuilderElement; | ||
| variants?: [ | ||
| { | ||
| query: Query[]; | ||
| startDate?: string; | ||
| endDate?: string; | ||
| blocks: BuilderElement[]; | ||
| }, | ||
| ]; | ||
| attributes: any; | ||
| }; | ||
|
|
||
| export function PersonalizationContainer(props: PersonalizationContainerProps) { | ||
| const isBeingHydrated = Boolean( | ||
| Builder.isBrowser && (window as any).__hydrated?.[props.builderBlock?.id!] | ||
| ); | ||
| const [isClient, setIsClient] = useState(isBeingHydrated); | ||
| const [update, setUpdate] = useState(0); | ||
|
|
||
| useEffect(() => { | ||
| setIsClient(true); | ||
| const subscriber = builder.userAttributesChanged.subscribe(() => { | ||
| setUpdate(update + 1); | ||
| }); | ||
| return () => { | ||
| subscriber.unsubscribe(); | ||
| }; | ||
| }, []); | ||
|
|
||
| if (Builder.isServer) { | ||
| return ( | ||
| <React.Fragment> | ||
| <div | ||
| {...props.attributes} | ||
| // same as the client side styles for hydration matching | ||
| style={{ | ||
| opacity: 1, | ||
| transition: 'opacity 0.2s ease-in-out', | ||
| ...props.attributes?.style, | ||
| }} | ||
| className={`builder-personalization-container ${props.attributes.className}`} | ||
| > | ||
| {props.variants?.map((variant, index) => ( | ||
| <template key={index} data-variant-id={props.builderBlock?.id! + index}> | ||
| <BuilderBlocks | ||
| blocks={variant.blocks} | ||
| parentElementId={props.builderBlock?.id} | ||
| dataPath={`component.options.variants.${index}.blocks`} | ||
| child | ||
| /> | ||
| </template> | ||
| ))} | ||
| <script | ||
| id={`variants-script-${props.builderBlock?.id}`} | ||
| dangerouslySetInnerHTML={{ | ||
| __html: getPersonalizationScript(props.variants, props.builderBlock?.id), | ||
| }} | ||
| /> | ||
| <BuilderBlocks | ||
| blocks={props.builderBlock?.children} | ||
| parentElementId={props.builderBlock?.id} | ||
| dataPath="this.children" | ||
| child | ||
| /> | ||
| </div> | ||
| <script | ||
| dangerouslySetInnerHTML={{ | ||
| __html: ` | ||
| window.__hydrated = window.__hydrated || {}; | ||
| window.__hydrated['${props.builderBlock?.id}'] = true; | ||
| `.replace(/\s+/g, ' '), | ||
| }} | ||
| /> | ||
| </React.Fragment> | ||
| ); | ||
| } | ||
|
|
||
| const filteredVariants = (props.variants || []).filter(variant => { | ||
| return filterWithCustomTargeting( | ||
| builder.getUserAttributes(), | ||
| variant.query, | ||
| variant.startDate, | ||
| variant.endDate | ||
| ); | ||
| }); | ||
|
|
||
| return ( | ||
| <React.Fragment> | ||
| <div | ||
| {...props.attributes} | ||
| style={{ | ||
| opacity: isClient ? 1 : 0, | ||
| transition: 'opacity 0.2s ease-in-out', | ||
| ...props.attributes?.style, | ||
| }} | ||
| className={`builder-personalization-container ${ | ||
| props.attributes.className | ||
| } ${isClient ? '' : 'builder-personalization-container-loading'}`} | ||
| > | ||
| {/* If editing a specific varient */} | ||
| {Builder.isEditing && | ||
| typeof props.previewingIndex === 'number' && | ||
| props.previewingIndex < (props.variants?.length || 0) ? ( | ||
| <BuilderBlocks | ||
| blocks={props.variants?.[props.previewingIndex]?.blocks} | ||
| parentElementId={props.builderBlock?.id} | ||
| dataPath={`component.options.variants.${props.previewingIndex}.blocks`} | ||
| child | ||
| /> | ||
| ) : // If editing the default or we're on the server and there are no matching variants show the default | ||
| (Builder.isEditing && typeof props.previewingIndex !== 'number') || | ||
| !isClient || | ||
| !filteredVariants.length ? ( | ||
| <BuilderBlocks | ||
| blocks={props.builderBlock?.children} | ||
| parentElementId={props.builderBlock?.id} | ||
| dataPath="this.children" | ||
| child | ||
| /> | ||
| ) : ( | ||
| // Show the variant matching the current user attributes | ||
| <BuilderBlocks | ||
| blocks={filteredVariants[0]?.blocks} | ||
| parentElementId={props.builderBlock?.id} | ||
| dataPath={`component.options.variants.${props.variants?.indexOf( | ||
| filteredVariants[0] | ||
| )}.blocks`} | ||
| child | ||
| /> | ||
| )} | ||
| </div> | ||
| <script | ||
| dangerouslySetInnerHTML={{ | ||
| __html: ` | ||
| window.__hydrated = window.__hydrated || {}; | ||
| window.__hydrated['${props.builderBlock?.id}'] = true; | ||
| `.replace(/\s+/g, ' '), | ||
| }} | ||
| /> | ||
| </React.Fragment> | ||
| ); | ||
| } | ||
|
|
||
| Builder.registerComponent(PersonalizationContainer, { | ||
| name: 'PersonalizationContainer', | ||
| noWrap: true, | ||
| image: | ||
| 'https://cdn.builder.io/api/v1/image/assets%2FYJIGb4i01jvw0SRdL5Bt%2F37229ed30d8c41dfb10b8cca1992053a', | ||
| canHaveChildren: true, | ||
| inputs: [ | ||
| { | ||
| name: 'variants', | ||
| defaultValue: [], | ||
| behavior: 'personalizationVariantList', | ||
| type: 'list', | ||
| subFields: [ | ||
| { | ||
| name: 'name', | ||
| type: 'text', | ||
| }, | ||
| { | ||
| name: 'query', | ||
| friendlyName: 'Targeting rules', | ||
| type: 'BuilderQuery', | ||
| defaultValue: [], | ||
| }, | ||
| { | ||
| name: 'startDate', | ||
| type: 'date', | ||
| }, | ||
| { | ||
| name: 'endDate', | ||
| type: 'date', | ||
| }, | ||
| { | ||
| name: 'blocks', | ||
| type: 'UiBlocks', | ||
| hideFromUI: true, | ||
| defaultValue: [], | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }); | ||
|
|
||
| function getPersonalizationScript( | ||
| variants: PersonalizationContainerProps['variants'], | ||
| blockId?: string | ||
| ) { | ||
| return ` | ||
| (function() { | ||
| function getCookie(name) { | ||
| var nameEQ = name + "="; | ||
| var ca = document.cookie.split(';'); | ||
| for(var i=0;i < ca.length;i++) { | ||
| var c = ca[i]; | ||
| while (c.charAt(0)==' ') c = c.substring(1,c.length); | ||
| if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length,c.length); | ||
| } | ||
| return null; | ||
| } | ||
| function removeVariants() { | ||
| variants.forEach(function (template, index) { | ||
| document.querySelector('template[data-variant-id="' + "${blockId}" + index + '"]').remove(); | ||
| }); | ||
| document.getElementById('variants-script-${blockId}').remove(); | ||
| } | ||
| var attributes = JSON.parse(getCookie("${Builder.attributesCookieName}") || "{}"); | ||
| var variants = ${JSON.stringify(variants?.map(v => ({ query: v.query, startDate: v.startDate, endDate: v.endDate })))}; | ||
| var winningVariantIndex = variants.findIndex(function(variant) { | ||
| return filterWithCustomTargeting( | ||
| attributes, | ||
| variant.query, | ||
| variant.startDate, | ||
| variant.endDate | ||
| ); | ||
| }); | ||
| var isDebug = location.href.includes('builder.debug=true'); | ||
| if (isDebug) { | ||
| console.debug('PersonalizationContainer', { | ||
| attributes: attributes, | ||
| variants: variants, | ||
| winningVariantIndex: winningVariantIndex, | ||
| }); | ||
| } | ||
| if (winningVariantIndex !== -1) { | ||
| var winningVariant = document.querySelector('template[data-variant-id="' + "${blockId}" + winningVariantIndex + '"]'); | ||
| if (winningVariant) { | ||
| var parentNode = winningVariant.parentNode; | ||
| var newParent = parentNode.cloneNode(false); | ||
| newParent.appendChild(winningVariant.content.firstChild); | ||
| parentNode.parentNode.replaceChild(newParent, parentNode); | ||
| if (isDebug) { | ||
| console.debug('PersonalizationContainer', 'Winning variant Replaced:', winningVariant); | ||
| } | ||
| } | ||
| } else if (variants.length > 0) { | ||
| removeVariants(); | ||
| } | ||
| ${filterWithCustomTargetingScript} | ||
| })(); | ||
| `.replace(/\s+/g, ' '); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.