Component

WIP

This documentation is currently under development.

Some people think React is the V of MVC, which is a good argument; however, it doesn't make sense to us, as we don't want to have components attached, but we still want to have access to the data. So React is the MVC's C, and V. Dan Abramov describes the division as smart, dumb components..

Such a component would be rejected in the code review for having a concern for presentation and data:

// ProductList.tsx
import React from 'react'
import {
  ProductListQuery,
  ProductListQueryQuery,
  ProductListQueryQueryVariables,
} from './__generated__/useAsyncProductQuery.graphql'
import { useQuery } from './useQuery'

export const ProductList = () => {
  const [productSelected, setProductSelected] = useState('product 1')
  const onSelect = ({ name }) => setSelected(name)
  const { data } = useQuery<
    ProductListQueryQuery,
    ProductListQueryQueryVariables
  >({
    ...ProductListQuery,
    variables: {},
    suspense: false,
  })

  return (
    <ul
      style={{
        listStyle: 'none',
        margin: 0,
        padding: 0,
      }}
    >
      {data.productList.map((product) => (
        <li
          key={product.name}
          onClick={() => setProductSelected(product.name)}
          style={
            productSelected === product.name
              ? { color: 'blue', cursor: 'pointer' }
              : { cursor: 'pointer' }
          }
        >
          {product.name}
        </li>
      ))}
    </ul>
  )
}

Refactoring

Components must be composable and should have a single responsibility (SRP) to help achieve separation (SOC). In our example, there are several responsibilities/concerns: searching for data and rendering different UI states. Our component should be divided into parts:

The first is like a traditional component, concerned only with the presentation;
The second is responsible for data fetching and state control;
And finally the third one, which is responsible for rendering the related display component.

// ProductList.tsx
import React, { FC } from 'react'
import { Box } from '@faststore/ui'

interface Product {
  name: string
}

interface Props {
  data: Product[]
  productSelected: string
  onSelect: () => void
  variant?: string
}

const ProductList: FC<Props> = ({
  data,
  productSelected,
  onSelect = () => null,
  variant,
}) => {
  const customVariant = variant ? `${variant}.productList` : 'productList'

  return (
    <Box as="ul" variant={customVariant}>
      {data.map((product) => (
        <Box
          as="li"
          key={product.name}
          onClick={() => onSelect(product)}
          variant={`${customVariant}.item`}
          className={productSelected === product.name ? 'active' : ''}
        >
          {product.name}
        </Box>
      ))}
    </Box>
  )
}

export default ProductList

// useProductList.tsx
import React from 'react'
import {
  ProductListQuery,
  ProductListQueryQuery,
  ProductListQueryQueryVariables,
} from './__generated__/useAsyncProductQuery.graphql'
import { useQuery } from './useQuery'
import ProductList from './ProudctList'

export const useProductList = () => {
  const { data } = useQuery<
    ProductListQueryQuery,
    ProductListQueryQueryVariables
  >({
    ...ProductListQuery,
    variables: {},
    suspense: false,
  })
  const [productSelected, setSelected] = useState('')
  const onSelect = ({ name }) => setSelected(name)

  return {
    data: data.productList,
    productSelected,
    onSelect,
  }
}

// ProductListContainer.tsx
import React, { FC } from 'react'
import ProductList from './ProductList'
import useProductList from './useProductList'

interface Props {
  variant?: string
}

const ProductListContainer: FC<Props> = ({ variant }) => {
  const productList = useProductList()

  return <ProductList {...productList} variant={variant} />
}

export default ProductListContainer

Architecture

The 3 files must be in the components folder like this:

ProductList.tsx - Component
ProductListContainer.tsx - Container
useProductList.tsx - Custom Hook

Styling

Note that the ProductList.tsx file after being refactored now receives a prop called variant. This in turn is responsible for styling using Theme-UI Variants. The theme file would look like this:

// example theme with variants
{
  productList: {
    listStyle: 'none',
    margin: 0,
    padding: 0,

    item: {
      color: 'black',

      '&.active': {
        color: 'blue'
      }
    }
  }
}

Component

WIP

Refactoring​

Architecture​

Styling​

Links​

Refactoring

Architecture

Styling

Links