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.

Define component states in meta (#1481)

Bogdan Chadkinba9f1a6e5ba4
diff --git a/apps/builder/app/builder/features/style-panel/style-source-section.tsx b/apps/builder/app/builder/features/style-panel/style-source-section.tsx
index 4cd13208d5..506c8a0705 100644
--- a/apps/builder/app/builder/features/style-panel/style-source-section.tsx
+++ b/apps/builder/app/builder/features/style-panel/style-source-section.tsx
@@ -1,6 +1,8 @@
import { useState } from "react";
-import store from "immerhin";
+import { useStore } from "@nanostores/react";
import { nanoid } from "nanoid";
+import { computed } from "nanostores";
+import store from "immerhin";
import { theme, Text } from "@webstudio-is/design-system";
import {
type Instance,
@@ -8,12 +10,13 @@ import {
type StyleSourceSelections,
getStyleDeclKey,
} from "@webstudio-is/project-build";
+import { getComponentMeta } from "@webstudio-is/react-sdk";
import { type ItemSource, StyleSourceInput } from "./style-source";
-import { useStore } from "@nanostores/react";
import {
availableStyleSourcesStore,
selectedInstanceSelectorStore,
selectedInstanceStatesByStyleSourceIdStore,
+ selectedInstanceStore,
selectedInstanceStyleSourcesStore,
selectedOrLastStyleSourceSelectorStore,
selectedStyleSourceSelectorStore,
@@ -282,6 +285,16 @@ const renameStyleSource = (id: StyleSource["id"], label: string) => {
});
};
+const componentStatesStore = computed(
+ [selectedInstanceStore],
+ (selectedInstance) => {
+ if (selectedInstance === undefined) {
+ return;
+ }
+ return getComponentMeta(selectedInstance.component)?.states;
+ }
+);
+
type StyleSourceInputItem = {
id: string;
label: string;
@@ -304,6 +317,7 @@ const convertToInputItem = (
};
export const StyleSourcesSection = () => {
+ const componentStates = useStore(componentStatesStore);
const availableStyleSources = useStore(availableStyleSourcesStore);
const selectedInstanceStyleSources = useStore(
selectedInstanceStyleSourcesStore
@@ -338,6 +352,7 @@ export const StyleSourcesSection = () => {
items={items}
value={value}
selectedItemSelector={selectedOrLastStyleSourceSelector}
+ componentStates={componentStates}
onCreateItem={createStyleSource}
onSelectAutocompleteItem={({ id }) => {
addStyleSourceToInstace(id);
diff --git a/apps/builder/app/builder/features/style-panel/style-source/style-source-input.tsx b/apps/builder/app/builder/features/style-panel/style-source/style-source-input.tsx
index 37e12e7ea2..d99e457afa 100644
--- a/apps/builder/app/builder/features/style-panel/style-source/style-source-input.tsx
+++ b/apps/builder/app/builder/features/style-panel/style-source/style-source-input.tsx
@@ -41,6 +41,7 @@ import {
type ReactNode,
} from "react";
import { mergeRefs } from "@react-aria/utils";
+import type { ComponentState } from "@webstudio-is/react-sdk";
import { type ItemSource, menuCssVars, StyleSource } from "./style-source";
import { useSortable } from "./use-sortable";
import { matchSorter } from "match-sorter";
@@ -186,6 +187,7 @@ type StyleSourceInputProps<Item extends IntermediateItem> = {
value?: Array<Item>;
selectedItemSelector: undefined | ItemSelector;
editingItemId?: Item["id"];
+ componentStates?: ComponentState[];
onSelectAutocompleteItem?: (item: Item) => void;
onRemoveItem?: (id: Item["id"]) => void;
onDeleteItem?: (id: Item["id"]) => void;
@@ -251,6 +253,7 @@ const userActionStates = [
const renderMenuItems = (props: {
selectedItemSelector: undefined | ItemSelector;
item: IntermediateItem;
+ componentStates?: ComponentState[];
onSelect?: (itemSelector: ItemSelector) => void;
onEdit?: (itemId: IntermediateItem["id"]) => void;
onDuplicate?: (itemId: IntermediateItem["id"]) => void;
@@ -259,26 +262,34 @@ const renderMenuItems = (props: {
onEnable?: (itemId: IntermediateItem["id"]) => void;
onRemove?: (itemId: IntermediateItem["id"]) => void;
onDelete?: (itemId: IntermediateItem["id"]) => void;
-}) => (
- <>
- {props.item.source !== "local" && (
- <DropdownMenuItem onSelect={() => props.onEdit?.(props.item.id)}>
- Edit Name
- </DropdownMenuItem>
- )}
- {props.item.source !== "local" && (
- <DropdownMenuItem onSelect={() => props.onDuplicate?.(props.item.id)}>
- Duplicate
- </DropdownMenuItem>
- )}
- {props.item.source === "local" && (
- <DropdownMenuItem
- onSelect={() => props.onConvertToToken?.(props.item.id)}
- >
- Convert to token
- </DropdownMenuItem>
- )}
- {/* @todo implement disabling
+}) => {
+ const states = [
+ ...userActionStates.map((selector) => ({
+ selector,
+ label: humanizeString(selector),
+ })),
+ ...(props.componentStates ?? []),
+ ];
+ return (
+ <>
+ {props.item.source !== "local" && (
+ <DropdownMenuItem onSelect={() => props.onEdit?.(props.item.id)}>
+ Edit Name
+ </DropdownMenuItem>
+ )}
+ {props.item.source !== "local" && (
+ <DropdownMenuItem onSelect={() => props.onDuplicate?.(props.item.id)}>
+ Duplicate
+ </DropdownMenuItem>
+ )}
+ {props.item.source === "local" && (
+ <DropdownMenuItem
+ onSelect={() => props.onConvertToToken?.(props.item.id)}
+ >
+ Convert to token
+ </DropdownMenuItem>
+ )}
+ {/* @todo implement disabling
{props.disabled ? (
<DropdownMenuItem onSelect={() => props.onEnable?.(props.itemId)}>
Enable
@@ -289,52 +300,57 @@ const renderMenuItems = (props: {
</DropdownMenuItem>
)}
*/}
- {props.item.source !== "local" && (
- <DropdownMenuItem onSelect={() => props.onRemove?.(props.item.id)}>
- Remove
- </DropdownMenuItem>
- )}
- {props.item.source !== "local" && (
- <DropdownMenuItem
- destructive={true}
- onSelect={() => props.onDelete?.(props.item.id)}
- >
- Delete
- </DropdownMenuItem>
- )}
- {isFeatureEnabled("styleSourceStates") && (
- <>
- <DropdownMenuSeparator />
- <DropdownMenuLabel>States</DropdownMenuLabel>
- {userActionStates.map((state) => (
- <DropdownMenuItem
- key={state}
- withIndicator={true}
- icon={
- props.item.id === props.selectedItemSelector?.styleSourceId &&
- state === props.selectedItemSelector.state ? (
- <CheckMarkIcon
- color={
- props.item.states.includes(state)
- ? rawTheme.colors.foregroundPrimary
- : rawTheme.colors.foregroundIconMain
- }
- />
- ) : props.item.states.includes(state) ? (
- <DotIcon color={rawTheme.colors.foregroundPrimary} />
- ) : null
- }
- onSelect={() =>
- props.onSelect?.({ styleSourceId: props.item.id, state })
- }
- >
- {humanizeString(state)}
- </DropdownMenuItem>
- ))}
- </>
- )}
- </>
-);
+ {props.item.source !== "local" && (
+ <DropdownMenuItem onSelect={() => props.onRemove?.(props.item.id)}>
+ Remove
+ </DropdownMenuItem>
+ )}
+ {props.item.source !== "local" && (
+ <DropdownMenuItem
+ destructive={true}
+ onSelect={() => props.onDelete?.(props.item.id)}
+ >
+ Delete
+ </DropdownMenuItem>
+ )}
+
+ {isFeatureEnabled("styleSourceStates") && (
+ <>
+ <DropdownMenuSeparator />
+ <DropdownMenuLabel>States</DropdownMenuLabel>
+ {states.map(({ label, selector }) => (
+ <DropdownMenuItem
+ key={selector}
+ withIndicator={true}
+ icon={
+ props.item.id === props.selectedItemSelector?.styleSourceId &&
+ selector === props.selectedItemSelector.state ? (
+ <CheckMarkIcon
+ color={
+ props.item.states.includes(selector)
+ ? rawTheme.colors.foregroundPrimary
+ : rawTheme.colors.foregroundIconMain
+ }
+ />
+ ) : props.item.states.includes(selector) ? (
+ <DotIcon color={rawTheme.colors.foregroundPrimary} />
+ ) : null
+ }
+ onSelect={() =>
+ props.onSelect?.({
+ styleSourceId: props.item.id,
+ state: selector,
+ })
+ }
+ >
+ {label}
+ </DropdownMenuItem>
+ ))}
+ </>
+ )}
+ </>
+ );
+};
export const StyleSourceInput = (
props: StyleSourceInputProps<IntermediateItem>
@@ -403,6 +419,7 @@ export const StyleSourceInput = (
renderMenuItems({
selectedItemSelector: props.selectedItemSelector,
item,
+ componentStates: props.componentStates,
onSelect: props.onSelectItem,
onDuplicate: props.onDuplicateItem,
onConvertToToken: props.onConvertToToken,
diff --git a/packages/react-sdk/src/components/component-meta.ts b/packages/react-sdk/src/components/component-meta.ts
index e7734ef8d2..a0af78a464 100644
--- a/packages/react-sdk/src/components/component-meta.ts
+++ b/packages/react-sdk/src/components/component-meta.ts
@@ -23,6 +23,13 @@ export const componentCategories = [
"forms",
] as const;
+export const ComponentState = z.object({
+ selector: z.string(),
+ label: z.string(),
+});
+
+export type ComponentState = z.infer<typeof ComponentState>;
+
const WsComponentMeta = z.object({
category: z.enum(componentCategories).optional(),
// container - can accept other components with dnd
@@ -40,6 +47,7 @@ const WsComponentMeta = z.object({
label: z.string(),
Icon: z.function(),
presetStyle: z.optional(z.any()),
+ states: z.optional(z.array(ComponentState)),
children: z.optional(z.array(z.string())),
});
diff --git a/packages/react-sdk/src/components/link-block.ws.tsx b/packages/react-sdk/src/components/link-block.ws.tsx
index 513825b096..3e5714be9f 100644
--- a/packages/react-sdk/src/components/link-block.ws.tsx
+++ b/packages/react-sdk/src/components/link-block.ws.tsx
@@ -1,7 +1,7 @@
import { BoxLinkIcon } from "@webstudio-is/icons";
import type { WsComponentMeta, WsComponentPropsMeta } from "./component-meta";
import { props } from "./__generated__/link-block.props";
-import { propsMeta as linkPropsMeta } from "./link.ws";
+import { meta as linkMeta, propsMeta as linkPropsMeta } from "./link.ws";
import type { defaultTag } from "./link-block";
import type { Style } from "@webstudio-is/css-data";
import { a } from "../css/normalize";
@@ -21,6 +21,7 @@ export const meta: WsComponentMeta = {
type: "container",
label: "Link Block",
Icon: BoxLinkIcon,
+ states: linkMeta.states,
presetStyle,
};
diff --git a/packages/react-sdk/src/components/link.ws.tsx b/packages/react-sdk/src/components/link.ws.tsx
index 115d8d6fb4..ae169c0bd1 100644
--- a/packages/react-sdk/src/components/link.ws.tsx
+++ b/packages/react-sdk/src/components/link.ws.tsx
@@ -26,6 +26,7 @@ export const meta: WsComponentMeta = {
label: "Link Text",
Icon: LinkIcon,
presetStyle,
+ states: [{ selector: "[aria-current=page]", label: "Current page" }],
children: ["Link text you can edit"],
};
diff --git a/packages/react-sdk/src/index.ts b/packages/react-sdk/src/index.ts
index 42be105827..980fc8cc17 100644
--- a/packages/react-sdk/src/index.ts
+++ b/packages/react-sdk/src/index.ts
@@ -13,5 +13,6 @@ export {
export {
type WsComponentPropsMeta,
type WsComponentMeta,
+ type ComponentState,
componentCategories,
} from "./components/component-meta";