Update react-crossword and unify usage across articles and editions #13876
+623
−572
Conversation
This file contains hidden or 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
|
Size Change: -741 B (-0.08%) Total Size: 973 kB
ℹ️ View Unchanged
|
7 tasks
7 tasks
arelra
approved these changes
May 2, 2025
JamieB-gu
approved these changes
May 2, 2025
Comment on lines
-2
to
+4
| crosswords: FEEditionsCrossword[]; | ||
| }; | ||
|
|
||
| type FECrosswordEntry = { | ||
| id: string; | ||
| number: number; | ||
| humanNumber: string; | ||
| direction: 'across' | 'down'; | ||
| position: { x: number; y: number }; | ||
| separatorLocations: { | ||
| ','?: number[]; | ||
| '-'?: number[]; | ||
| }; | ||
| length: number; | ||
| clue: string; | ||
| group: string[]; | ||
| solution?: string; | ||
| format?: string; | ||
| }; | ||
|
|
||
| type FECrosswordDimensions = { | ||
| cols: number; | ||
| rows: number; | ||
| }; | ||
| import type { CAPICrossword } from '@guardian/react-crossword/dist/@types/CAPI'; | ||
|
|
||
| export type FEEditionsCrossword = { | ||
| name: string; | ||
| type: string; | ||
| number: number; | ||
| date: string; | ||
| dimensions: FECrosswordDimensions; | ||
| entries: FECrosswordEntry[]; | ||
| solutionAvailable: boolean; | ||
| hasNumbers: boolean; | ||
| randomCluesOrdering: boolean; | ||
| instructions?: string; | ||
| creator?: { name: string; webUrl: string }; | ||
| pdf?: string; | ||
| annotatedSolution?: string; | ||
| dateSolutionAvailable: string; | ||
| export type CAPICrosswords = { | ||
| newCrosswords: CAPICrossword[]; |
There was a problem hiding this comment.
Non-blocking: we should probably avoid importing from this directory. In the article crossword player we have something like this to get access to this type:
import type { CrosswordProps } from '@guardian/react-crossword';
type CAPICrossword = CrosswordProps['data'];| pdf?: string; | ||
| annotatedSolution?: string; | ||
| dateSolutionAvailable: string; | ||
| export type CAPICrosswords = { |
There was a problem hiding this comment.
Non-blocking: we should probably still call this FEEditionsCrosswords across the codebase for consistency.
| @@ -1,14 +1,11 @@ | |||
| import Crossword from '@guardian/react-crossword'; | |||
| import { Crossword } from '@guardian/react-crossword'; | |||
| import type { CAPICrossword } from '@guardian/react-crossword/dist/@types/CAPI'; | |||
There was a problem hiding this comment.
Non-blocking: we should probably avoid importing from this directory. In the article crossword player we have something like this to get access to this type:
import type { CrosswordProps } from '@guardian/react-crossword';
type CAPICrossword = CrosswordProps['data'];| @@ -1,14 +1,7 @@ | |||
| /* eslint-disable ssr-friendly/no-dom-globals-in-module-scope */ | |||
| // @ts-expect-error: Cannot find module | |||
| import css from '@guardian/react-crossword/lib/index.css'; | |||
| import type { CAPICrossword } from '@guardian/react-crossword/dist/@types/CAPI'; | |||
There was a problem hiding this comment.
Non-blocking: we should probably avoid importing from this directory. In the article crossword player we have something like this to get access to this type:
import type { CrosswordProps } from '@guardian/react-crossword';
type CAPICrossword = CrosswordProps['data'];| @@ -1,8 +1,8 @@ | |||
| import type { FEEditionsCrossword } from '../../src/types/editionsCrossword'; | |||
| import type { CAPICrossword } from '@guardian/react-crossword/dist/@types/CAPI'; | |||
There was a problem hiding this comment.
Non-blocking: we should probably avoid importing from this directory. In the article crossword player we have something like this to get access to this type:
import type { CrosswordProps } from '@guardian/react-crossword';
type CAPICrossword = CrosswordProps['data'];|
Seen on PROD (merged by @DanielCliftonGuardian 7 minutes and 50 seconds ago) Please check your changes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this change?
Updates the react-crossword dependency to the latest version. This change standardises the usage of the module for both crossword articles and editions, leveraging the latest features and fixes.
This change relies on an update to the editions crossword data model guardian/frontend#27943
Why?
Resolves #13864
Screenshots