@centreon/ui 24.5.12 → 24.5.13

package/src/components/Layout/PageLayout/PageLayoutActions.tsx

@@ -0,0 +1,25 @@
+import { ReactElement, ReactNode } from 'react';
+
+import { useStyles } from './PageLayout.styles';
+
+interface PageLayoutActionsProps {
+  children: Array<ReactNode> | ReactNode;
+  rowReverse?: boolean;
+}
+
+export const PageLayoutActions = ({
+  children,
+  rowReverse
+}: PageLayoutActionsProps): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <section
+      className={classes.pageLayoutActions}
+      data-row-reverse={rowReverse}
+      id="actions"
+    >
+      {children}
+    </section>
+  );
+};

package/src/components/Layout/PageLayout/PageLayoutBody.tsx

@@ -0,0 +1,25 @@
+import { ReactElement, ReactNode } from 'react';
+
+import { useStyles } from './PageLayout.styles';
+
+type PageLayoutBodyProps = {
+  children: Array<ReactNode> | ReactNode;
+  hasBackground?: boolean;
+};
+
+export const PageLayoutBody = ({
+  children,
+  hasBackground = false
+}: PageLayoutBodyProps): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <section
+      className={classes.pageLayoutBody}
+      data-has-background={hasBackground}
+      id="page-body"
+    >
+      {children}
+    </section>
+  );
+};

package/src/components/Layout/PageLayout/PageLayoutHeader.tsx

@@ -0,0 +1,19 @@
+import { ReactNode } from 'react';
+
+import { useStyles } from './PageLayout.styles';
+
+type PageLayoutHeaderProps = {
+  children: Array<ReactNode> | ReactNode;
+};
+
+export const PageLayoutHeader = ({
+  children
+}: PageLayoutHeaderProps): JSX.Element => {
+  const { classes } = useStyles();
+
+  return (
+    <header className={classes.pageLayoutHeader} id="header">
+      {children}
+    </header>
+  );
+};

package/src/components/Layout/PageLayout/PageQuickAccess.tsx

@@ -0,0 +1,76 @@
+import { useTranslation } from 'react-i18next';
+
+import AddIcon from '@mui/icons-material/Add';
+import ArrowBackIcon from '@mui/icons-material/ArrowBack';
+
+import { Button, Menu } from '../..';
+
+interface NamedEntity {
+  id: number | string;
+  name: string;
+}
+
+type Props = {
+  create: () => void;
+  elements: Array<NamedEntity>;
+  goBack: () => void;
+  isActive: (id: number | string) => boolean;
+  labels: {
+    create: string;
+    goBack: string;
+  };
+  navigateToElement: (id: number | string) => () => void;
+};
+
+export const PageQuickAccess = ({
+  elements,
+  isActive,
+  navigateToElement,
+  goBack,
+  create,
+  labels
+}: Props): JSX.Element => {
+  const { t } = useTranslation();
+
+  return (
+    <Menu>
+      <Menu.Button data-testid="quickaccess" />
+      <Menu.Items>
+        {elements &&
+          elements.map((element) => (
+            <Menu.Item
+              key={`${element.id}`}
+              onClick={navigateToElement(element.id)}
+              {...(isActive(element.id) && {
+                isActive: true,
+                isDisabled: true
+              })}
+            >
+              {element.name}
+            </Menu.Item>
+          ))}
+        <Menu.Divider key="divider" />
+        <Menu.Item key="create">
+          <>
+            <Button
+              icon={<ArrowBackIcon />}
+              iconVariant="start"
+              variant="ghost"
+              onClick={goBack}
+            >
+              {t(labels.goBack)}
+            </Button>
+            <Button
+              icon={<AddIcon />}
+              iconVariant="start"
+              variant="secondary"
+              onClick={create}
+            >
+              {t(labels.create)}
+            </Button>
+          </>
+        </Menu.Item>
+      </Menu.Items>
+    </Menu>
+  );
+};

package/src/components/Layout/PageLayout/index.ts

@@ -0,0 +1,12 @@
+import { PageLayout as PageLayoutRoot } from './PageLayout';
+import { PageLayoutHeader } from './PageLayoutHeader';
+import { PageLayoutBody } from './PageLayoutBody';
+import { PageLayoutActions } from './PageLayoutActions';
+import { PageQuickAccess } from './PageQuickAccess';
+
+export const PageLayout = Object.assign(PageLayoutRoot, {
+  Actions: PageLayoutActions,
+  Body: PageLayoutBody,
+  Header: PageLayoutHeader,
+  QuickAccess: PageQuickAccess
+});

package/src/components/Layout/PageLayout.cypress.spec.tsx

@@ -0,0 +1,66 @@
+import { T } from 'ramda';
+
+import { PageHeader } from '..';
+
+import { AreaIndicator } from './AreaIndicator';
+
+import { PageLayout } from '.';
+
+const initialize = (): void => {
+  cy.mount({
+    Component: (
+      <PageLayout>
+        <PageLayout.Header>
+          <PageHeader>
+            <PageHeader.Menu>
+              <PageLayout.QuickAccess
+                create={cy.stub()}
+                elements={[
+                  {
+                    id: 1,
+                    name: 'Entity'
+                  }
+                ]}
+                goBack={cy.stub()}
+                isActive={T}
+                labels={{
+                  create: 'Create',
+                  goBack: 'Go back'
+                }}
+                navigateToElement={cy.stub()}
+              />
+            </PageHeader.Menu>
+            <PageHeader.Main>
+              <PageHeader.Title description="Description" title="Title" />
+            </PageHeader.Main>
+            <PageHeader.Actions>Actions</PageHeader.Actions>
+          </PageHeader>
+        </PageLayout.Header>
+        <PageLayout.Body>
+          <PageLayout.Actions>
+            <AreaIndicator name="Body actions" />
+          </PageLayout.Actions>
+          <h1>Content</h1>
+        </PageLayout.Body>
+      </PageLayout>
+    )
+  });
+};
+
+describe('Page layout', () => {
+  beforeEach(initialize);
+
+  it('displays the page layout', () => {
+    cy.makeSnapshot();
+  });
+
+  it('opens the quick access poppin when the corresponding logo is displayed', () => {
+    cy.findByTestId('quickaccess').click();
+
+    cy.contains('Entity').should('be.visible');
+    cy.contains('Create').should('be.visible');
+    cy.contains('Go back').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+});

package/src/components/Layout/index.ts

@@ -0,0 +1 @@
+export * from './PageLayout';

package/src/components/List/Item/Avatar.tsx

@@ -0,0 +1,21 @@
+import { ReactElement } from 'react';
+
+import {
+  Avatar as MuiAvatar,
+  ListItemAvatar as MuiListItemAvatar
+} from '@mui/material';
+
+import { useStyles } from './ListItem.styles';
+
+type AvatarProps = {
+  children: ReactElement | string;
+};
+export const Avatar = ({ children }: AvatarProps): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <MuiListItemAvatar className={classes.avatar} data-element="avatar">
+      <MuiAvatar>{children}</MuiAvatar>
+    </MuiListItemAvatar>
+  );
+};

package/src/components/List/Item/AvatarSkeleton.tsx

@@ -0,0 +1,17 @@
+import { ReactElement } from 'react';
+
+import { Skeleton as MuiSkeleton } from '@mui/material';
+
+import { useStyles } from './ListItem.styles';
+
+export const AvatarSkeleton = (): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <MuiSkeleton
+      animation="wave"
+      className={classes.avatar}
+      variant="circular"
+    />
+  );
+};

package/src/components/List/Item/ListItem.stories.tsx

@@ -0,0 +1,41 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+import { ListItem } from '.';
+
+const meta: Meta<typeof ListItem> = {
+  component: ListItem
+};
+
+export default meta;
+type Story = StoryObj<typeof ListItem>;
+
+export const Default: Story = {
+  args: {
+    children: 'Default'
+  }
+};
+
+export const WithTextAndAvatar: Story = {
+  args: {
+    children: (
+      <>
+        <ListItem.Avatar>AV</ListItem.Avatar>
+        <ListItem.Text
+          primaryText="Primary text"
+          secondaryText="Secondary text"
+        />
+      </>
+    )
+  }
+};
+
+export const AsLoadingState: Story = {
+  args: {
+    children: (
+      <>
+        <ListItem.Avatar.Skeleton />
+        <ListItem.Text.Skeleton secondaryText />
+      </>
+    )
+  }
+};

package/src/components/List/Item/ListItem.styles.ts

@@ -0,0 +1,63 @@
+import { makeStyles } from 'tss-react/mui';
+
+export const useStyles = makeStyles()((theme) => ({
+  avatar: {
+    '&, &.MuiListItemAvatar-root, & > div': {
+      color: theme.palette.primary.contrastText,
+      fontSize: '1rem',
+      height: '2.25rem',
+      width: '2.25rem'
+    },
+    disabled: {
+      backgroundColor: theme.palette.action.disabled
+    },
+    minWidth: 'unset'
+  },
+  listItem: {
+    alignItems: 'center',
+    display: 'flex',
+    flexGrow: 1,
+    gap: theme.spacing(2),
+    overflow: 'hidden',
+    paddingBottom: theme.spacing(1),
+    paddingTop: theme.spacing(1),
+    width: '100%'
+  },
+  secondary: {
+    alignItems: 'center',
+    display: 'flex',
+    flexDirection: 'row',
+    gap: theme.spacing(1)
+  },
+  text: {
+    '&, &.MuiListItemText-root': {
+      '& .MuiListItemText-primary': {
+        fontSize: '0.875rem'
+      },
+      '& .MuiListItemText-secondary': {
+        fontSize: '0.625rem'
+      },
+      '& > *': {
+        overflow: 'hidden',
+        textOverflow: 'ellipsis',
+        textWrap: 'nowrap'
+      },
+      margin: 0
+    },
+    disabled: {
+      color: theme.palette.action.disabled
+    }
+  },
+  textSkeleton: {
+    '& span:nth-child(1)': {
+      fontSize: '0.875rem'
+    },
+    '& span:nth-child(2)': {
+      fontSize: '0.625rem',
+      width: '60%'
+    },
+    display: 'flex',
+    flexDirection: 'column',
+    minWidth: '40%'
+  }
+}));

package/src/components/List/Item/ListItem.tsx

@@ -0,0 +1,34 @@
+import { ForwardedRef, forwardRef, ReactElement, ReactNode } from 'react';
+
+import { ListItemProps, ListItem as MuiListItem } from '@mui/material';
+
+import { useStyles } from './ListItem.styles';
+
+type Props = {
+  action?: ReactElement;
+  children: ReactNode | Array<ReactNode>;
+  className?: string;
+};
+
+export const ListItem = forwardRef(
+  (
+    { action, children, className, ...attr }: Props & ListItemProps,
+    ref?: ForwardedRef<HTMLLIElement>
+  ) => {
+    const { classes, cx } = useStyles();
+
+    return (
+      <MuiListItem
+        disableGutters
+        className={cx(classes.listItem, className)}
+        ref={ref}
+        secondaryAction={
+          action && <div className={classes.secondary}>{action}</div>
+        }
+        {...attr}
+      >
+        {children}
+      </MuiListItem>
+    );
+  }
+);

package/src/components/List/Item/Text.tsx

@@ -0,0 +1,27 @@
+import { ReactElement, ReactNode } from 'react';
+
+import { ListItemText as MuiListItemText } from '@mui/material';
+
+import { useStyles } from './ListItem.styles';
+
+type TextProps = {
+  className?: string;
+  primaryText: ReactNode;
+  secondaryText?: ReactNode;
+};
+
+export const Text = ({
+  primaryText,
+  secondaryText,
+  className
+}: TextProps): ReactElement => {
+  const { classes, cx } = useStyles();
+
+  return (
+    <MuiListItemText
+      className={cx(classes.text, className)}
+      primary={primaryText}
+      secondary={secondaryText}
+    />
+  );
+};

package/src/components/List/Item/TextSkeleton.tsx

@@ -0,0 +1,22 @@
+import { ReactElement } from 'react';
+
+import { Skeleton as MuiSkeleton } from '@mui/material';
+
+import { useStyles } from './ListItem.styles';
+
+type TextSkeletonProps = {
+  secondaryText?: boolean;
+};
+
+export const TextSkeleton = ({
+  secondaryText
+}: TextSkeletonProps): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <span className={classes.textSkeleton}>
+      <MuiSkeleton animation="wave" variant="text" />
+      {!!secondaryText && <MuiSkeleton animation="wave" variant="text" />}
+    </span>
+  );
+};

package/src/components/List/Item/index.ts

@@ -0,0 +1,14 @@
+import { ListItem as ListItemRoot } from './ListItem';
+import { Text as TextRoot } from './Text';
+import { TextSkeleton } from './TextSkeleton';
+import { Avatar as AvatarRoot } from './Avatar';
+import { AvatarSkeleton } from './AvatarSkeleton';
+
+export const ListItem = Object.assign(ListItemRoot, {
+  Avatar: Object.assign(AvatarRoot, {
+    Skeleton: AvatarSkeleton
+  }),
+  Text: Object.assign(TextRoot, {
+    Skeleton: TextSkeleton
+  })
+});

package/src/components/List/List.stories.tsx

@@ -0,0 +1,70 @@
+/* eslint-disable react/no-array-index-key */
+import { Meta, StoryObj } from '@storybook/react';
+
+import DeleteIcon from '@mui/icons-material/Delete';
+import { Box } from '@mui/material';
+
+import { List } from '.';
+
+const meta: Meta<typeof List> = {
+  component: List
+};
+
+export default meta;
+type Story = StoryObj<typeof List>;
+
+const sampleData = Array(50).fill({
+  icon: <DeleteIcon />,
+  primary: 'Primary text',
+  secondary: 'Secondary text'
+});
+
+export const Default: Story = {
+  render: () => (
+    <List>
+      {sampleData.map(({ primary }, index) => (
+        <List.Item key={`${primary}_${index}`}>
+          <List.Item.Text primaryText={primary} />
+        </List.Item>
+      ))}
+    </List>
+  )
+};
+
+export const withAction: Story = {
+  render: () => (
+    <List>
+      {sampleData.map(({ icon, primary }, index) => (
+        <List.Item action={icon} key={`${primary}_${index}`}>
+          <List.Item.Text primaryText={primary} />
+        </List.Item>
+      ))}
+    </List>
+  )
+};
+
+export const withSecondaryText: Story = {
+  render: () => (
+    <List>
+      {sampleData.map(({ primary, secondary }, index) => (
+        <List.Item key={`${primary}_${index}`}>
+          <List.Item.Text primaryText={primary} secondaryText={secondary} />
+        </List.Item>
+      ))}
+    </List>
+  )
+};
+
+export const withSmallContainer: Story = {
+  render: () => (
+    <Box sx={{ height: 400, width: 200 }}>
+      <List>
+        {sampleData.map(({ icon, primary, secondary }, index) => (
+          <List.Item action={icon} key={`${primary}_${index}`}>
+            <List.Item.Text primaryText={primary} secondaryText={secondary} />
+          </List.Item>
+        ))}
+      </List>
+    </Box>
+  )
+};

package/src/components/List/List.styles.ts

@@ -0,0 +1,8 @@
+import { makeStyles } from 'tss-react/mui';
+
+export const useStyles = makeStyles()({
+  list: {
+    height: '100%',
+    overflowY: 'auto'
+  }
+});

package/src/components/List/List.tsx

@@ -0,0 +1,19 @@
+import { ReactElement, ReactNode } from 'react';
+
+import { List as MuiList } from '@mui/material';
+
+import { useStyles } from './List.styles';
+
+type Props = {
+  children: ReactNode;
+};
+
+export const List = ({ children }: Props): ReactElement => {
+  const { classes } = useStyles();
+
+  return (
+    <MuiList dense className={classes.list}>
+      {children}
+    </MuiList>
+  );
+};

package/src/components/List/index.ts

@@ -0,0 +1,6 @@
+import { List as ListRoot } from './List';
+import { ListItem } from './Item';
+
+export const List = Object.assign(ListRoot, {
+  Item: ListItem
+});

package/src/components/Menu/Button/MenuButton.stories.tsx

@@ -0,0 +1,16 @@
+import { Meta, StoryObj } from '@storybook/react';
+
+import { MenuButton } from './MenuButton';
+
+const meta: Meta<typeof MenuButton> = {
+  component: MenuButton
+};
+
+export default meta;
+type Story = StoryObj<typeof MenuButton>;
+
+export const Default: Story = {
+  args: {
+    'aria-label': 'menu button'
+  }
+};

package/src/components/Menu/Button/MenuButton.styles.ts

@@ -0,0 +1,27 @@
+import { makeStyles } from 'tss-react/mui';
+
+export const useStyles = makeStyles()((theme) => ({
+  buttonIcon: {
+    '[data-is-active="true"] &': {
+      transform: 'rotate(180deg)'
+    },
+
+    fontSize: '1.25rem',
+    transition: 'transform 0.15s ease-in-out'
+  },
+  menuButton: {
+    '&:hover:not(&[data-is-active="true"])': {
+      backgroundColor: theme.palette.menu.button.background.hover,
+      color: theme.palette.menu.button.color.hover
+    },
+    '&[data-is-active="true"]': {
+      backgroundColor: theme.palette.menu.button.background.active,
+      color: theme.palette.menu.button.color.active
+    },
+    backgroundColor: theme.palette.menu.button.background.default,
+    color: theme.palette.menu.button.color.default,
+    display: 'flex',
+    height: 'unset',
+    minWidth: 'unset'
+  }
+}));