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

Jump to bottom

MBS-12715, MBS-13526: ArtistCreditEditor refactor #3113

Merged
merged 3 commits into from
Mar 27, 2024
Merged

MBS-12715, MBS-13526: ArtistCreditEditor refactor #3113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e7c999
Autocomplete2: Remove '-input' from id
mwiencek Nov 30, 2023
916e971
MBS-12715, MBS-13526: ArtistCreditEditor refactor
mwiencek Jun 14, 2020
8cef6e9
Autocomplete2: Adjust search icon positioning
mwiencek Mar 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions root/static/images/attribution.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Images:
icons/delete.png
icons/information.png
icons/tick.png (recolored to gold by CatQuest)
icons/arrow_undo.png

----------------------------------------------------------------------------

Expand Down
Binary file added root/static/images/icons/arrow_undo.png
View file
Open in desktop
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 14 additions & 8 deletions root/static/scripts/common/components/Autocomplete2.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,6 +158,7 @@ type InitialStateT<T: EntityItemT> = {
+inputClass?: string,
+inputRef?: {-current: HTMLInputElement | null},
+inputValue?: string,
+isLookupPerformed?: boolean,
+labelStyle?: {...},
+placeholder?: string,
+recentItemsKey?: string,
Expand Down Expand Up @@ -321,7 +322,7 @@ const Autocomplete2 = (React.memo(<T: EntityItemT>(
disabled = false,
entityType,
highlightedIndex,
id,
id: inputId,
inputChangeHook,
inputRef: externalInputRef,
inputValue,
Expand Down Expand Up @@ -616,12 +617,11 @@ const Autocomplete2 = (React.memo(<T: EntityItemT>(
);

const activeDescendant = highlightedItem
? `${id}-item-${highlightedItem.id}`
? `${inputId}-item-${highlightedItem.id}`
: null;
const inputId = `${id}-input`;
const labelId = `${id}-label`;
const menuId = `${id}-menu`;
const statusId = `${id}-status`;
const labelId = `${inputId}-label`;
const menuId = `${inputId}-menu`;
const statusId = `${inputId}-status`;

useOutsideClickEffect(
containerRef,
Expand Down Expand Up @@ -703,7 +703,7 @@ const Autocomplete2 = (React.memo(<T: EntityItemT>(
const menuItemElements = React.useMemo(
() => items.map((item, index) => (
<AutocompleteItem
autocompleteId={id}
autocompleteId={inputId}
dispatch={dispatch}
formatOptions={
(
Expand All @@ -730,7 +730,7 @@ const Autocomplete2 = (React.memo(<T: EntityItemT>(
dispatch,
entityType,
highlightedItem,
id,
inputId,
items,
selectItem,
selectedItem,
Expand Down Expand Up @@ -879,3 +879,9 @@ const Autocomplete2 = (React.memo(<T: EntityItemT>(
}): React$AbstractComponent<PropsT<any>, void>);

export default Autocomplete2;

// XXX Until Flow supports https://github.com/facebook/flow/issues/7672
export const ArtistAutocomplete:
React$AbstractComponent<PropsT<ArtistT>, void> =
// $FlowIgnore[unclear-type]
(Autocomplete2: any);
2 changes: 1 addition & 1 deletion root/static/scripts/common/components/ButtonPopover.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ const ButtonPopover = (props: PropsT): React$MixedElement => {
</ErrorBoundary>
<FloatingArrow
context={context}
fill="white"
fill="currentColor"
height={12}
ref={arrowRef}
stroke="#AAA"
Expand Down
4 changes: 3 additions & 1 deletion root/static/scripts/common/components/DescriptiveLink.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

import ko from 'knockout';

import type {ReleaseEditorTrackT} from '../../release-editor/types.js';

import AreaWithContainmentLink from './AreaWithContainmentLink.js';
import ArtistCreditLink from './ArtistCreditLink.js';
import EntityLink from './EntityLink.js';
Expand All @@ -20,7 +22,7 @@ type DescriptiveLinkProps = {
+customArtistCredit?: ArtistCreditT,
+deletedCaption?: string,
+disableLink?: boolean,
+entity: CollectionT | RelatableEntityT,
+entity: CollectionT | RelatableEntityT | TrackT | ReleaseEditorTrackT,
+showDeletedArtists?: boolean,
+showDisambiguation?: boolean,
+showEditsPending?: boolean,
Expand Down
23 changes: 17 additions & 6 deletions root/static/scripts/common/components/EntityLink.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import * as Sentry from '@sentry/browser';
import ko from 'knockout';
import * as React from 'react';

import type {ReleaseEditorTrackT} from '../../release-editor/types.js';
import isGreyedOut from '../../url/utility/isGreyedOut.js';
import localizeAreaName from '../i18n/localizeAreaName.js';
import localizeInstrumentName from '../i18n/localizeInstrumentName.js';
Expand Down Expand Up @@ -67,6 +68,7 @@ const iconClassPicker = {
release: 'releaselink',
release_group: 'rglink',
series: 'serieslink',
track: null,
url: null,
work: 'worklink',
};
Expand Down Expand Up @@ -151,7 +153,12 @@ type EntityLinkProps = {
+content?: ?Expand2ReactOutput,
+deletedCaption?: string,
+disableLink?: boolean,
+entity: RelatableEntityT | CollectionT | LinkTypeT,
+entity:
| RelatableEntityT
| CollectionT
| LinkTypeT
| TrackT
| ReleaseEditorTrackT,
+hover?: string,
+nameVariation?: boolean,
+showCaaPresence?: boolean,
Expand Down Expand Up @@ -189,8 +196,10 @@ const EntityLink = ({
}: EntityLinkProps):
$ReadOnlyArray<Expand2ReactOutput> | Expand2ReactOutput | null => {
const hasCustomContent = nonEmpty(passedContent);
// $FlowIgnore[sketchy-null-mixed]
reosarevok marked this conversation as resolved.
Show resolved Hide resolved
const hasEditsPending = entity.editsPending || false;
const hasSubPath = nonEmpty(subPath);
// $FlowIgnore[prop-missing]
const comment = nonEmpty(entity.comment) ? ko.unwrap(entity.comment) : '';

let content = passedContent;
Expand Down Expand Up @@ -224,15 +233,17 @@ $ReadOnlyArray<Expand2ReactOutput> | Expand2ReactOutput | null => {
: hover + ' ' + bracketedText(comment);
}

const entityName = ko.unwrap(entity.name);

if (entity.entityType === 'area') {
content = empty(content) ? localizeAreaName(entity) : content;
} else if (entity.entityType === 'instrument') {
content = empty(content) ? localizeInstrumentName(entity) : content;
} else if (entity.entityType === 'link_type') {
content = empty(content) ? l_relationships(entity.name) : content;
content = empty(content) ? l_relationships(entityName) : content;
}

content = empty(content) ? ko.unwrap(entity.name) : content;
content = empty(content) ? entityName : content;

if (!ko.unwrap(entity.gid)) {
if (entity.entityType === 'url') {
Expand Down Expand Up @@ -262,17 +273,17 @@ $ReadOnlyArray<Expand2ReactOutput> | Expand2ReactOutput | null => {
// URLs are kind of weird and we probably don't care to set this for them
if (!hasSubPath && entity.entityType !== 'url') {
if (nameVariation === undefined && typeof content === 'string') {
nameVariation = content !== entity.name;
nameVariation = content !== entityName;
}

if (nameVariation === true) {
if (nonEmpty(hover)) {
hover = texp.l('{name} – {additional_info}', {
additional_info: hover,
name: entity.name,
name: entityName,
});
} else {
hover = ko.unwrap(entity.name);
hover = entityName;
}
}
}
Expand Down
5 changes: 3 additions & 2 deletions root/static/scripts/common/utility/entityHref.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ type LinkableEntity =
| {+entityType: 'iswc', +iswc: string, ...}
| {+entityType: RelatableEntityTypeT, +gid: string, ...}
| {+entityType: 'collection', +gid: string, ...}
| {+entityType: 'link_type', +gid: string, ...};
| {+entityType: 'link_type', +gid: string, ...}
| {+entityType: 'track', +gid?: string, ...};

function generateHref(
path: string,
Expand Down Expand Up @@ -87,7 +88,7 @@ function entityHref(
break;

default:
if (entityProps.mbid && entity.gid) {
if (entityProps.mbid && nonEmpty(entity.gid)) {
Copy link
Member

Choose a reason for hiding this comment

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

How does nonEmpty work on knockout observables? Would it always see it as non-empty even if the T in Observable<T> is ''?

Copy link
Member Author

Choose a reason for hiding this comment

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

It would always see it as non-empty, yes. But the nonEmpty call was mainly added to work around a sketchy-null error from Flow. If the unwrapped gid is empty, entityHref will return a nonsense result either way (because id will just remain an empty string).

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm guessing that's why I originally added #3113 (comment) though.

id = ko.unwrap(entity.gid);
}
}
Expand Down