Skip to content
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

Link variants switch behavior #1504

Merged
merged 2 commits into from
Dec 13, 2024
+57 −29
Merged

Link variants switch behavior #1504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0cb05fd
Upgrade types internal
dani-mp Dec 13, 2024
4c7da94
Add link variants switch behavior
dani-mp Dec 13, 2024
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
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"resolutions": {
"connected-next-router/react-redux": "8.0.7",
"react-beautiful-dnd/react-redux": "8.0.7",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"express": "4.20.0"
},
"workspaces": [
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-next/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
},
"dependencies": {
"@prismicio/simulator": "^0.1.4",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/plugin-kit": "workspace:*",
"common-tags": "^1.8.2",
"fp-ts": "^2.13.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-nuxt/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
},
"dependencies": {
"@prismicio/simulator": "^0.1.4",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/plugin-kit": "workspace:*",
"common-tags": "^1.8.2",
"fp-ts": "^2.13.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-nuxt2/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
},
"dependencies": {
"@prismicio/simulator": "^0.1.4",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/plugin-kit": "workspace:*",
"common-tags": "^1.8.2",
"fp-ts": "^2.13.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/adapter-sveltekit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
},
"dependencies": {
"@prismicio/simulator": "^0.1.4",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/plugin-kit": "workspace:*",
"common-tags": "^1.8.2",
"fp-ts": "^2.13.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/manager/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
"@prismicio/client": "^7.11.0",
"@prismicio/custom-types-client": "2.1.0",
"@prismicio/mocks": "2.5.0",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@segment/analytics-node": "^2.1.2",
"@slicemachine/plugin-kit": "workspace:*",
"cookie": "^1.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/plugin-kit/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
},
"devDependencies": {
"@prismicio/mock": "0.3.7",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@size-limit/preset-small-lib": "8.2.4",
"@types/common-tags": "1.8.1",
"@types/fs-extra": "11.0.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/slice-machine/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
"@prismicio/mock": "0.3.3",
"@prismicio/mocks": "2.5.0",
"@prismicio/simulator": "0.1.4",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@radix-ui/react-hover-card": "1.0.6",
"@radix-ui/react-tabs": "1.0.4",
"@reach/menu-button": "0.18.0",
Expand Down
19 changes: 16 additions & 3 deletions packages/slice-machine/src/legacy/lib/models/common/widgets/Link/Form.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
/* eslint-disable @typescript-eslint/no-unsafe-call */
/* eslint-disable @typescript-eslint/no-unsafe-return */

import { Box } from "@prismicio/editor-ui";
import { Flex } from "theme-ui";

Expand All @@ -7,7 +11,11 @@ import { createFieldNameFromKey } from "@/legacy/lib/forms";
import { DefaultFields } from "@/legacy/lib/forms/defaults";
import { CheckBox } from "@/legacy/lib/forms/fields";

import { DisplayTextCheckbox, RepeatableCheckbox, Variant } from "./components";
import {
DisplayTextCheckbox,
RepeatableCheckbox,
Variants,
} from "./components";

const FormFields = {
...DefaultFields,
Expand All @@ -19,7 +27,7 @@ const Form = (props) => {

// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
const {
config: { allowText, repeat },
config: { allowText, repeat, variants },
} = formValues;

return (
Expand Down Expand Up @@ -73,7 +81,12 @@ const Form = (props) => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
setFieldValue={setFieldValue}
/>
<Variant />
<Variants
variants={variants}
onVariantsChange={(variants) =>
setFieldValue("config.variants", variants)
}
/>
</Box>
</>
);
Expand Down
20 changes: 17 additions & 3 deletions packages/slice-machine/src/legacy/lib/models/common/widgets/Link/components.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,21 @@ export function RepeatableCheckbox(props: CommonCheckboxProps) {
);
}

export function Variant() {
export function Variants({
variants,
onVariantsChange,
}: {
variants?: string[];
onVariantsChange: (variants?: string[]) => void;
}) {
const enabled = Boolean(variants);

const onCheckedChange = (checked: boolean) => {
onVariantsChange(checked ? ["Primary", "Secondary"] : undefined);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Potential product problem, are we sure we want to reset the variants every time you check / uncheck?

I'm wondering because, let say you're a dev with 5 variants, click accidentally or "just to see" what happens, you will lose existing data.

I would have said that ["Primary", "Secondary"] would only be the default if you don't have already, no?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

my opinion is that resetting is better, especially because adding them is not costly if you accidentally disable it

otherwise, you sometimes will see the default values, and sometimes you won't, and you won't necessarily know why

for instance, see this scenario:

  1. enable (you see the default options)
  2. change an option
  3. disable
  4. enable (you see the changed option)
  5. disable
  6. close the modal without clicking "done"
  7. enable (you see the default options)

if we always reset, the behavior in those two scenarios would be the same (default options)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see, I like the consistency argument. Let's just mention that during our daily so Côme knows about it but should be good!

};

const switchLabel = enabled ? "Enabled" : "Disabled";

return (
<Box overflow="hidden" flexDirection="column" border borderRadius={6}>
<Box
Expand All @@ -107,8 +121,8 @@ export function Variant() {
the link's style by selecting one of them.
</Text>
<Box gap={8}>
<Switch />
<Text color="grey11">Disabled</Text>
<Switch checked={enabled} onCheckedChange={onCheckedChange} />
<Text color="grey11">{switchLabel}</Text>
</Box>
</Box>
<Box backgroundColor="white" flexDirection="column" padding={12}>
Expand Down
1 change: 1 addition & 0 deletions packages/slice-machine/src/legacy/lib/models/common/widgets/Link/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export const linkConfigSchema = yup
allowTargetBlank: yup.boolean().strict().optional(),
allowText: yup.boolean().strict().optional(),
repeat: yup.boolean().strict().optional(),
variants: yup.array(yup.string()).optional(),
})
.required()
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
Expand Down
2 changes: 1 addition & 1 deletion packages/start-slicemachine/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"bin": "./bin/start-slicemachine.js",
"dependencies": {
"@prismicio/mocks": "2.5.0",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/manager": "workspace:*",
"body-parser": "^1.20.3",
"chalk": "^4.1.2",
Expand Down
2 changes: 1 addition & 1 deletion playwright/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"devDependencies": {
"@msgpack/msgpack": "2.8.0",
"@playwright/test": "1.39.0",
"@prismicio/types-internal": "3.2.0",
"@prismicio/types-internal": "3.3.0-alpha.2",
"@slicemachine/manager": "workspace:*",
"@typescript-eslint/eslint-plugin": "7.17.0",
"@typescript-eslint/parser": "7.17.0",
Expand Down
26 changes: 13 additions & 13 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6236,9 +6236,9 @@ __metadata:
languageName: node
linkType: hard

"@prismicio/types-internal@npm:3.2.0":
version: 3.2.0
resolution: "@prismicio/types-internal@npm:3.2.0"
"@prismicio/types-internal@npm:3.3.0-alpha.2":
version: 3.3.0-alpha.2
resolution: "@prismicio/types-internal@npm:3.3.0-alpha.2"
dependencies:
monocle-ts: ^2.3.11
newtype-ts: ^0.3.5
Expand All @@ -6248,7 +6248,7 @@ __metadata:
fp-ts: ^2.11.8
io-ts: ^2.2.16
io-ts-types: ^0.5.16
checksum: d5f51562adcabc9255092a06817f3de384c392834c075858c2e03740b8a79df108b082f35e07cbf0ec5e8818594ddd42a3374e89d139826248c38ba54b32742c
checksum: 7439e4bdd456059fae8cd0759a7abb64b14ee35876bfbb84609e0bbacfb396eb23141a88fcf7c340ffe03f0367b2f01e76df8d39133961f921f0950c1267961a
languageName: node
linkType: hard

Expand Down Expand Up @@ -8980,7 +8980,7 @@ __metadata:
dependencies:
"@prismicio/mock": 0.2.0
"@prismicio/simulator": ^0.1.4
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/plugin-kit": "workspace:*"
"@types/common-tags": 1.8.1
Expand Down Expand Up @@ -9025,7 +9025,7 @@ __metadata:
dependencies:
"@prismicio/mock": 0.2.0
"@prismicio/simulator": ^0.1.4
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/plugin-kit": "workspace:*"
"@typescript-eslint/eslint-plugin": 5.55.0
Expand Down Expand Up @@ -9066,7 +9066,7 @@ __metadata:
dependencies:
"@prismicio/mock": 0.2.0
"@prismicio/simulator": ^0.1.4
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/plugin-kit": "workspace:*"
"@types/common-tags": 1.8.1
Expand Down Expand Up @@ -9108,7 +9108,7 @@ __metadata:
dependencies:
"@prismicio/mock": 0.2.0
"@prismicio/simulator": ^0.1.4
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/plugin-kit": "workspace:*"
"@sveltejs/kit": 2.0.0
Expand Down Expand Up @@ -9161,7 +9161,7 @@ __metadata:
dependencies:
"@msgpack/msgpack": 2.8.0
"@playwright/test": 1.39.0
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@slicemachine/manager": "workspace:*"
"@typescript-eslint/eslint-plugin": 7.17.0
"@typescript-eslint/parser": 7.17.0
Expand Down Expand Up @@ -9231,7 +9231,7 @@ __metadata:
"@prismicio/custom-types-client": 2.1.0
"@prismicio/mock": 0.2.0
"@prismicio/mocks": 2.5.0
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@segment/analytics-node": ^2.1.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/plugin-kit": "workspace:*"
Expand Down Expand Up @@ -9289,7 +9289,7 @@ __metadata:
dependencies:
"@prismicio/client": ^7.11.0
"@prismicio/mock": 0.3.7
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@types/common-tags": 1.8.1
"@types/fs-extra": 11.0.1
Expand Down Expand Up @@ -31227,7 +31227,7 @@ __metadata:
"@prismicio/mock": 0.3.3
"@prismicio/mocks": 2.5.0
"@prismicio/simulator": 0.1.4
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@radix-ui/react-hover-card": 1.0.6
"@radix-ui/react-tabs": 1.0.4
"@radix-ui/react-visually-hidden": 1.0.3
Expand Down Expand Up @@ -31705,7 +31705,7 @@ __metadata:
resolution: "start-slicemachine@workspace:packages/start-slicemachine"
dependencies:
"@prismicio/mocks": 2.5.0
"@prismicio/types-internal": 3.2.0
"@prismicio/types-internal": 3.3.0-alpha.2
"@size-limit/preset-small-lib": 8.2.4
"@slicemachine/manager": "workspace:*"
"@types/body-parser": 1.19.2
Expand Down
Loading