Feat / Injectable component wrappers

packages/ui-react/src/components/Button/Button.tsx

@@ -3,14 +3,17 @@ import classNames from 'classnames';
 import { NavLink } from 'react-router-dom';
 
 import Spinner from '../Spinner/Spinner';
+import createInjectableComponent from '../../modules/createInjectableComponent';
 
 import styles from './Button.module.scss';
 
+export const ButtonIdentifier = Symbol(`BUTTON`);
+
 type Color = 'default' | 'primary' | 'delete';
 
 type Variant = 'contained' | 'outlined' | 'text' | 'danger' | 'delete';
 
-type Props = {
+export type ButtonProps = {
   children?: React.ReactNode;
   label: string;
   active?: boolean;
@@ -31,7 +34,7 @@ type Props = {
   activeClassname?: string;
 } & React.AriaAttributes;
 
-const Button: React.FC<Props> = ({
+const Button: React.FC<ButtonProps> = ({
   label,
   children,
   color = 'default',
@@ -48,7 +51,7 @@ const Button: React.FC<Props> = ({
   className,
   activeClassname = '',
   ...rest
-}: Props) => {
+}: ButtonProps) => {
   const buttonClassName = (isActive: boolean) =>
     classNames(styles.button, className, styles[color], styles[variant], {
       [styles.active]: isActive,
@@ -82,4 +85,4 @@ const Button: React.FC<Props> = ({
     </button>
   );
 };
-export default Button;
+export default createInjectableComponent(ButtonIdentifier, Button);

packages/ui-react/src/components/Card/Card.tsx

@@ -13,13 +13,16 @@ import type { PosterAspectRatio } from '@jwp/ott-common/src/utils/collection';
 
 import Image from '../Image/Image';
 import Icon from '../Icon/Icon';
+import createInjectableComponent from '../../modules/createInjectableComponent';
 
 import styles from './Card.module.scss';
 
+export const CardIdentifier = Symbol(`CARD`);
+
 type ReplaceColon<T> = T extends `${infer Left}:${infer Right}` ? `${Left}${Right}` : T;
 type PosterAspectRatioClass = ReplaceColon<PosterAspectRatio>;
 
-type CardProps = {
+export type CardProps = {
   item: PlaylistItem;
   onHover?: () => void;
   progress?: number;
@@ -137,4 +140,4 @@ function Card({
   );
 }
 
-export default memo(Card);
+export default memo(createInjectableComponent(CardIdentifier, Card));

packages/ui-react/src/components/CardGrid/CardGrid.tsx

@@ -10,6 +10,7 @@ import useBreakpoint, { Breakpoint, type Breakpoints } from '@jwp/ott-ui-react/s
 import Card from '../Card/Card';
 import InfiniteScrollLoader from '../InfiniteScrollLoader/InfiniteScrollLoader';
 import LayoutGrid from '../LayoutGrid/LayoutGrid';
+import createInjectableComponent from '../../modules/createInjectableComponent';
 
 import styles from './CardGrid.module.scss';
 
@@ -26,7 +27,9 @@ const defaultCols: Breakpoints = {
   [Breakpoint.xl]: 5,
 };
 
-type CardGridProps = {
+export const CardGridIdentifier = Symbol(`CARD_GRID`);
+
+export type CardGridProps = {
   playlist: Playlist;
   watchHistory?: { [key: string]: number };
   isLoading: boolean;
@@ -104,4 +107,4 @@ function CardGrid({
   );
 }
 
-export default CardGrid;
+export default createInjectableComponent(CardGridIdentifier, CardGrid);

packages/ui-react/src/components/Header/Header.tsx

@@ -1,17 +1,21 @@
-import React, { type PropsWithChildren } from 'react';
+import { type PropsWithChildren } from 'react';
 import classNames from 'classnames';
 
+import createInjectableComponent from '../../modules/createInjectableComponent';
+
 import styles from './Header.module.scss';
 
+export const HeaderIdentifier = Symbol(`HEADER`);
+
 type TypeHeader = 'static' | 'fixed';
 
-type Props = {
+export type HeaderProps = {
   headerType?: TypeHeader;
   className?: string;
   searchActive: boolean;
 };
 
-const Header = ({ children, className, headerType = 'static', searchActive }: PropsWithChildren<Props>) => {
+const Header = ({ children, className, headerType = 'static', searchActive }: PropsWithChildren<HeaderProps>) => {
   const headerClassName = classNames(styles.header, styles[headerType], className, {
     [styles.searchActive]: searchActive,
   });
@@ -22,4 +26,5 @@ const Header = ({ children, className, headerType = 'static', searchActive }: Pr
     </header>
   );
 };
-export default Header;
+
+export default createInjectableComponent(HeaderIdentifier, Header);

packages/ui-react/src/components/MenuButton/MenuButton.tsx

@@ -2,9 +2,13 @@ import React from 'react';
 import { NavLink } from 'react-router-dom';
 import classNames from 'classnames';
 
+import createInjectableComponent from '../../modules/createInjectableComponent';
+
 import styles from './MenuButton.module.scss';
 
-type Props = {
+export const MenuButtonIdentifier = Symbol(`MENU_BUTTON`);
+
+export type MenuButtonProps = {
   label?: string;
   to?: string;
   onClick?: () => void;
@@ -16,7 +20,18 @@ type Props = {
   small?: boolean;
 } & React.AriaAttributes;
 
-const MenuButton: React.FC<Props> = ({ label, to, onClick, onBlur, onFocus, tabIndex = 0, active = false, startIcon, small = false, ...rest }: Props) => {
+const MenuButton: React.FC<MenuButtonProps> = ({
+  label,
+  to,
+  onClick,
+  onBlur,
+  onFocus,
+  tabIndex = 0,
+  active = false,
+  startIcon,
+  small = false,
+  ...rest
+}: MenuButtonProps) => {
   const icon = startIcon ? <div className={styles.startIcon}>{startIcon}</div> : null;
   const getClassName = (isActive: boolean) => classNames(styles.menuButton, { [styles.small]: small }, { [styles.active]: isActive });
 
@@ -45,4 +60,4 @@ const MenuButton: React.FC<Props> = ({ label, to, onClick, onBlur, onFocus, tabI
   );
 };
 
-export default MenuButton;
+export default createInjectableComponent(MenuButtonIdentifier, MenuButton);

packages/ui-react/src/components/Shelf/Shelf.tsx

@@ -15,6 +15,7 @@ import '@videodock/tile-slider/lib/style.css';
 
 import Card from '../Card/Card';
 import Icon from '../Icon/Icon';
+import createInjectableComponent from '../../modules/createInjectableComponent';
 
 import styles from './Shelf.module.scss';
 
@@ -34,6 +35,8 @@ export const featuredTileBreakpoints: Breakpoints = {
   [Breakpoint.xl]: 1,
 };
 
+export const ShelfIdentifier = Symbol(`SHELF`);
+
 export type ShelfProps = {
   playlist: Playlist;
   type: PlaylistType;
@@ -151,4 +154,4 @@ const Shelf = ({
   );
 };
 
-export default Shelf;
+export default createInjectableComponent(ShelfIdentifier, Shelf);

packages/ui-react/src/components/Sidebar/Sidebar.tsx

@@ -6,10 +6,13 @@ import IconButton from '../IconButton/IconButton';
 import Icon from '../Icon/Icon';
 import Modal, { type AnimationProps } from '../Modal/Modal';
 import Slide from '../Animation/Slide/Slide';
+import createInjectableComponent from '../../modules/createInjectableComponent';
 
 import styles from './Sidebar.module.scss';
 
-type SidebarProps = {
+export const SidebarIdentifier = Symbol(`SIDEBAR`);
+
+export type SidebarProps = {
   isOpen: boolean;
   onClose: () => void;
   children?: ReactNode;
@@ -40,4 +43,4 @@ const Sidebar: React.FC<SidebarProps> = ({ isOpen, onClose, children }) => {
   );
 };
 
-export default Sidebar;
+export default createInjectableComponent(SidebarIdentifier, Sidebar);

packages/ui-react/src/modules/createInjectableComponent.tsx

@@ -2,6 +2,8 @@ import React, { type FC } from 'react';
 
 import { container } from './container';
 
+// This HOC is used to override a component top-level, using Inversify
+// More info: platforms/web/src/modules/register.ts
 const createInjectableComponent = <Props extends object>(identifier: symbol, DefaultComponent: FC<Props>) => {
   return (props: Props) => {
     const isOverridden = container.isBound(identifier);

platforms/web/src/modules/register.ts

@@ -52,17 +52,18 @@ container.bind<LogTransporter>(LogTransporter).toDynamicValue(() => new ConsoleT
  *
  * @example
  * ```ts
- * // Define in types.ts (from `ui-react` for example)
- * const TAG_IDENTIFIER = 'TAG_IDENTIFIER';
+ * // Define an identifier from the component (from `ui-react` for example):
+ * export const CardIdentifier = Symbol('CARD');
  *
- * // Bind custom component
- * container.bind(TAG_IDENTIFIER).toConstantValue(CustomTag);
+ * // Make sure the component is wrapped in the HOC:
+ * export default createInjectableComponent(CardIdentifier, Card);
  *
- * // Then wrap the component in a HOC, from the component file itself
- * export default createInjectableComponent(TAG_IDENTIFIER, DefaultTag);
+ * // Override the component into the associated container, from register.ts:
+ * import { container as uiComponentContainer } from '@jwp/ott-ui-react/src/modules/container';
  *
+ * uiComponentContainer.bind<React.FC<CardProps>>(CardIdentifier).toConstantValue(CustomCard);
  * ```
  */
 
 // Override ui-react component
-// uiComponentContainer.bind<React.FC<TagProps>>(TAG_IDENTIFIER).toConstantValue(Tag);
+// uiComponentContainer.bind<React.FC<CardProps>>(CardIdentifier).toConstantValue(CustomCard);