60503bb9a6
* Add platform feature which adds dynamic height property controls and default properties based on widget config * Move features to the top, so that defaults can override them if necessary * - Add unit tests to verify that the property controls show up for dynamic height - Add unit test to verify that the hidden hook in the dynamic height controls work - Fix console warning for react key unavailable in Generator.tsx - Move constants and types to their respective files * Remove dynamic height config from Container Widget * Add comments in hard to understand areas * Add function which converts fn validation params to fnString
103 lines
3.3 KiB
TypeScript
103 lines
3.3 KiB
TypeScript
import {
|
|
PropertyPaneConfig,
|
|
PropertyPaneControlConfig,
|
|
} from "constants/PropertyControlConstants";
|
|
import { ValidationTypes } from "constants/WidgetValidation";
|
|
import { generateReactKey } from "./generators";
|
|
import { PropertyPaneConfigTemplates, WidgetFeatures } from "./WidgetFeatures";
|
|
|
|
/* This function recursively parses the property pane configuration and
|
|
adds random hash values as `id`.
|
|
|
|
These are generated once when the Appsmith editor is loaded,
|
|
the resulting config is frozen and re-used during the lifecycle
|
|
of the current browser session. See WidgetFactory
|
|
*/
|
|
export const addPropertyConfigIds = (config: PropertyPaneConfig[]) => {
|
|
return config.map((sectionOrControlConfig: PropertyPaneConfig) => {
|
|
sectionOrControlConfig.id = generateReactKey();
|
|
if (sectionOrControlConfig.children) {
|
|
sectionOrControlConfig.children = addPropertyConfigIds(
|
|
sectionOrControlConfig.children,
|
|
);
|
|
}
|
|
const config = sectionOrControlConfig as PropertyPaneControlConfig;
|
|
if (
|
|
config.panelConfig &&
|
|
config.panelConfig.children &&
|
|
Array.isArray(config.panelConfig.children)
|
|
) {
|
|
config.panelConfig.children = addPropertyConfigIds(
|
|
config.panelConfig.children,
|
|
);
|
|
|
|
(sectionOrControlConfig as PropertyPaneControlConfig) = config;
|
|
}
|
|
return sectionOrControlConfig;
|
|
});
|
|
};
|
|
|
|
/* General function which enhances the property pane configuration
|
|
|
|
We can use this to insert or add property configs based on widget
|
|
features passed as the second argument.
|
|
*/
|
|
export function enhancePropertyPaneConfig(
|
|
config: PropertyPaneConfig[],
|
|
features?: WidgetFeatures,
|
|
) {
|
|
// Enhance property pane for dynamic height feature
|
|
if (features && features.dynamicHeight) {
|
|
config.splice(1, 0, PropertyPaneConfigTemplates.DYNAMIC_HEIGHT);
|
|
}
|
|
return config;
|
|
}
|
|
|
|
/*
|
|
ValidationTypes.FUNCTION, allow us to configure functions within them,
|
|
However, these are not serializable, which results in them not being able to
|
|
be sent to the workers.
|
|
We convert these functions to strings and delete the original function properties
|
|
in this function
|
|
|
|
property added `fnString`
|
|
property deleted `fn`
|
|
*/
|
|
|
|
export function convertFunctionsToString(config: PropertyPaneConfig[]) {
|
|
return config.map((sectionOrControlConfig: PropertyPaneConfig) => {
|
|
const controlConfig = sectionOrControlConfig as PropertyPaneControlConfig;
|
|
if (
|
|
controlConfig.validation &&
|
|
controlConfig.validation?.type === ValidationTypes.FUNCTION &&
|
|
controlConfig.validation?.params &&
|
|
controlConfig.validation?.params.fn
|
|
) {
|
|
controlConfig.validation.params.fnString = controlConfig.validation.params.fn.toString();
|
|
delete controlConfig.validation.params.fn;
|
|
return sectionOrControlConfig;
|
|
}
|
|
|
|
if (sectionOrControlConfig.children) {
|
|
sectionOrControlConfig.children = convertFunctionsToString(
|
|
sectionOrControlConfig.children,
|
|
);
|
|
}
|
|
|
|
const config = sectionOrControlConfig as PropertyPaneControlConfig;
|
|
|
|
if (
|
|
config.panelConfig &&
|
|
config.panelConfig.children &&
|
|
Array.isArray(config.panelConfig.children)
|
|
) {
|
|
config.panelConfig.children = convertFunctionsToString(
|
|
config.panelConfig.children,
|
|
);
|
|
|
|
(sectionOrControlConfig as PropertyPaneControlConfig) = config;
|
|
}
|
|
return sectionOrControlConfig;
|
|
});
|
|
}
|