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.
TypeScript accessibilityalternativecloudflarecloudflare-workersdesignfreefrontendopen-sourceradix-uireactremixweb-developmentwebflowwebsite-builderwebsite-developmentwebsiteswebstudio
UX improvement for Inputs that have both keywords and units (#1412)
Ivan Starkov167d7461074b
diff --git a/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.test.ts b/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.test.tsnew file mode 100644index 0000000000..45f634861b--- /dev/null+++ b/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.test.ts@@ -0,0 +1,35 @@+import { describe, test, expect } from "@jest/globals";+import { convertUnits } from "./convert-units";++const unitSizes = {+ ch: 8,+ vw: 3.2,+ vh: 4.8,+ em: 14,+ rem: 16,+ px: 1,+};++describe("Evaluate math", () => {+ test("convert same units", () => {+ expect(convertUnits(unitSizes)(100, "px", "px")).toEqual(100);+ expect(convertUnits(unitSizes)(100, "deg", "deg")).toEqual(100);+ });++ test("do nothing if can't convert", () => {+ expect(convertUnits(unitSizes)(100, "deg", "rad")).toEqual(100);+ });++ test("convert size units", () => {+ expect(convertUnits(unitSizes)(224, "px", "em")).toEqual(16);+ expect(convertUnits(unitSizes)(16, "em", "px")).toEqual(224);++ expect(convertUnits(unitSizes)(16, "em", "rem")).toEqual(14);+ expect(convertUnits(unitSizes)(14, "rem", "em")).toEqual(16);++ expect(convertUnits(unitSizes)(320, "px", "vw")).toEqual(100);+ expect(convertUnits(unitSizes)(480, "px", "vh")).toEqual(100);++ expect(convertUnits(unitSizes)(100, "vw", "rem")).toEqual(20);+ });+});diff --git a/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.ts b/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.tsnew file mode 100644index 0000000000..476a38e7da--- /dev/null+++ b/apps/builder/app/builder/features/style-panel/shared/css-value-input/convert-units.ts@@ -0,0 +1,23 @@+import type { Unit } from "@webstudio-is/css-data";++const convertibleUnits = ["px", "ch", "vw", "vh", "em", "rem"] as const;++type ConvertibleUnit = (typeof convertibleUnits)[number];++export type UnitSizes = Record<ConvertibleUnit, number>;++const isConvertibleUnit = (unit: Unit): unit is ConvertibleUnit =>+ convertibleUnits.includes(unit as ConvertibleUnit);++export const convertUnits =+ (unitSizes: UnitSizes) =>+ (value: number, from: Unit, to: Unit): number => {+ if (from === to) {+ return value;+ }++ if (isConvertibleUnit(from) && isConvertibleUnit(to)) {+ return (value * unitSizes[from]) / unitSizes[to];+ }+ return value;+ };diff --git a/apps/builder/app/builder/features/style-panel/shared/css-value-input/css-value-input.tsx b/apps/builder/app/builder/features/style-panel/shared/css-value-input/css-value-input.tsxindex 9043720e35..e8b871828b 100644--- a/apps/builder/app/builder/features/style-panel/shared/css-value-input/css-value-input.tsx+++ b/apps/builder/app/builder/features/style-panel/shared/css-value-input/css-value-input.tsx@@ -35,6 +35,11 @@ import { useDebouncedCallback } from "use-debounce";import type { StyleSource } from "../style-info";import { toPascalCase } from "../keyword-utils";import { isValid } from "../parse-css-value";+import {+ selectedInstanceBrowserStyleStore,+ selectedInstanceUnitSizesStore,+} from "~/shared/nano-states";+import { convertUnits } from "./convert-units";// We increment by 10 when shift is pressed, by 0.1 when alt/option is pressed and by 1 by default.const calcNumberChange = (@@ -381,13 +386,73 @@ export const CssValueInput = ({? value.unit: undefined,onChange: (unit) => {- if (value.type === "unit" || value.type === "intermediate") {+ // value looks like a number and just edited (type === "intermediate")+ // no additional conversions are necessary+ if (+ value.type === "intermediate" &&+ Number.isNaN(Number.parseFloat(value.value)) === false+ ) {onChangeComplete({ ...value, unit }, "unit-select");return;}+ const unitSizes = selectedInstanceUnitSizesStore.get();++ // Value not edited by the user, we need to convert it to the new unit+ if (value.type === "unit") {+ const convertedValue = convertUnits(unitSizes)(+ value.value,+ value.unit,+ unit+ );++ onChangeComplete(+ {+ type: "unit",+ value: Number.parseFloat(convertedValue.toFixed(2)),+ unit,+ },+ "unit-select"+ );+ return;+ }++ // value is a keyword or non numeric, try get browser style value and convert it+ if (value.type === "keyword" || value.type === "intermediate") {+ const browserStyle = selectedInstanceBrowserStyleStore.get();+ const browserPropertyValue = browserStyle?.[property];+ const propertyValue =+ browserPropertyValue?.type === "unit"+ ? browserPropertyValue.value+ : 0;+ const propertyUnit =+ browserPropertyValue?.type === "unit"+ ? browserPropertyValue.unit+ : "number";++ const convertedValue = convertUnits(unitSizes)(+ propertyValue,+ propertyUnit,+ unit+ );++ onChangeComplete(+ {+ type: "unit",+ value: Number.parseFloat(convertedValue.toFixed(2)),+ unit,+ },+ "unit-select"+ );+ return;+ }+onChangeComplete(- { type: "intermediate", value: toValue(value), unit },+ {+ type: "intermediate",+ value: toValue(value),+ unit,+ },"unit-select");},@@ -480,10 +545,13 @@ export const CssValueInput = ({<ChevronDownIcon /></NestedSelectButton>);++ const isUnitValue = unitSelectElement !== null;+const hasItems = items.length !== 0;- const isUnitValue = "unit" in value;const isKeywordValue = value.type === "keyword" && hasItems;const suffixRef = useRef<HTMLDivElement | null>(null);+const suffix = (<Box ref={suffixRef}>{isUnitValuediff --git a/apps/builder/app/builder/features/style-panel/shared/css-value-input/unit-select.tsx b/apps/builder/app/builder/features/style-panel/shared/css-value-input/unit-select.tsxindex 49a388ee3c..e976662ec1 100644--- a/apps/builder/app/builder/features/style-panel/shared/css-value-input/unit-select.tsx+++ b/apps/builder/app/builder/features/style-panel/shared/css-value-input/unit-select.tsx@@ -70,12 +70,13 @@ export const useUnitSelect = ({const select = (<UnitSelect- value={value ?? options[0].id}+ value={value}options={options}open={isOpen}onCloseAutoFocus={onCloseAutoFocus}onOpenChange={setIsOpen}onChange={onChange}+ labelFallback={options[0].label}/>);@@ -84,11 +85,12 @@ export const useUnitSelect = ({type UnitSelectProps = {options: Array<UnitOption>;- value: string;+ value?: string | undefined;onChange: (value: Unit) => void;onOpenChange: (open: boolean) => void;onCloseAutoFocus: (event: Event) => void;open: boolean;+ labelFallback: string;};const UnitSelect = ({@@ -98,6 +100,7 @@ const UnitSelect = ({onOpenChange,onCloseAutoFocus,open,+ labelFallback,}: UnitSelectProps) => {const matchedOption = options.find((item) => item.id === value);return (@@ -111,7 +114,9 @@ const UnitSelect = ({<NestedSelectButton tabIndex={-1}><SelectPrimitive.Value>{matchedOption?.label ??- (value === "number" ? nestedSelectButtonUnitless : value)}+ (value === "number"+ ? nestedSelectButtonUnitless+ : value ?? labelFallback)}</SelectPrimitive.Value></NestedSelectButton></SelectPrimitive.SelectTrigger>diff --git a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.tsindex 7ecc8cbe5b..5d268c8337 100644--- a/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts+++ b/apps/builder/app/canvas/features/webstudio-component/selected-instance-connector.ts@@ -8,11 +8,13 @@ import {rootInstanceContainer,selectedInstanceBrowserStyleStore,selectedInstanceIntanceToTagStore,+ selectedInstanceUnitSizesStore,} from "~/shared/nano-states";import htmlTags, { type htmlTags as HtmlTags } from "html-tags";import { getAllElementsBoundingBox } from "~/shared/dom-utils";import { subscribeScrollState } from "~/canvas/shared/scroll-state";import { selectedInstanceOutlineStore } from "~/shared/nano-states";+import type { UnitSizes } from "~/builder/features/style-panel/shared/css-value-input/convert-units";const isHtmlTag = (tag: string): tag is HtmlTags =>htmlTags.includes(tag as HtmlTags);@@ -28,6 +30,40 @@ const hideOutline = () => {selectedInstanceOutlineStore.set(undefined);};+const calculateUnitSizes = (element: HTMLElement): UnitSizes => {+ // Based on this https://stackoverflow.com/questions/1248081/how-to-get-the-browser-viewport-dimensions/8876069#8876069+ // this is crossbrowser way to get viewport sizes vw vh in px+ const vw =+ Math.max(document.documentElement.clientWidth, window.innerWidth) / 100;+ const vh =+ Math.max(document.documentElement.clientHeight, window.innerHeight) / 100;++ // em in px is equal to current computed style for font size+ const em = Number.parseFloat(getComputedStyle(element).fontSize);++ // rem in px is equal to root computed style for font size+ const rem = Number.parseFloat(+ getComputedStyle(document.documentElement).fontSize+ );++ // we create a node with 1ch width, measure it in px and remove it+ const node = document.createElement("div");+ node.style.width = "1ch";+ node.style.position = "absolute";+ element.appendChild(node);+ const ch = Number.parseFloat(getComputedStyle(node).width);+ element.removeChild(node);++ return {+ ch, // 1ch in pixels+ vw, // 1vw in pixels+ vh, // 1vh in pixels+ em, // 1em in pixels+ rem, // 1rem in pixels+ px: 1, // always 1, simplifies conversions and types, i.e valueTo = valueFrom * unitSizes[from] / unitSizes[to]+ };+};+export const SelectedInstanceConnector = ({instanceElementRef,instance,@@ -112,6 +148,9 @@ export const SelectedInstanceConnector = ({selectedInstanceIntanceToTagStore.set(instanceToTag);+ const unitSizes = calculateUnitSizes(element);+ selectedInstanceUnitSizesStore.set(unitSizes);+return () => {hideOutline();resizeObserver.disconnect();diff --git a/apps/builder/app/shared/nano-states/nano-states.ts b/apps/builder/app/shared/nano-states/nano-states.tsindex f92f3d4a29..d455b89885 100644--- a/apps/builder/app/shared/nano-states/nano-states.ts+++ b/apps/builder/app/shared/nano-states/nano-states.ts@@ -31,6 +31,7 @@ import {selectedInstanceSelectorStore,} from "./instances";import { selectedPageStore } from "./pages";+import type { UnitSizes } from "~/builder/features/style-panel/shared/css-value-input/convert-units";const useValue = <T>(atom: WritableAtom<T>) => {const value = useStore(atom);@@ -212,6 +213,16 @@ export const useSetAssets = (assets: [Asset["id"], Asset][]) => {export const selectedInstanceBrowserStyleStore = atom<undefined | Style>();+// Init with some defaults to avoid undefined+export const selectedInstanceUnitSizesStore = atom<UnitSizes>({+ ch: 8,+ vw: 3.2,+ vh: 4.8,+ em: 16,+ rem: 16,+ px: 1,+});+/*** instanceId => tagName store for selected instance and its ancestors*/diff --git a/apps/builder/app/shared/sync/sync-stores.ts b/apps/builder/app/shared/sync/sync-stores.tsindex 41a79da850..01521532fe 100644--- a/apps/builder/app/shared/sync/sync-stores.ts+++ b/apps/builder/app/shared/sync/sync-stores.ts@@ -15,6 +15,7 @@ import {selectedPageIdStore,selectedInstanceSelectorStore,selectedInstanceBrowserStyleStore,+ selectedInstanceUnitSizesStore,selectedInstanceIntanceToTagStore,hoveredInstanceSelectorStore,isPreviewModeStore,@@ -71,6 +72,10 @@ export const registerContainers = () => {"selectedInstanceIntanceToTagStore",selectedInstanceIntanceToTagStore);+ clientStores.set(+ "selectedInstanceUnitSizesStore",+ selectedInstanceUnitSizesStore+ );clientStores.set("hoveredInstanceSelector", hoveredInstanceSelectorStore);clientStores.set("isPreviewMode", isPreviewModeStore);diff --git a/packages/design-system/src/components/input-field.tsx b/packages/design-system/src/components/input-field.tsxindex f0b41cdc76..19f33bfa4e 100644--- a/packages/design-system/src/components/input-field.tsx+++ b/packages/design-system/src/components/input-field.tsx@@ -8,11 +8,13 @@ import {type ReactNode,type ComponentProps,type Ref,+ type FocusEvent,} from "react";import { textVariants } from "./text";import { css, theme, type CSS } from "../stitches.config";import { ArrowFocus } from "./primitives/arrow-focus";import { mergeRefs } from "@react-aria/utils";+import { useFocusWithin } from "@react-aria/interactions";// we only support types that behave more or less like a regular text inputexport const inputFieldTypes = [@@ -147,7 +149,7 @@ type InputProps = {type?: (typeof inputFieldTypes)[number];color?: (typeof inputFieldColors)[number];css?: CSS;-} & Omit<ComponentProps<"input">, "prefix">;+} & Omit<ComponentProps<"input">, "prefix" | "onFocus" | "onBlur">;const Input = forwardRef((@@ -175,24 +177,38 @@ export const InputField = forwardRef(suffix,containerRef,inputRef,+ onFocus,+ onBlur,...props}: InputProps & {prefix?: ReactNode;suffix?: ReactNode;containerRef?: Ref<HTMLDivElement>;inputRef?: Ref<HTMLInputElement>;+ onFocus?: (e: FocusEvent) => void;+ onBlur?: (e: FocusEvent) => void;},ref: Ref<HTMLDivElement>- ) => (- <Container- css={css}- className={className}- prefix={prefix}- suffix={suffix}- ref={mergeRefs(ref, containerRef ?? null)}- >- <Input {...props} ref={inputRef} />- </Container>- )+ ) => {+ // Our input field can contain multiple focused elements,+ // so we need to use useFocusWithin to track focus within the container.+ const { focusWithinProps } = useFocusWithin({+ onFocusWithin: onFocus,+ onBlurWithin: onBlur,+ });++ return (+ <Container+ css={css}+ className={className}+ prefix={prefix}+ suffix={suffix}+ {...focusWithinProps}+ ref={mergeRefs(ref, containerRef ?? null)}+ >+ <Input {...props} ref={inputRef} />+ </Container>+ );+ });InputField.displayName = "InputField";