react-components: support external state for grid

.changeset/dull-cherries-hang.md

@@ -0,0 +1,6 @@
+---
+'@giphy/react-components': patch
+---
+
+- Grid supports editableGifs
+- make fetchpriority lowercase to avoid runtime warning

packages/react-components/src/components/gif.tsx

@@ -277,7 +277,7 @@ const Gif = ({
                     suppressHydrationWarning
                     // @ts-ignore - fetchPriority is not recognized by React typescript
                     // eslint-disable-next-line react/no-unknown-property
-                    fetchPriority={fetchPriority}
+                    fetchpriority={fetchPriority}
                     className={[Gif.imgClassName, loadedClassname].join(' ')}
                     src={shouldShowMedia ? rendition.url : placeholder}
                     style={{ background }}

packages/react-components/src/components/grid.tsx

@@ -28,6 +28,7 @@ type Props = {
     noLink?: boolean
     noResultsMessage?: string | JSX.Element
     initialGifs?: IGif[]
+    externalGifs?: IGif[]
     useTransform?: boolean
     columnOffsets?: number[]
     backgroundColor?: string
@@ -73,14 +74,17 @@ class Grid extends PureComponent<Props, State> {
     unmounted: boolean = false
     paginator = gifPaginator(this.props.fetchGifs, this.state.gifs)
     static getDerivedStateFromProps: GetDerivedStateFromProps<Props, State> = (
-        { columns, gutter, width }: Props,
+        { columns, gutter, width, externalGifs }: Props,
         prevState: State
     ) => {
         const gutterOffset = gutter * (columns - 1)
         const gifWidth = Math.floor((width - gutterOffset) / columns)
         if (prevState.gifWidth !== gifWidth) {
             return { gifWidth }
         }
+        if (externalGifs && externalGifs !== prevState.gifs) {
+            return { gifs: externalGifs }
+        }
         return null
     }
 
@@ -100,8 +104,13 @@ class Grid extends PureComponent<Props, State> {
 
     onFetch = debounce(Grid.fetchDebounce, async () => {
         if (this.unmounted) return
-        const { isFetching, isLoaderVisible, gifs } = this.state
-        const prefetchCount = gifs.length
+        const { isFetching, isLoaderVisible } = this.state
+        const { externalGifs, fetchGifs } = this.props
+        const prefetchCount = (externalGifs || this.state.gifs).length
+        if (externalGifs) {
+            // reinitialize the paginator every fetch with the new external gifs
+            this.paginator = gifPaginator(fetchGifs, externalGifs)
+        }
         if (!isFetching && isLoaderVisible) {
             this.setState({ isFetching: true, isError: false })
             let gifs

packages/react-components/stories/grid-editable.stories.tsx

@@ -0,0 +1,119 @@
+import styled from '@emotion/styled'
+import { giphyPurple } from '@giphy/colors'
+import { GiphyFetch } from '@giphy/js-fetch-api'
+import { IGif } from '@giphy/js-types'
+import { Meta, StoryObj } from '@storybook/react'
+import fetchMock from 'fetch-mock'
+import React, { useEffect, useState } from 'react'
+import { throttle } from 'throttle-debounce'
+import { GifOverlayProps, Grid as GridComponent } from '../src'
+import inTestsRunner from './in-tests-runner'
+import mockGifsResult from './mock-data/gifs.json'
+
+const apiKey = 'sXpGFDGZs0Dv1mmNFvYaGUvYwKX0PWIh'
+const gf = new GiphyFetch(apiKey)
+
+const OverlayContainer = styled.div`
+    position: absolute;
+    left: 0;
+    top: 0;
+    right: 0;
+    bottom: 0;
+    display: flex;
+    color: white;
+    justify-content: center;
+    align-items: center;
+`
+const ButtonContainer = styled.div`
+    display: flex;
+    flex-direction: column;
+    gap: 2px;
+    align-items: center;
+    h4 {
+        text-align: center;
+    }
+`
+const Button = styled.div`
+    cursor: pointer;
+    background: ${giphyPurple};
+    padding: 6px;
+    border-radius: 4px;
+    max-width: fit-content;
+`
+
+type GridProps = Partial<React.ComponentProps<typeof GridComponent>>
+
+const Grid = ({ loader, ...other }: GridProps) => {
+    const [width, setWidth] = useState(innerWidth - 24)
+    const [externalGifs, setExternalGifs] = useState<IGif[] | undefined>()
+    const Overlay = ({ gif, isHovered }: GifOverlayProps) => (
+        <OverlayContainer>
+            {isHovered && (
+                <ButtonContainer>
+                    <h4>{gif.title}</h4>
+                    <Button
+                        onClick={() => {
+                            setExternalGifs(externalGifs?.filter((g) => g.id !== gif.id))
+                        }}
+                    >
+                        Delete Me
+                    </Button>
+                    <Button
+                        onClick={() => {
+                            const result = prompt('Edit Title', gif.title) || 'New Title'
+                            if (externalGifs) {
+                                const editGif = externalGifs?.find((g) => g.id === gif.id)
+                                if (editGif) {
+                                    editGif.title = result
+                                    setExternalGifs([...externalGifs])
+                                }
+                            }
+                        }}
+                    >
+                        Edit Title
+                    </Button>
+                </ButtonContainer>
+            )}
+        </OverlayContainer>
+    )
+    const onResize = throttle(500, () => setWidth(innerWidth - 24))
+    useEffect(() => {
+        window.addEventListener('resize', onResize, false)
+        return () => window.removeEventListener('resize', onResize, false)
+        // eslint-disable-next-line react-hooks/exhaustive-deps
+    }, [])
+
+    const fetchGifs = async (offset: number) => {
+        if (inTestsRunner()) {
+            fetchMock.restore().getOnce(`begin:https://api.giphy.com/v1/gifs/search`, { body: mockGifsResult })
+        }
+        const result = await gf.trending({ offset, limit: 10 })
+        fetchMock.restore()
+        setExternalGifs(result.data)
+        return result
+    }
+    return (
+        <GridComponent
+            width={width}
+            noLink
+            columns={3}
+            loader={loader}
+            externalGifs={externalGifs}
+            fetchGifs={fetchGifs}
+            overlay={Overlay}
+            onGifsFetched={(gifs) => setExternalGifs(gifs)}
+            {...other}
+        />
+    )
+}
+
+const meta: Meta<typeof Grid> = {
+    component: Grid,
+    title: 'React Components/Grid/Editable',
+}
+
+export default meta
+
+type Story = StoryObj<typeof meta>
+
+export const EditableGrid: Story = {}