Skip to content

Implement optional object props generation #54726

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

Open
lenaic wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Implement optional object props generation #54726

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
5065258
Add optional props generation support (#54724)
Nov 28, 2025
ea6078f
Add fixtures for optional props generation (#54725)
Nov 28, 2025
c63ea5c
Implement optional object props generation
Nov 28, 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
4 changes: 4 additions & 0 deletions packages/react-native-codegen/src/CodegenSchema.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@ export type OptionsShape = $ReadOnly<{
// Use for components currently being renamed in paper
// Will use new name if it is available and fallback to this name
paperComponentNameDeprecated?: string,
// Use to generate C++ Props with optional types for properties defined as optional
generateOptionalProperties?: boolean,
// Use to generate C++ Props with optional types for object properties defined as optional
generateOptionalObjectProperties?: boolean,
}>;

export type ExtendsPropsShape = $ReadOnly<{
Expand Down
89 changes: 84 additions & 5 deletions packages/react-native-codegen/src/generators/components/GeneratePropsCpp.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ function generatePropsDiffString(
component: ComponentShape,
debugProps: string = '',
includeGetDebugPropsImplementation?: boolean = false,
generateOptionalProperties?: boolean = false,
) {
const diffProps = component.props
.map(prop => {
Expand All @@ -88,39 +89,116 @@ function generatePropsDiffString(
case 'Int32TypeAnnotation':
case 'BooleanTypeAnnotation':
case 'MixedTypeAnnotation':
return `
if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `
if (${prop.name} != oldProps->${prop.name}) {
if (${prop.name}.has_value()) {
result["${prop.name}"] = ${prop.name}.value();
} else {
result["${prop.name}"] = folly::dynamic(nullptr);
}
}`;
} else {
return `
if (${prop.name} != oldProps->${prop.name}) {
result["${prop.name}"] = ${prop.name};
}`;
}
case 'DoubleTypeAnnotation':
case 'FloatTypeAnnotation':
return `
if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `
if ((${prop.name} != oldProps->${prop.name})) {
if (${prop.name}.has_value()) {
if (!oldProps->${prop.name}.has_value() || !(std::isnan(${prop.name}.value()) && std::isnan(oldProps->${prop.name}.value()))) {
result["${prop.name}"] = ${prop.name}.value();
}
} else {
result["${prop.name}"] = folly::dynamic(nullptr);
}
}`;
} else {
return `
if ((${prop.name} != oldProps->${prop.name}) && !(std::isnan(${prop.name}) && std::isnan(oldProps->${prop.name}))) {
result["${prop.name}"] = ${prop.name};
}`;
}
case 'ArrayTypeAnnotation':
case 'ObjectTypeAnnotation':
case 'StringEnumTypeAnnotation':
case 'Int32EnumTypeAnnotation':
return `
if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `
if (${prop.name} != oldProps->${prop.name}) {
if (${prop.name}.has_value()) {
result["${prop.name}"] = toDynamic(${prop.name}.value());
} else {
result["${prop.name}"] = folly::dynamic(nullptr);
}
}`;
} else {
return `
if (${prop.name} != oldProps->${prop.name}) {
result["${prop.name}"] = toDynamic(${prop.name});
}`;
}
case 'ReservedPropTypeAnnotation':
switch (typeAnnotation.name) {
case 'ColorPrimitive':
return `
if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `
if (${prop.name} != oldProps->${prop.name}) {
if (${prop.name}.has_value()) {
result["${prop.name}"] = *${prop.name}.value();
} else {
result["${prop.name}"] = folly::dynamic(nullptr);
}
}`;
} else {
return `
if (${prop.name} != oldProps->${prop.name}) {
result["${prop.name}"] = *${prop.name};
}`;
}
case 'ImageSourcePrimitive':
case 'PointPrimitive':
case 'EdgeInsetsPrimitive':
case 'DimensionPrimitive':
return `
if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `
if (${prop.name} != oldProps->${prop.name}) {
if (${prop.name}.has_value()) {
result["${prop.name}"] = toDynamic(${prop.name}.value());
} else {
result["${prop.name}"] = folly::dynamic(nullptr);
}
}`;
} else {
return `
if (${prop.name} != oldProps->${prop.name}) {
result["${prop.name}"] = toDynamic(${prop.name});
}`;
}
case 'ImageRequestPrimitive':
// Shouldn't be used in props
throw new Error(
Expand Down Expand Up @@ -275,6 +353,7 @@ module.exports = {
component,
debugProps,
includeGetDebugPropsImplementation,
component.generateOptionalProperties,
);

const imports = getImports(component.props);
Expand Down
57 changes: 53 additions & 4 deletions packages/react-native-codegen/src/generators/components/GeneratePropsH.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,7 @@ function generatePropsString(
componentName: string,
props: $ReadOnlyArray<NamedShape<PropTypeAnnotation>>,
nameParts: $ReadOnlyArray<string>,
generateOptionalProperties?: boolean = false,
) {
return props
.map(prop => {
Expand All @@ -542,6 +543,14 @@ function generatePropsString(
prop,
);

if (
prop.optional &&
prop.typeAnnotation.default == null &&
generateOptionalProperties
) {
return `std::optional<${nativeType}> ${prop.name}${defaultInitializer};`;
}

return `${nativeType} ${prop.name}${defaultInitializer};`;
})
.join('\n' + ' ');
Expand Down Expand Up @@ -581,7 +590,12 @@ function generateStructsForComponent(
componentName: string,
component: ComponentShape,
): string {
const structs = generateStructs(componentName, component.props, []);
const structs = generateStructs(
componentName,
component.props,
[],
component.generateOptionalObjectProperties,
);
const structArray = Array.from(structs.values());
if (structArray.length < 1) {
return '';
Expand All @@ -593,6 +607,7 @@ function generateStructs(
componentName: string,
properties: $ReadOnlyArray<NamedShape<PropTypeAnnotation>>,
nameParts: Array<string>,
generateOptionalObjectProperties?: boolean = false,
): StructsMap {
const structs: StructsMap = new Map();
properties.forEach(prop => {
Expand All @@ -605,6 +620,7 @@ function generateStructs(
componentName,
elementProperties,
nameParts.concat([prop.name]),
generateOptionalObjectProperties,
);
nestedStructs.forEach(function (value, key) {
structs.set(key, value);
Expand All @@ -615,6 +631,7 @@ function generateStructs(
componentName,
nameParts.concat([prop.name]),
typeAnnotation.properties,
generateOptionalObjectProperties,
);
}

Expand All @@ -629,6 +646,7 @@ function generateStructs(
componentName,
elementProperties,
nameParts.concat([prop.name]),
generateOptionalObjectProperties,
);
nestedStructs.forEach(function (value, key) {
structs.set(key, value);
Expand All @@ -640,6 +658,7 @@ function generateStructs(
componentName,
nameParts.concat([prop.name]),
elementProperties,
generateOptionalObjectProperties,
);

// Generate the conversion function for std:vector<Object>.
Expand Down Expand Up @@ -681,6 +700,7 @@ function generateStructs(
componentName,
nameParts.concat([prop.name]),
elementProperties,
generateOptionalObjectProperties,
);

// Generate the conversion function for std:vector<Object>.
Expand All @@ -707,13 +727,15 @@ function generateStruct(
componentName: string,
nameParts: $ReadOnlyArray<string>,
properties: $ReadOnlyArray<NamedShape<PropTypeAnnotation>>,
generateOptionalObjectProperties?: boolean = false,
): void {
const structNameParts = nameParts;
const structName = generateStructName(componentName, structNameParts);
const fields = generatePropsString(
componentName,
properties,
structNameParts,
generateOptionalObjectProperties,
);

properties.forEach((property: NamedShape<PropTypeAnnotation>) => {
Expand Down Expand Up @@ -744,7 +766,13 @@ function generateStruct(
`Properties are expected for ObjectTypeAnnotation (see ${name} in ${componentName})`,
);
}
generateStruct(structs, componentName, nameParts.concat([name]), props);
generateStruct(
structs,
componentName,
nameParts.concat([name]),
props,
generateOptionalObjectProperties,
);
return;
case 'MixedTypeAnnotation':
return;
Expand Down Expand Up @@ -776,9 +804,29 @@ function generateStruct(
case 'DoubleTypeAnnotation':
case 'FloatTypeAnnotation':
case 'MixedTypeAnnotation':
return `result["${name}"] = ${name};`;
if (
property.optional &&
property.typeAnnotation.default == null &&
generateOptionalObjectProperties
) {
return `if (${name}.has_value()) {
result["${name}"] = ${name}.value();
}`;
} else {
return `result["${name}"] = ${name};`;
}
default:
return `result["${name}"] = ::facebook::react::toDynamic(${name});`;
if (
property.optional &&
property.typeAnnotation.default == null &&
generateOptionalObjectProperties
) {
return `if (${name}.has_value()) {
result["${name}"] = ::facebook::react::toDynamic(${name}.value());
}`;
} else {
return `result["${name}"] = ::facebook::react::toDynamic(${name});`;
}
}
})
.join('\n ');
Expand Down Expand Up @@ -834,6 +882,7 @@ module.exports = {
componentName,
component.props,
[],
component.generateOptionalProperties,
);
const extendString = getClassExtendString(component);
const extendsImports = getExtendsImports(component.extendsProps);
Expand Down
Loading