Skip to content

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.

feat: disable props bound to complex expressions (#2667)

Bogdan Chadkin7863527790aa
diff --git a/apps/builder/app/builder/features/settings-panel/code-editor.tsx b/apps/builder/app/builder/features/settings-panel/code-editor.tsx
index df4b840f2e..94798383d8 100644
--- a/apps/builder/app/builder/features/settings-panel/code-editor.tsx
+++ b/apps/builder/app/builder/features/settings-panel/code-editor.tsx
@@ -326,11 +326,13 @@ const paragraphStyle = css({
* Could be used to edit css as well in the future.
*/
export const CodeEditor = ({
+ readOnly = false,
variables,
defaultValue,
onChange,
onBlur,
}: {
+ readOnly?: boolean;
variables: Map<string, string>;
defaultValue: string;
onChange: (newCode: string) => void;
@@ -338,6 +340,7 @@ export const CodeEditor = ({
}) => {
const initialConfig = {
namespace: "CodeEditor",
+ editable: readOnly === false,
nodes: [MentionNode],
theme: {
root: rootStyle.toString(),
diff --git a/apps/builder/app/builder/features/settings-panel/controls/boolean.tsx b/apps/builder/app/builder/features/settings-panel/controls/boolean.tsx
index d935be43a6..46c7c153ac 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/boolean.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/boolean.tsx
@@ -12,6 +12,7 @@ export const BooleanControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"boolean", "boolean">) => {
@@ -30,7 +31,7 @@ export const BooleanControl = ({
gap="2"
>
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label htmlFor={id} description={meta.description} readOnly={readOnly}>
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -41,6 +42,7 @@ export const BooleanControl = ({
</Box>
<Switch
id={id}
+ disabled={readOnly}
checked={prop?.value ?? false}
onCheckedChange={(value) => onChange({ type: "boolean", value })}
/>
diff --git a/apps/builder/app/builder/features/settings-panel/controls/check.tsx b/apps/builder/app/builder/features/settings-panel/controls/check.tsx
index 138940d6c1..c329352c2c 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/check.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/check.tsx
@@ -28,6 +28,7 @@ export const CheckControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"check" | "inline-check" | "multi-select", "string[]">) => {
@@ -45,7 +46,11 @@ export const CheckControl = ({
<VerticalLayout
label={
<Box css={{ position: "relative" }}>
- <Label htmlFor={`${id}:${options[0]}`} description={meta.description}>
+ <Label
+ htmlFor={`${id}:${options[0]}`}
+ description={meta.description}
+ readOnly={readOnly}
+ >
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -62,6 +67,7 @@ export const CheckControl = ({
{options.map((option) => (
<CheckboxAndLabel key={option}>
<Checkbox
+ disabled={readOnly}
checked={value.includes(option)}
onCheckedChange={(checked) => {
onChange({
diff --git a/apps/builder/app/builder/features/settings-panel/controls/code.tsx b/apps/builder/app/builder/features/settings-panel/controls/code.tsx
index 9885dc1454..c25023e4c8 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/code.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/code.tsx
@@ -7,6 +7,7 @@ export const CodeControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"code", "string">) => {
@@ -19,6 +20,7 @@ export const CodeControl = ({
}}
prop={prop}
propName={propName}
+ readOnly={readOnly}
deletable={deletable}
onChange={(value) => {
if (value.type === "string") {
diff --git a/apps/builder/app/builder/features/settings-panel/controls/color.tsx b/apps/builder/app/builder/features/settings-panel/controls/color.tsx
index 0dd0518888..eda703ff4a 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/color.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/color.tsx
@@ -17,6 +17,7 @@ export const ColorControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"color", "string">) => {
@@ -30,7 +31,11 @@ export const ColorControl = ({
<ResponsiveLayout
label={
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label
+ htmlFor={id}
+ description={meta.description}
+ readOnly={readOnly}
+ >
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -45,6 +50,7 @@ export const ColorControl = ({
>
<InputField
id={id}
+ disabled={readOnly}
value={localValue.value}
onChange={(event) => localValue.set(event.target.value)}
onBlur={localValue.save}
diff --git a/apps/builder/app/builder/features/settings-panel/controls/json.tsx b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
index c50e368638..31fffac191 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/json.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/json.tsx
@@ -16,6 +16,7 @@ export const JsonControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"json", "json">) => {
@@ -35,7 +36,9 @@ export const JsonControl = ({
<VerticalLayout
label={
<Box css={{ position: "relative" }}>
- <Label description={meta.description}>{label}</Label>
+ <Label description={meta.description} readOnly={readOnly}>
+ {label}
+ </Label>
<VariablesButton
propId={prop?.id}
propName={propName}
@@ -50,6 +53,7 @@ export const JsonControl = ({
<CodeEditor
// reset editor every time value is changed
key={valueString}
+ readOnly={readOnly}
variables={emptyVariables}
defaultValue={localValue.value}
onChange={localValue.set}
diff --git a/apps/builder/app/builder/features/settings-panel/controls/number.tsx b/apps/builder/app/builder/features/settings-panel/controls/number.tsx
index 89f4ef6d8d..24c9337870 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/number.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/number.tsx
@@ -15,6 +15,7 @@ export const NumberControl = ({
propName,
onChange,
deletable,
+ readOnly,
onDelete,
}: ControlProps<"number", "number">) => {
const id = useId();
@@ -33,7 +34,11 @@ export const NumberControl = ({
<ResponsiveLayout
label={
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label
+ htmlFor={id}
+ description={meta.description}
+ readOnly={readOnly}
+ >
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -48,6 +53,7 @@ export const NumberControl = ({
>
<InputField
id={id}
+ disabled={readOnly}
type="number"
value={localValue.value}
color={isInvalid ? "error" : undefined}
diff --git a/apps/builder/app/builder/features/settings-panel/controls/radio.tsx b/apps/builder/app/builder/features/settings-panel/controls/radio.tsx
index 99d1990f74..097a404d3b 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/radio.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/radio.tsx
@@ -15,6 +15,7 @@ export const RadioControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"radio" | "inline-radio", "string">) => {
@@ -30,7 +31,11 @@ export const RadioControl = ({
<VerticalLayout
label={
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label
+ htmlFor={id}
+ description={meta.description}
+ readOnly={readOnly}
+ >
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -45,6 +50,7 @@ export const RadioControl = ({
>
<Box css={{ paddingTop: theme.spacing[2] }}>
<RadioGroup
+ disabled={readOnly}
name="value"
value={prop?.value}
onValueChange={(value) => onChange({ type: "string", value })}
diff --git a/apps/builder/app/builder/features/settings-panel/controls/select.tsx b/apps/builder/app/builder/features/settings-panel/controls/select.tsx
index da62bf591c..9a11aff889 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/select.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/select.tsx
@@ -8,6 +8,7 @@ export const SelectControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"select", "string">) => {
@@ -23,7 +24,11 @@ export const SelectControl = ({
<VerticalLayout
label={
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label
+ htmlFor={id}
+ description={meta.description}
+ readOnly={readOnly}
+ >
{getLabel(meta, propName)}
</Label>
<VariablesButton
@@ -39,6 +44,7 @@ export const SelectControl = ({
<Flex css={{ py: theme.spacing[2] }}>
<Select
id={id}
+ disabled={readOnly}
value={prop?.value}
options={options}
getLabel={humanizeString}
diff --git a/apps/builder/app/builder/features/settings-panel/controls/text.tsx b/apps/builder/app/builder/features/settings-panel/controls/text.tsx
index 7682af2b74..ceb64f5ea7 100644
--- a/apps/builder/app/builder/features/settings-panel/controls/text.tsx
+++ b/apps/builder/app/builder/features/settings-panel/controls/text.tsx
@@ -14,6 +14,7 @@ export const TextControl = ({
prop,
propName,
deletable,
+ readOnly,
onChange,
onDelete,
}: ControlProps<"text", "string">) => {
@@ -28,6 +29,7 @@ export const TextControl = ({
const input = (
<TextArea
id={id}
+ disabled={readOnly}
autoGrow
value={localValue.value}
rows={meta.rows ?? 1}
@@ -41,7 +43,7 @@ export const TextControl = ({
const labelElement = (
<Box css={{ position: "relative" }}>
- <Label htmlFor={id} description={meta.description}>
+ <Label htmlFor={id} description={meta.description} readOnly={readOnly}>
{label}
</Label>
<VariablesButton propId={prop?.id} propName={propName} propMeta={meta} />
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
index 4c7760dce1..a70632ae05 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
+++ b/apps/builder/app/builder/features/settings-panel/props-section/props-section.tsx
@@ -98,7 +98,7 @@ const renderProperty = (
component,
instanceId,
}: PropsSectionProps,
- { prop, propName, meta }: PropAndMeta,
+ { prop, propName, meta, readOnly }: PropAndMeta,
deletable?: boolean
) => (
// fix the issue with changing type while binding expression
@@ -111,6 +111,7 @@ const renderProperty = (
meta,
prop,
propName,
+ readOnly,
deletable: deletable ?? false,
onDelete: () => {
if (prop) {
@@ -209,20 +210,6 @@ export const PropsSection = (props: PropsSectionProps) => {
);
};
-const getPropTypeAndValue = (value: unknown) => {
- if (typeof value === "boolean") {
- return { type: "boolean", value } as const;
- }
- if (typeof value === "number") {
- return { type: "number", value } as const;
- }
- if (typeof value === "string") {
- return { type: "string", value } as const;
- }
- // fallback to json
- return { type: "json", value } as const;
-};
-
export const PropsSectionContainer = ({
selectedInstance: instance,
}: {
@@ -240,17 +227,8 @@ export const PropsSectionContainer = ({
const logic = usePropsLogic({
instance,
-
- // compute expression prop values before rendering props section
- // to always show already computed values
- props:
- propsByInstanceId.get(instance.id)?.map((prop) => {
- if (prop.type !== "expression") {
- return prop;
- }
- const propValue = propValues?.get(prop.name);
- return { ...prop, ...getPropTypeAndValue(propValue) };
- }) ?? [],
+ props: propsByInstanceId.get(instance.id) ?? [],
+ propValues,
updateProp: (update) => {
const props = propsStore.get();
diff --git a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
index d314d6f9c0..ffd53533d8 100644
--- a/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
+++ b/apps/builder/app/builder/features/settings-panel/props-section/use-props-logic.ts
@@ -1,12 +1,24 @@
import { nanoid } from "nanoid";
import type { Instance, Prop } from "@webstudio-is/sdk";
-import { type PropMeta, showAttribute } from "@webstudio-is/react-sdk";
+import {
+ type PropMeta,
+ showAttribute,
+ decodeDataSourceVariable,
+} from "@webstudio-is/react-sdk";
import type { PropValue } from "../shared";
import { useStore } from "@nanostores/react";
-import { registeredComponentPropsMetasStore } from "~/shared/nano-states";
+import {
+ $dataSources,
+ registeredComponentPropsMetasStore,
+} from "~/shared/nano-states";
type PropOrName = { prop?: Prop; propName: string };
-export type PropAndMeta = { prop?: Prop; propName: string; meta: PropMeta };
+export type PropAndMeta = {
+ prop?: Prop;
+ propName: string;
+ meta: PropMeta;
+ readOnly: boolean;
+};
export type NameAndLabel = { name: string; label?: string };
// The value we set prop to when it's added
@@ -104,6 +116,7 @@ const getDefaultMetaForType = (type: Prop["type"]): PropMeta => {
type UsePropsLogicInput = {
instance: Instance;
props: Prop[];
+ propValues?: Map<Prop["name"], unknown>;
updateProp: (update: Prop) => void;
deleteProp: (id: Prop["id"]) => void;
};
@@ -127,16 +140,32 @@ const systemPropsMeta: { name: string; meta: PropMeta }[] = [
},
];
+const getPropTypeAndValue = (value: unknown) => {
+ if (typeof value === "boolean") {
+ return { type: "boolean", value } as const;
+ }
+ if (typeof value === "number") {
+ return { type: "number", value } as const;
+ }
+ if (typeof value === "string") {
+ return { type: "string", value } as const;
+ }
+ // fallback to json
+ return { type: "json", value } as const;
+};
+
/** usePropsLogic expects that key={instanceId} is used on the ancestor component */
export const usePropsLogic = ({
instance,
props,
+ propValues,
updateProp,
deleteProp,
}: UsePropsLogicInput) => {
const meta = useStore(registeredComponentPropsMetasStore).get(
instance.component
);
+ const dataSources = useStore($dataSources);
if (meta === undefined) {
throw new Error(`Could not get meta for component "${instance.component}"`);
@@ -152,14 +181,41 @@ export const usePropsLogic = ({
const initialPropsNames = new Set(meta.initialProps ?? []);
- const systemProps = systemPropsMeta.map(({ name, meta }) => {
+ const resolvePropExpression = (prop?: Prop) => {
+ if (prop?.type !== "expression") {
+ return prop;
+ }
+ const propValue = propValues?.get(prop.name);
+ return { ...prop, ...getPropTypeAndValue(propValue) };
+ };
+
+ /**
+ * make sure expression can be edited if consists only of single variable
+ */
+ const isReadOnly = (prop?: Prop) => {
+ if (prop?.type !== "expression") {
+ return false;
+ }
+ const potentialVariableId = decodeDataSourceVariable(prop.value);
+ return (
+ potentialVariableId === undefined ||
+ dataSources.has(potentialVariableId) === false
+ );
+ };
+
+ const systemProps: PropAndMeta[] = systemPropsMeta.map(({ name, meta }) => {
let saved = getAndDelete<Prop>(unprocessedSaved, name);
if (saved === undefined && meta.defaultValue !== undefined) {
saved = getStartingProp(instance.id, meta, name);
}
getAndDelete(unprocessedKnown, name);
initialPropsNames.delete(name);
- return { prop: saved, propName: name, meta };
+ return {
+ prop: resolvePropExpression(saved),
+ propName: name,
+ meta,
+ readOnly: isReadOnly(saved),
+ };
});
const initialProps: PropAndMeta[] = [];
@@ -190,7 +246,12 @@ export const usePropsLogic = ({
prop = getStartingProp(instance.id, known, name);
}
- initialProps.push({ prop, propName: name, meta: known });
+ initialProps.push({
+ prop: resolvePropExpression(prop),
+ propName: name,
+ meta: known,
+ readOnly: isReadOnly(prop),
+ });
}
const addedProps: PropAndMeta[] = [];
@@ -210,7 +271,12 @@ export const usePropsLogic = ({
known = getDefaultMetaForType(prop.type);
}
- addedProps.push({ prop, propName: prop.name, meta: known });
+ addedProps.push({
+ prop: resolvePropExpression(prop),
+ propName: prop.name,
+ meta: known,
+ readOnly: isReadOnly(prop),
+ });
}
const handleAdd = (propName: string) => {
diff --git a/apps/builder/app/builder/features/settings-panel/shared.tsx b/apps/builder/app/builder/features/settings-panel/shared.tsx
index 451479dc81..a3101d1e3a 100644
--- a/apps/builder/app/builder/features/settings-panel/shared.tsx
+++ b/apps/builder/app/builder/features/settings-panel/shared.tsx
@@ -8,7 +8,7 @@ import {
import equal from "fast-deep-equal";
import type { PropMeta } from "@webstudio-is/react-sdk";
import type { Prop, Asset } from "@webstudio-is/sdk";
-import { SubtractIcon } from "@webstudio-is/icons";
+import { HelpIcon, SubtractIcon } from "@webstudio-is/icons";
import {
SmallIconButton,
Label as BaseLabel,
@@ -20,6 +20,7 @@ import {
Text,
theme,
type CSS,
+ rawTheme,
} from "@webstudio-is/design-system";
import { humanizeString } from "~/shared/string-utils";
@@ -52,6 +53,7 @@ export type ControlProps<Control, PropType> = {
prop: PropByType<PropType> | undefined;
propName: string;
deletable: boolean;
+ readOnly: boolean;
onChange: (value: PropValue, asset?: Asset) => void;
onDelete: () => void;
};
@@ -84,6 +86,7 @@ type LabelProps = ComponentPropsWithoutRef<typeof BaseLabel> & {
children: string;
description?: string;
openOnClick?: boolean;
+ readOnly?: boolean;
};
export const Label = ({
@@ -91,29 +94,52 @@ export const Label = ({
children,
description,
openOnClick = false,
+ readOnly,
...rest
}: LabelProps) => {
const [isOpen, setIsOpen] = useState(false);
+ let label: ReactNode;
+
if (description == null) {
- return <SimpleLabel htmlFor={htmlFor}>{children}</SimpleLabel>;
+ label = <SimpleLabel htmlFor={htmlFor}>{children}</SimpleLabel>;
+ } else {
+ label = (
+ <Tooltip
+ open={isOpen}
+ onOpenChange={setIsOpen}
+ content={
+ <Flex
+ direction="column"
+ gap="2"
+ css={{ maxWidth: theme.spacing[28] }}
+ >
+ <Text variant="titles">{children}</Text>
+ <Text>{description}</Text>
+ </Flex>
+ }
+ >
+ <BaseLabel truncate htmlFor={htmlFor} {...rest}>
+ {children}
+ </BaseLabel>
+ </Tooltip>
+ );
}
return (
- <Tooltip
- open={isOpen}
- onOpenChange={setIsOpen}
- content={
- <Flex direction="column" gap="2" css={{ maxWidth: theme.spacing[28] }}>
- <Text variant="titles">{children}</Text>
- <Text>{description}</Text>
- </Flex>
- }
- >
- <BaseLabel truncate htmlFor={htmlFor} {...rest}>
- {children}
- </BaseLabel>
- </Tooltip>
+ <Flex align="center" css={{ gap: theme.spacing[3] }}>
+ {label}
+ {readOnly && (
+ <Tooltip
+ content={
+ "The value is controlled by an expression and cannot be changed."
+ }
+ variant="wrapped"
+ >
+ <HelpIcon color={rawTheme.colors.foregroundSubtle} tabIndex={0} />
+ </Tooltip>
+ )}
+ </Flex>
);
};