feat: add links to Links field #5223
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,99 +1,143 @@ | ||
| import { useMemo, useRef, useState } from 'react'; | ||
| import styled from '@emotion/styled'; | ||
| import { Key } from 'ts-key-enum'; | ||
| import { IconPlus } from 'twenty-ui'; | ||
|
|
||
| import { useLinksField } from '@/object-record/record-field/meta-types/hooks/useLinksField'; | ||
| import { FieldInputEvent } from '@/object-record/record-field/types/FieldInputEvent'; | ||
| import { LinkDisplay } from '@/ui/field/display/components/LinkDisplay'; | ||
| import { LightIconButton } from '@/ui/input/button/components/LightIconButton'; | ||
| import { DropdownMenu } from '@/ui/layout/dropdown/components/DropdownMenu'; | ||
| import { DropdownMenuInput } from '@/ui/layout/dropdown/components/DropdownMenuInput'; | ||
| import { DropdownMenuItemsContainer } from '@/ui/layout/dropdown/components/DropdownMenuItemsContainer'; | ||
| import { DropdownMenuSeparator } from '@/ui/layout/dropdown/components/DropdownMenuSeparator'; | ||
| import { MenuItem } from '@/ui/navigation/menu-item/components/MenuItem'; | ||
| import { useScopedHotkeys } from '@/ui/utilities/hotkey/hooks/useScopedHotkeys'; | ||
| import { useListenClickOutside } from '@/ui/utilities/pointer-event/hooks/useListenClickOutside'; | ||
| import { isDefined } from '~/utils/isDefined'; | ||
|
|
||
| const StyledDropdownMenu = styled(DropdownMenu)` | ||
| left: -1px; | ||
| position: absolute; | ||
| top: -1px; | ||
| `; | ||
|
|
||
| export type LinksFieldInputProps = { | ||
| onCancel?: () => void; | ||
| onSubmit?: FieldInputEvent; | ||
| }; | ||
|
|
||
| export const LinksFieldInput = ({ | ||
| onCancel, | ||
| onSubmit, | ||
| }: LinksFieldInputProps) => { | ||
| const { persistLinksField, hotkeyScope, fieldValue } = useLinksField(); | ||
|
|
||
| const containerRef = useRef<HTMLDivElement>(null); | ||
|
|
||
| const links = useMemo( | ||
| () => | ||
| [ | ||
| fieldValue.primaryLinkUrl | ||
| ? { | ||
| url: fieldValue.primaryLinkUrl, | ||
| label: fieldValue.primaryLinkLabel, | ||
| } | ||
| : null, | ||
| ...(fieldValue.secondaryLinks ?? []), | ||
| ].filter(isDefined), | ||
| [ | ||
| fieldValue.primaryLinkLabel, | ||
| fieldValue.primaryLinkUrl, | ||
| fieldValue.secondaryLinks, | ||
| ], | ||
| ); | ||
|
|
||
| useListenClickOutside({ | ||
| refs: [containerRef], | ||
| callback: (event) => { | ||
| event.stopImmediatePropagation(); | ||
|
|
||
| const isTargetInput = | ||
| event.target instanceof HTMLInputElement && | ||
| event.target.tagName === 'INPUT'; | ||
|
|
||
| if (!isTargetInput) { | ||
| onCancel?.(); | ||
| } | ||
| }, | ||
| }); | ||
|
|
||
| const [isInputDisplayed, setIsInputDisplayed] = useState(false); | ||
| const [inputValue, setInputValue] = useState(''); | ||
|
|
||
| useScopedHotkeys(Key.Escape, onCancel ?? (() => {}), hotkeyScope); | ||
|
|
||
| const handleSubmit = () => { | ||
| if (!inputValue) return; | ||
|
|
||
| setIsInputDisplayed(false); | ||
| setInputValue(''); | ||
|
|
||
| if (!links.length) { | ||
| onSubmit?.(() => | ||
| persistLinksField({ | ||
| primaryLinkUrl: inputValue, | ||
| primaryLinkLabel: '', | ||
| secondaryLinks: [], | ||
| }), | ||
| ); | ||
|
|
||
| return; | ||
| } | ||
|
|
||
| onSubmit?.(() => | ||
| persistLinksField({ | ||
| ...fieldValue, | ||
| secondaryLinks: [ | ||
| ...(fieldValue.secondaryLinks ?? []), | ||
| { label: '', url: inputValue }, | ||
| ], | ||
| }), | ||
| ); | ||
| }; | ||
|
|
||
| return ( | ||
| <StyledDropdownMenu ref={containerRef} width={200}> | ||
| {!!links.length && ( | ||
| <> | ||
| <DropdownMenuItemsContainer> | ||
| {links.map(({ label, url }, index) => ( | ||
| <MenuItem | ||
| key={index} | ||
| text={<LinkDisplay value={{ label, url }} />} | ||
| /> | ||
| ))} | ||
| </DropdownMenuItemsContainer> | ||
| <DropdownMenuSeparator /> | ||
| </> | ||
| )} | ||
| {isInputDisplayed ? ( | ||
| <DropdownMenuInput | ||
|
There was a problem hiding this comment. Why are we breaking the explicit pattern that was here previously and that makes all our input consistent ? It makes it hard to understand why we're passing inline callbacks instead of explicit handlers. There was a problem hiding this comment. What is the pattern that should be followed? I followed There was a problem hiding this comment. I checked with Charles, the UX decision is to not use onCancel even if click outside or escape. So here we want to have every event using this onSubmit. Thus draft value is useless here, but we should keep the onSubmit FieldInputEvent like the other Fields to be consistent. |
||
| autoFocus | ||
| placeholder="URL" | ||
| value={inputValue} | ||
| hotkeyScope={hotkeyScope} | ||
| onChange={(event) => setInputValue(event.target.value)} | ||
| onEnter={handleSubmit} | ||
| rightComponent={ | ||
| <LightIconButton Icon={IconPlus} onClick={handleSubmit} /> | ||
| } | ||
| /> | ||
| ) : ( | ||
| <DropdownMenuItemsContainer> | ||
| <MenuItem | ||
| onClick={() => setIsInputDisplayed(true)} | ||
| LeftIcon={IconPlus} | ||
| text="Add link" | ||
| /> | ||
| </DropdownMenuItemsContainer> | ||
| )} | ||
| </StyledDropdownMenu> | ||
| ); | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't we lift the events here, at least onSubmit, and modify draft values in the dropdown while it's open ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated the component and now it uses
onSubmit. About draft values, how should we use it? Links are persisted on submit so I am not sure if the draft value is needed?