Merge pull request 'feat: add multilingualism (#35)' (#39) from feature/i18next-multilingualism into main

Reviewed-on: #39
Reviewed-by: Primakov Alexandr Alexandrovich <primakovpro@gmail.com>

locales/en.json

@@ -13,5 +13,41 @@
   "dry-wash.landing.hero-section.headline": "Revitalize Your Ride with Eco-Friendly Care!",
   "dry-wash.landing.make-order-button": "Make order",
   "dry-wash.landing.site-logo": "The logo of the \"Dry Master\" company",
-  "dry-wash.landing.social-proof-section.heading": "We are being chosen"
+  "dry-wash.landing.social-proof-section.heading": "We are being chosen",
+  "dry-wash.arm.master.add": "Add",
+  "dry-wash.arm.order.title": "Orders",
+  "dry-wash.arm.order.status.progress": "In Progress",
+  "dry-wash.arm.order.status.complete": "Completed",
+  "dry-wash.arm.order.status.pending": "Pending",
+  "dry-wash.arm.order.status.working": "Working",
+  "dry-wash.arm.order.status.canceled": "Canceled",
+  "dry-wash.arm.order.status.placeholder": "Select Status",
+  "dry-wash.arm.order.table.header.carNumber": "Car Number",
+  "dry-wash.arm.order.table.header.washingTime": "Washing Time",
+  "dry-wash.arm.order.table.header.orderDate": "Order Date",
+  "dry-wash.arm.order.table.header.status": "Status",
+  "dry-wash.arm.order.table.header.telephone": "Telephone",
+  "dry-wash.arm.order.table.header.location": "Location",
+  "dry-wash.arm.master.title": "Masters",
+  "dry-wash.arm.master.table.header.name": "Name",
+  "dry-wash.arm.master.table.header.currentJob": "Current Job",
+  "dry-wash.arm.master.table.header.phone": "Phone",
+  "dry-wash.arm.master.table.header.actions": "Actions",
+  "dry-wash.arm.master.table.actionsMenu.delete": "Delete Master",
+  "dry-wash.arm.master.drawer.title": "Add New Master",
+  "dry-wash.arm.master.drawer.inputName.label": "Full Name",
+  "dry-wash.arm.master.drawer.inputName.placeholder": "Enter Full Name",
+  "dry-wash.arm.master.drawer.inputPhone.label": "Phone Number",
+  "dry-wash.arm.master.drawer.inputPhone.placeholder": "Enter Phone Number",
+  "dry-wash.arm.master.drawer.button.save": "Save",
+  "dry-wash.arm.master.drawer.button.cancel": "Cancel",
+  "dry-wash.arm.master.sideBar.orders": "Orders",
+  "dry-wash.arm.master.sideBar.master": "Masters",
+  "dry-wash.arm.master.sideBar.title": "Dry Master",
+  "dry-wash.notFound.title": "Page Not Found",
+  "dry-wash.notFound.description": "Unfortunately, the page you are looking for does not exist.",
+  "dry-wash.notFound.button.back": "Back to Home",
+  "dry-wash.errorBoundary.title": "Something went wrong",
+  "dry-wash.errorBoundary.description": "We are already working on fixing the issue",
+  "dry-wash.errorBoundary.button.reload": "Reload Page"
 }

locales/ru.json

@@ -3,7 +3,7 @@
   "dry-wash.arm.order.title": "Заказы",
   "dry-wash.arm.order.status.progress": "Выполняется",
   "dry-wash.arm.order.status.complete": "Завершено",
-  "dry-wash.arm.order.status.pending": "в ожидании",
+  "dry-wash.arm.order.status.pending": "В ожидании",
   "dry-wash.arm.order.status.working": "В работе",
   "dry-wash.arm.order.status.canceled": "Отменено",
   "dry-wash.arm.order.status.placeholder": "Выберите статус",
@@ -26,9 +26,9 @@
   "dry-wash.arm.master.drawer.inputPhone.placeholder": "Введите номер телефона",
   "dry-wash.arm.master.drawer.button.save": "Сохранить",
   "dry-wash.arm.master.drawer.button.cancel": "Отменить",
+  "dry-wash.arm.master.sideBar.orders": "Заказы",
+  "dry-wash.arm.master.sideBar.master": "Мастера",
   "dry-wash.arm.master.sideBar.title": "Сухой мастер",
-  "dry-wash.arm.master.sideBar.title.master": "Мастера",
-  "dry-wash.arm.master.sideBar.title.orders": "Заказы",
   "dry-wash.landing.benefits-section.description": "Откройте для себя преимущества наших услуг по химчистке автомобилей",
   "dry-wash.landing.benefits-section.heading": "Преимущества экологичной автомойки",
   "dry-wash.landing.benefits-section.list.0": "Экологически безопасные продукты",

src/components/ErrorBoundary/ErrorBoundary.tsx

@@ -34,15 +34,16 @@ class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
   render() {
     const { hasError } = this.state;
     //TODO: добавить анимацию после залива 404 страницы
+    //TODO: может сделать обертку для хука, чтоб язык менялся без перезагрузки
     if (hasError) {
       return (
         <Center minH='100vh'>
           <VStack spacing={4} textAlign='center'>
             <Heading as='h1' size='2xl'>
-              {i18next.t('dry-wash.errorBoundary.title')}
+              {i18next.t('~:dry-wash.errorBoundary.title')}
             </Heading>
             <Text fontSize='lg'>
-              {i18next.t('dry-wash.errorBoundary.description')}
+              {i18next.t('~:dry-wash.errorBoundary.description')}
             </Text>
             <Button
               colorScheme='teal'
@@ -50,7 +51,7 @@ class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
               variant='outline'
               onClick={() => window.location.reload()}
             >
-              {i18next.t('dry-wash.errorBoundary.button.reload')}
+              {i18next.t('~:dry-wash.errorBoundary.button.reload')}
             </Button>
           </VStack>
         </Center>

src/components/MasterActionsMenu/MasterActionsMenu.tsx

@@ -7,16 +7,18 @@ import {
   IconButton,
 } from '@chakra-ui/react';
 import { EditIcon } from '@chakra-ui/icons';
-import i18next from 'i18next';
+import { useTranslation } from 'react-i18next';
 
 const MasterActionsMenu = () => {
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.master.table.actionsMenu',
+  });
+
   return (
     <Menu>
       <MenuButton icon={<EditIcon />} as={IconButton} variant='outline' />
       <MenuList>
-        <MenuItem>
+        <MenuItem>{t('delete')}</MenuItem>
-          {i18next.t('dry-wash.arm.master.table.actionsMenu.delete')}
-        </MenuItem>
       </MenuList>
     </Menu>
   );

src/components/MasterDrawer/MasterDrawer.tsx

@@ -12,7 +12,7 @@ import {
   DrawerHeader,
   DrawerOverlay,
 } from '@chakra-ui/react';
-import i18next from 'i18next';
+import { useTranslation } from 'react-i18next';
 
 const MasterDrawer = ({ isOpen, onClose }) => {
   const [newMaster, setNewMaster] = useState({ name: '', phone: '' });
@@ -22,51 +22,44 @@ const MasterDrawer = ({ isOpen, onClose }) => {
     onClose();
   };
 
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.master.drawer',
+  });
+
   return (
     <Drawer isOpen={isOpen} onClose={onClose} size='md'>
       <DrawerOverlay />
       <DrawerContent>
         <DrawerCloseButton />
-        <DrawerHeader>
+        <DrawerHeader>{t('title')}</DrawerHeader>
-          {i18next.t('dry-wash.arm.master.drawer.title')}
-        </DrawerHeader>
         <DrawerBody>
           <FormControl mb='4'>
-            <FormLabel>
+            <FormLabel>{t('inputName.label')}</FormLabel>
-              {i18next.t('dry-wash.arm.master.drawer.inputName.label')}
-            </FormLabel>
             <Input
               value={newMaster.name}
               onChange={(e) =>
                 setNewMaster({ ...newMaster, name: e.target.value })
               }
-              placeholder={i18next.t(
+              placeholder={t('inputName.placeholder')}
-                'dry-wash.arm.master.drawer.inputName.placeholder',
-              )}
             />
           </FormControl>
           <FormControl>
-            <FormLabel>
+            <FormLabel> {t('inputPhone.label')}</FormLabel>
-              {' '}
-              {i18next.t('dry-wash.arm.master.drawer.inputPhone.label')}
-            </FormLabel>
             <Input
               value={newMaster.phone}
               onChange={(e) =>
                 setNewMaster({ ...newMaster, phone: e.target.value })
               }
-              placeholder={i18next.t(
+              placeholder={t('inputPhone.placeholder')}
-                'dry-wash.arm.master.drawer.inputPhone.placeholder',
-              )}
             />
           </FormControl>
         </DrawerBody>
         <DrawerFooter>
           <Button colorScheme='teal' mr={3} onClick={handleSave}>
-            {i18next.t('dry-wash.arm.master.drawer.button.save')}
+            {t('button.save')}
           </Button>
           <Button variant='ghost' onClick={onClose}>
-            {i18next.t('dry-wash.arm.master.drawer.button.cancel')}
+            {t('button.cancel')}
           </Button>
         </DrawerFooter>
       </DrawerContent>

src/components/Masters/Masters.tsx

@@ -11,32 +11,39 @@ import {
   useDisclosure,
   Flex,
 } from '@chakra-ui/react';
-import i18next from 'i18next';
+import { useTranslation } from 'react-i18next';
 
 import { mastersData } from '../../mocks';
 import MasterItem from '../MasterItem';
 import MasterDrawer from '../MasterDrawer';
 
-const TABLE_HEADERS = ['name', 'currentJob', 'phone', 'actions'];
+const TABLE_HEADERS = [
+  'name' as const,
+  'currentJob' as const,
+  'phone' as const,
+  'actions' as const,
+];
 
 const Masters = () => {
   const { isOpen, onOpen, onClose } = useDisclosure();
 
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.master',
+  });
+
   return (
     <Box p='8'>
       <Flex justifyContent='space-between' alignItems='center' mb='5'>
-        <Heading size='lg'> {i18next.t('dry-wash.arm.master.title')}</Heading>
+        <Heading size='lg'> {t('title')}</Heading>
         <Button colorScheme='green' onClick={onOpen}>
-          + {i18next.t('dry-wash.arm.master.add')}
+          + {t('add')}
         </Button>
       </Flex>
       <Table variant='simple' colorScheme='blackAlpha'>
         <Thead>
           <Tr>
             {TABLE_HEADERS.map((name) => (
-              <Th key={name}>
+              <Th key={name}>{t(`table.header.${name}`)}</Th>
-                {i18next.t(`dry-wash.arm.master.table.header.${name}`)}
-              </Th>
             ))}
           </Tr>
         </Thead>

src/components/OrderItem/OrderItem.tsx

@@ -1,8 +1,26 @@
 import React, { useState } from 'react';
 import { Td, Tr, Link, Select } from '@chakra-ui/react';
-import i18next from 'i18next';
+import { useTranslation } from 'react-i18next';
 
-const statuses = ['pending', 'progress', 'working', 'canceled', 'complete'];
+const statuses = [
+  'pending' as const,
+  'progress' as const,
+  'working' as const,
+  'canceled' as const,
+  'complete' as const,
+];
+
+type GetArrItemType<ArrType> =
+  ArrType extends Array<infer ItemType> ? ItemType : never;
+
+export type OrderProps = {
+  carNumber?: string;
+  washTime?: string;
+  orderDate?: string;
+  status?: GetArrItemType<typeof statuses>;
+  phone?: string;
+  location?: string;
+};
 
 const OrderItem = ({
   carNumber,
@@ -11,7 +29,11 @@ const OrderItem = ({
   status,
   phone,
   location,
-}) => {
+}: OrderProps) => {
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.order',
+  });
+
   const [statusSelect, setStatus] = useState(status);
 
   return (
@@ -22,12 +44,12 @@ const OrderItem = ({
       <Td>
         <Select
           value={statusSelect}
-          onChange={(e) => setStatus(e.target.value)}
+          onChange={(e) => setStatus(e.target.value as OrderProps['status'])}
-          placeholder={i18next.t(`dry-wash.arm.order.status.placeholder`)}
+          placeholder={t(`status.placeholder`)}
         >
           {statuses.map((status) => (
             <option key={status} value={status}>
-              {i18next.t(`dry-wash.arm.order.status.${status}`)}
+              {t(`status.${status}`)}
             </option>
           ))}
         </Select>

src/components/Orders/Orders.tsx

@@ -1,36 +1,45 @@
-import { Box, Heading, Table, Thead, Tbody, Tr, Th } from '@chakra-ui/react';
 import React from 'react';
-import i18next from 'i18next';
+import { Box, Heading, Table, Thead, Tbody, Tr, Th } from '@chakra-ui/react';
+import { useTranslation } from 'react-i18next';
 
 import { ordersData } from '../../mocks';
 import OrderItem from '../OrderItem';
+import { OrderProps } from '../OrderItem/OrderItem';
+
 const Orders = () => {
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.order',
+  });
+
   const TABLE_HEADERS = [
-    'carNumber',
+    'carNumber' as const,
-    'washingTime',
+    'washingTime' as const,
-    'orderDate',
+    'orderDate' as const,
-    'status',
+    'status' as const,
-    'telephone',
+    'telephone' as const,
-    'location',
+    'location' as const,
   ];
+
   return (
     <Box p='8'>
       <Heading size='lg' mb='5'>
-        {i18next.t('dry-wash.arm.order.title')}
+        {t('title')}
       </Heading>
       <Table variant='simple' colorScheme='blackAlpha'>
         <Thead>
           <Tr>
             {TABLE_HEADERS.map((name, key) => (
-              <Th key={key}>
+              <Th key={key}>{t(`table.header.${name}`)}</Th>
-                {i18next.t(`dry-wash.arm.order.table.header.${name}`)}
-              </Th>
             ))}
           </Tr>
         </Thead>
         <Tbody>
           {ordersData.map((order, index) => (
-            <OrderItem key={index} {...order} />
+            <OrderItem
+              key={index}
+              {...order}
+              status={order.status as OrderProps['status']}
+            />
           ))}
         </Tbody>
       </Table>

src/components/Sidebar/Sidebar.tsx

@@ -1,10 +1,14 @@
-import { Box, Button, Heading, VStack } from '@chakra-ui/react';
+import { Box, Button, Heading, VStack, Divider } from '@chakra-ui/react';
 import React from 'react';
-import { Divider } from '@chakra-ui/react';
-import i18next from 'i18next';
 import { Link } from 'react-router-dom';
+import { useTranslation } from 'react-i18next';
 
-const Sidebar = () => (
+const Sidebar = () => {
+  const { t } = useTranslation('~', {
+    keyPrefix: 'dry-wash.arm.master.sideBar',
+  });
+
+  return (
     <Box
       borderRight='1px solid black'
       bg='gray.50'
@@ -14,7 +18,7 @@ const Sidebar = () => (
       pt='8'
     >
       <Heading color='green' size='lg' mb='5'>
-      {i18next.t(`dry-wash.arm.master.sideBar.title`)}
+        {t('title')}
       </Heading>
 
       <VStack align='start' spacing='4'>
@@ -26,7 +30,7 @@ const Sidebar = () => (
           colorScheme='green'
           variant='ghost'
         >
-        {i18next.t(`dry-wash.arm.master.sideBar.title.orders`)}
+          {t('orders')}
         </Button>
         <Divider />
         <Button
@@ -36,11 +40,12 @@ const Sidebar = () => (
           colorScheme='green'
           variant='ghost'
         >
-        {i18next.t(`dry-wash.arm.master.sideBar.title.master`)}
+          {t('master')}
         </Button>
         <Divider />
       </VStack>
     </Box>
   );
+};
 
 export default Sidebar;

src/components/landing/CtaButton/CtaButton.tsx

@@ -15,7 +15,7 @@ export const CtaButton: FC<ButtonProps> = (props) => {
       colorScheme='primary'
       {...props}
     >
-      {t('dry-wash.landing.make-order-button')}
+      {t('~:dry-wash.landing.make-order-button')}
     </Button>
   );
 };

src/components/landing/SiteLogo/SiteLogo.tsx

@@ -7,7 +7,7 @@ import { LogoSvg } from '../../../assets/icons';
 export const SiteLogo: FC = () => {
   const { t } = useTranslation();
 
-  return <Image src={LogoSvg} alt={t('dry-wash.landing.site-logo')} w={40} />;
+  return <Image src={LogoSvg} alt={t('~:dry-wash.landing.site-logo')} w={40} />;
 };
 
 // todo: replace Image by SVG React component

src/pages/arm/index.tsx

@@ -1,4 +1,4 @@
-import React, { useState } from 'react';
+import React from 'react';
 
 import LayoutArm from '../../components/LayoutArm';