Skip to content

Pass down composition to components #174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 19, 2025
Merged

Pass down composition to components #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ebb3723
Pass down composition to components
exacs Nov 17, 2025
1d4ca93
Rename "compositon" > "__composition"
exacs Nov 18, 2025
86973d0
Add comment
exacs Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/optimizely-cms-sdk/src/infer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,11 @@ export type InferFromProperty<T extends AnyProperty> =
export type InferredBase = {
_id: string;
_metadata: InferredContentMetadata;

// Properties that don't come from Graph are prefixed with double-underscores
__typename: string;
__context?: { edit: boolean; preview_token: string };
__composition?: ExperienceComponentNode;
};

/** Only include keys where indexingType is not 'disabled' */
Expand Down
13 changes: 9 additions & 4 deletions packages/optimizely-cms-sdk/src/react/server.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ type OptimizelyComponentProps = {
/** Preview context */
__context?: { edit: boolean; preview_token: string };

composition?: ExperienceCompositionNode;
__composition?: ExperienceCompositionNode;
};

displaySettings?: Record<string, string>;
Expand All @@ -98,7 +98,8 @@ export async function OptimizelyComponent({
if (!componentRegistry) {
throw new Error('You should call `initReactComponentRegistry` first');
}
const dtKey = opti.composition?.displayTemplateKey ?? opti.displayTemplateKey;
const dtKey =
opti.__composition?.displayTemplateKey ?? opti.displayTemplateKey;
const Component = await componentRegistry.getComponent(opti.__typename, {
tag: opti.__tag ?? getDisplayTemplateTag(dtKey),
});
Expand Down Expand Up @@ -260,7 +261,9 @@ export function OptimizelyGridSection({
return (
<OptimizelyComponent
opti={{
// `node.component` contains user-defined properties
...node.component,
__composition: node,
__tag: tag,
}}
key={node.key}
Expand Down Expand Up @@ -307,17 +310,19 @@ export function OptimizelyGridSection({
export function getPreviewUtils(opti: OptimizelyComponentProps['opti']) {
return {
/** Get the HTML data attributes required for a property */
pa(property: string | { key: string }) {
pa(property?: string | { key: string }) {
if (opti.__context?.edit) {
if (typeof property === 'string') {
return {
'data-epi-property-name': property,
};
} else {
} else if (property) {
return {
'data-epi-block-id': property.key,
};
}

return {};
} else {
return {};
}
Expand Down