@edifice.io/react 1.7.4-develop-pedago.20241211160712

package/README.md

@@ -0,0 +1,110 @@
+# Edifice React Components
+
+![npm](https://img.shields.io/npm/v/@edifice.io/react?style=flat-square)
+![bundlephobia](https://img.shields.io/bundlephobia/min/@edifice.io/react?style=flat-square)
+
+## Getting Started
+
+We follow [WAI ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/) rules and [Bootstrap 5](https://getbootstrap.com/docs/5.0/components/accordion/) guidelines when making our components
+
+### Build
+
+```bash
+pnpm run build
+```
+
+### Lint
+
+```bash
+pnpm run lint
+```
+
+If `pnpm run lint` shows issues, run this command to fix them.
+
+```bash
+pnpm run fix
+```
+
+### Prettier
+
+```bash
+pnpm run format
+```
+
+## Structure
+
+### Component Folder
+
+- Folder name always in PascalCase: `Button`
+- Component file in PascalCase: `Button.tsx`
+- Export types & interfaces inside Component file
+- Stories file in PascalCase + `*.stories.tsx` : `Button.stories.tsx`
+
+```bash
+src
+  -- ComponentFolder
+    -- Component.tsx
+    -- Component.stories.tsx
+    -- index.ts
+```
+
+- Re-export the Component inside his own `index` file: `index.ts`
+- Export everything if Component has types & interfaces
+
+```jsx
+export { default as Component } from "./Component";
+export * from "./Component";
+```
+
+### Component Guideline
+
+- Always document basic guideline of Component with JSDoc format. Used by Storybook to generate documentation.
+
+```jsx
+/**
+ * Primary UI component for user interaction
+ */
+```
+
+### Interface description
+
+- Always document typescript types and interface with JSDoc syntax. Used by Storybook to generate documentation.
+
+```jsx
+// Interface description (e.g: TreeViewProps.tsx)
+export interface ButtonProps {
+  /**
+   * Is this the principal call to action on the page?
+   */
+  primary?: boolean;
+  /**
+   * What background color to use
+   */
+  backgroundColor?: string;
+  /**
+   * How large should the button be?
+   */
+  size?: "small" | "medium" | "large";
+  /**
+   * Button contents
+   */
+  label: string;
+  /**
+   * Optional click handler
+   */
+  onClick?: () => void;
+}
+```
+
+### Index file inside `src` folder
+
+- Entry point of this React Library.
+- Import your component inside `index.ts` file.
+
+```jsx
+export * from "./Button";
+```
+
+## Dev
+
+You can build your component using `Storybook`. See [README](../../docs//README.md)

package/dist/audience.js

@@ -0,0 +1,16 @@
+import { default as default2 } from "./modules/audience/ViewsCounter.js";
+import { default as default3 } from "./modules/audience/ViewsModal.js";
+import { default as default4 } from "./modules/audience/ReactionSummary.js";
+import { default as default5 } from "./modules/audience/ReactionChoice.js";
+import { default as default6 } from "./modules/audience/ReactionModal.js";
+import { default as default7 } from "./modules/audience/hooks/useReactions.js";
+import { default as default8 } from "./modules/audience/hooks/useReactionIcons.js";
+export {
+  default5 as ReactionChoice,
+  default6 as ReactionModal,
+  default4 as ReactionSummary,
+  default2 as ViewsCounter,
+  default3 as ViewsModal,
+  default8 as useReactionIcons,
+  default7 as useReactions
+};

package/dist/comments.js

@@ -0,0 +1,4 @@
+import { default as default2 } from "./modules/comments/provider/CommentProvider.js";
+export {
+  default2 as CommentProvider
+};

package/dist/components/ActionBar/ActionBar.d.ts

@@ -0,0 +1,9 @@
+export interface ActionBarProps {
+    /**
+     * Add Buttons To Actions bar
+     */
+    children: React.ReactNode;
+}
+export type ActionBarType = React.FC<ActionBarProps>;
+declare const ActionBar: import('react').ForwardRefExoticComponent<ActionBarProps & import('react').RefAttributes<HTMLDivElement>>;
+export default ActionBar;

package/dist/components/ActionBar/ActionBar.js

@@ -0,0 +1,8 @@
+import { jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
+const ActionBar = /* @__PURE__ */ forwardRef(({
+  children
+}, ref) => /* @__PURE__ */ jsx("div", { ref, className: "actionbar", children }));
+export {
+  ActionBar as default
+};

package/dist/components/ActionBar/index.d.ts

@@ -0,0 +1,2 @@
+export { default as ActionBar } from './ActionBar';
+export * from './ActionBar';

package/dist/components/Alert/Alert.d.ts

@@ -0,0 +1,60 @@
+import { ComponentPropsWithRef, ReactNode } from 'react';
+export interface AlertRef {
+    show: () => void;
+    hide: () => void;
+}
+export type AlertTypes = 'success' | 'warning' | 'info' | 'danger';
+export type AlertPosition = 'none' | 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
+export interface AlertProps extends ComponentPropsWithRef<'div'> {
+    /**
+     * Type of alert
+     */
+    type?: AlertTypes;
+    /**
+     * Alert can be closed with a button ?
+     */
+    isDismissible?: boolean;
+    /**
+     * Alert is displayed as Toast
+     */
+    isToast?: boolean;
+    /**
+     * Alert is displayed as a confirm box (cancel button and confirm button)
+     */
+    isConfirm?: boolean;
+    /**
+     * Alert poistion.
+     */
+    position?: AlertPosition;
+    /**
+     * Alert must close after delay
+     */
+    autoClose?: boolean;
+    /**
+     * If autoClose if activated, set the delay
+     * Défault : 3000
+     */
+    autoCloseDelay?: number;
+    /**
+     * Alert box content
+     */
+    children: ReactNode;
+    /**
+     * Alert box action
+     */
+    button?: ReactNode;
+    /**
+     * Callback when alert is closed
+     */
+    onClose?: () => void;
+    /**
+     * Callback when alert is closed
+     */
+    onVisibilityChange?: (isVisible: boolean) => void;
+    /**
+     * Optional class for styling purpose
+     */
+    className?: string;
+}
+declare const Alert: import('react').ForwardRefExoticComponent<Omit<AlertProps, "ref"> & import('react').RefAttributes<AlertRef>>;
+export default Alert;

package/dist/components/Alert/Alert.js

@@ -0,0 +1,81 @@
+import { jsx, Fragment, jsxs } from "react/jsx-runtime";
+import { forwardRef, useState, useRef, useCallback, useImperativeHandle, useLayoutEffect, useEffect } from "react";
+import clsx from "clsx";
+import { useTranslation } from "react-i18next";
+import SvgIconAlertCircle from "../../modules/icons/components/IconAlertCircle.js";
+import SvgIconError from "../../modules/icons/components/IconError.js";
+import SvgIconInfoCircle from "../../modules/icons/components/IconInfoCircle.js";
+import SvgIconSuccessOutline from "../../modules/icons/components/IconSuccessOutline.js";
+import Button from "../Button/Button.js";
+const Alert = /* @__PURE__ */ forwardRef(({
+  type = "success",
+  className = "",
+  children,
+  button,
+  isDismissible = !1,
+  isToast = !1,
+  isConfirm = !1,
+  position = "none",
+  autoClose = !1,
+  autoCloseDelay = 3e3,
+  onClose,
+  onVisibilityChange
+}, ref) => {
+  const [isVisible, setVisibleStatus] = useState(!0), refAlert = useRef(null), {
+    t
+  } = useTranslation(), hide = useCallback(() => {
+    setVisibleStatus(!1), onClose == null || onClose();
+  }, [onClose]);
+  useImperativeHandle(ref, () => ({
+    show,
+    hide,
+    ...refAlert.current
+  })), useLayoutEffect(() => {
+    onVisibilityChange == null || onVisibilityChange(isVisible);
+  }, [isVisible, onVisibilityChange]), useEffect(() => {
+    autoClose && isVisible && setTimeout(() => {
+      hide();
+    }, autoCloseDelay);
+  }, [autoClose, autoCloseDelay, hide, isVisible]);
+  const show = () => {
+    setVisibleStatus(!0);
+  }, mapping = {
+    success: {
+      icon: /* @__PURE__ */ jsx(SvgIconSuccessOutline, {}),
+      classModifier: "alert-success"
+    },
+    warning: {
+      icon: /* @__PURE__ */ jsx(SvgIconAlertCircle, {}),
+      classModifier: "alert-warning"
+    },
+    info: {
+      icon: /* @__PURE__ */ jsx(SvgIconInfoCircle, {}),
+      classModifier: "alert-info"
+    },
+    danger: {
+      icon: /* @__PURE__ */ jsx(SvgIconError, {}),
+      classModifier: "alert-danger"
+    }
+  }, toastClasses = {
+    "is-dismissible": isDismissible,
+    "is-toast ": isToast
+  }, confirmClasses = {
+    "is-confirm": isConfirm
+  }, divContainerClasses = clsx("alert gap-12", mapping[type].classModifier, toastClasses, confirmClasses, position, className);
+  return /* @__PURE__ */ jsx(Fragment, { children: isVisible ? /* @__PURE__ */ jsxs("div", { ref: refAlert, className: divContainerClasses, role: "alert", children: [
+    !isConfirm && mapping[type].icon,
+    /* @__PURE__ */ jsx("div", { className: "alert-content small", children }),
+    button && /* @__PURE__ */ jsxs("div", { className: "ms-12", children: [
+      button,
+      " ",
+      isConfirm && /* @__PURE__ */ jsx(Button, { onClick: hide, children: t("close") })
+    ] }),
+    (isDismissible || isConfirm) && /* @__PURE__ */ jsx("div", { className: "btn-close-container", children: /* @__PURE__ */ jsx("button", { type: "button", className: "btn-close", "data-bs-dismiss": "alert", "aria-label": t("close"), onClick: hide }) }),
+    autoClose && /* @__PURE__ */ jsx("div", { className: "alert-progress", style: {
+      transform: "scaleX(0)"
+    } })
+  ] }) : null });
+});
+export {
+  Alert as default
+};

package/dist/components/Alert/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Alert } from './Alert';
+export * from './Alert';

package/dist/components/AppHeader/AppHeader.d.ts

@@ -0,0 +1,17 @@
+import { ComponentPropsWithRef, ReactNode } from 'react';
+export interface AppHeaderProps extends ComponentPropsWithRef<'div'> {
+    /**
+     * Accept Breadcrumb Component
+     */
+    children: ReactNode;
+    /**
+     * Actions
+     */
+    render?: () => JSX.Element | null;
+    /**
+     * When no layout is used
+     */
+    isFullscreen?: boolean;
+}
+declare const AppHeader: import('react').ForwardRefExoticComponent<Omit<AppHeaderProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+export default AppHeader;

package/dist/components/AppHeader/AppHeader.js

@@ -0,0 +1,22 @@
+import { jsxs, jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
+import clsx from "clsx";
+const AppHeader = /* @__PURE__ */ forwardRef(({
+  children,
+  render,
+  isFullscreen = !1,
+  ...restProps
+}, ref) => {
+  const classes = clsx("d-flex flex-wrap p-16 gap-8 border-bottom bg-white", {
+    "justify-content-between": render,
+    "mx-n16": !isFullscreen,
+    "z-3 top-0 start-0 end-0": isFullscreen
+  });
+  return /* @__PURE__ */ jsxs("div", { ref, className: classes, ...restProps, children: [
+    children,
+    render ? /* @__PURE__ */ jsx("div", { className: "d-flex align-items-center ms-auto gap-8", children: render() }) : null
+  ] });
+});
+export {
+  AppHeader as default
+};

package/dist/components/AppHeader/index.d.ts

@@ -0,0 +1,2 @@
+export { default as AppHeader } from './AppHeader';
+export * from './AppHeader';

package/dist/components/AppIcon/AppIcon.d.ts

@@ -0,0 +1,45 @@
+import { IWebApp } from '@edifice.io/client';
+export type AppIconSize = '24' | '32' | '40' | '48' | '80' | '160';
+export interface BaseProps {
+    /**
+     * Define icon size
+     */
+    size?: AppIconSize;
+    /**
+     * App information to get code and name
+     */
+    app?: IWebApp | string;
+    /**
+     * Custom class name
+     */
+    className?: string;
+}
+type AppVariants = 'square' | 'circle' | 'rounded';
+type SquareVariant = Extract<AppVariants, 'square'>;
+type SquareIcon = {
+    /**
+     * Show icon full width
+     */
+    iconFit?: 'contain';
+    /**
+     * Square variant
+     */
+    variant?: SquareVariant;
+};
+type VariantsIcon = {
+    /**
+     * Add padding around icon
+     */
+    iconFit: 'ratio';
+    /**
+     * Rounded or Circle variant
+     */
+    variant: AppVariants;
+};
+export type Props = SquareIcon | VariantsIcon;
+export type AppIconProps = BaseProps & Props;
+/**
+ * Icon Component used to display the icon of an application
+ */
+declare const AppIcon: import('react').ForwardRefExoticComponent<AppIconProps & import('react').RefAttributes<HTMLDivElement>>;
+export default AppIcon;

package/dist/components/AppIcon/AppIcon.js

@@ -0,0 +1,51 @@
+import { jsx } from "react/jsx-runtime";
+import { forwardRef, Suspense } from "react";
+import clsx from "clsx";
+import * as iconsApps from "../../icons-apps.js";
+import Image from "../Image/Image.js";
+import LoadingScreen from "../LoadingScreen/LoadingScreen.js";
+import useEdificeIcons from "../../hooks/useEdificeIcons/useEdificeIcons.js";
+const AppIcon = /* @__PURE__ */ forwardRef(({
+  app,
+  size = "24",
+  iconFit = "contain",
+  variant = "square",
+  className = ""
+}, ref) => {
+  const {
+    isIconUrl,
+    getIconCode
+  } = useEdificeIcons(), isSquare = variant === "square", isRounded = variant === "rounded", isCircle = variant === "circle", isContain = iconFit === "contain", isRatio = iconFit === "ratio", iconSizes = {
+    "icon-xs": size === "24",
+    "icon-sm": size === "40",
+    "icon-md": size === "48",
+    "icon-lg": size === "80",
+    "icon-xl": size === "160"
+  }, iconVariant = {
+    square: isSquare,
+    rounded: isRounded,
+    "rounded-circle": isCircle
+  }, iconFits = {
+    "icon-contain": isContain,
+    "icon-ratio": isRatio
+  }, icon = typeof app == "string" ? app : (app == null ? void 0 : app.icon) !== void 0 ? app.icon : "placeholder", displayName = typeof app != "string" && (app == null ? void 0 : app.displayName) !== void 0 ? app.displayName : "", code = app ? getIconCode(app) : "", isIconURL = isIconUrl(icon), appCode = code || "placeholder", classes = clsx("app-icon", {
+    ...iconSizes,
+    ...iconVariant,
+    ...iconFits,
+    [`bg-light-${appCode}`]: appCode && !isContain,
+    [`color-app-${appCode}`]: appCode
+  }, className), IconComponent = iconsApps[`Icon${appCode.split("-").map((part) => part.charAt(0).toUpperCase() + part.slice(1)).join("")}`];
+  if (isIconURL) {
+    const classes2 = clsx("h-full", className);
+    return /* @__PURE__ */ jsx(Image, { src: icon, alt: displayName, objectFit: "contain", width: size, height: size, className: classes2, style: {
+      minWidth: size + "px"
+    } });
+  }
+  return /* @__PURE__ */ jsx(Suspense, { fallback: /* @__PURE__ */ jsx(LoadingScreen, {}), children: /* @__PURE__ */ jsx("div", { ref, className: classes, style: {
+    width: size + "px",
+    height: size + "px"
+  }, children: /* @__PURE__ */ jsx(IconComponent, { width: size, height: size }) }) });
+});
+export {
+  AppIcon as default
+};

package/dist/components/AppIcon/index.d.ts

@@ -0,0 +1 @@
+export { default as AppIcon } from './AppIcon';

package/dist/components/Attachment/Attachment.d.ts

@@ -0,0 +1,14 @@
+import { ComponentPropsWithRef, ReactNode } from 'react';
+export interface AttachmentProps extends ComponentPropsWithRef<'div'> {
+    /**
+     * Name of resource or Folder
+     * */
+    name?: string;
+    /**
+     * Actions attachment
+     * */
+    options: ReactNode | undefined;
+}
+export type AttachmentType = AttachmentProps;
+declare const Attachment: import('react').ForwardRefExoticComponent<Omit<AttachmentProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+export default Attachment;

package/dist/components/Attachment/Attachment.js

@@ -0,0 +1,18 @@
+import { jsxs, jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
+import SvgIconPaperclip from "../../modules/icons/components/IconPaperclip.js";
+import Tooltip from "../Tooltip/Tooltip.js";
+const Attachment = /* @__PURE__ */ forwardRef(({
+  name = "Attachment Name",
+  options,
+  ...restProps
+}, ref) => /* @__PURE__ */ jsxs("div", { ref, className: "attachment px-12 py-8", ...restProps, children: [
+  /* @__PURE__ */ jsxs(Tooltip, { message: name, className: "filename text-truncate d-flex align-items-center gap-8", children: [
+    /* @__PURE__ */ jsx(SvgIconPaperclip, { height: 22, width: 22 }),
+    /* @__PURE__ */ jsx("div", { className: "filename text-truncate", children: name })
+  ] }),
+  options && /* @__PURE__ */ jsx("div", { className: "options ps-12", children: options })
+] }));
+export {
+  Attachment as default
+};

package/dist/components/Attachment/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Attachment } from './Attachment';
+export * from './Attachment';

package/dist/components/Avatar/Avatar.d.ts

@@ -0,0 +1,31 @@
+export type AvatarVariants = 'square' | 'rounded' | 'circle';
+export type AvatarSizes = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export interface AvatarProps extends React.ComponentPropsWithRef<'img'> {
+    /**
+     * Shape of Avatar
+     * `title`, `square`, `circle`
+     */
+    variant?: AvatarVariants;
+    /**
+     * Avatar' size
+     */
+    size?: AvatarSizes;
+    /**
+     * Show image when `src` props is provided
+     */
+    src?: string;
+    /**
+     * Custom fallback image
+     */
+    imgPlaceholder?: string;
+    /**
+     * Alternative text when using image
+     */
+    alt: string;
+    /**
+     * Optional class for styling purpose
+     */
+    className?: string;
+}
+declare const Avatar: import('react').ForwardRefExoticComponent<Omit<AvatarProps, "ref"> & import('react').RefAttributes<HTMLDivElement>>;
+export default Avatar;

package/dist/components/Avatar/Avatar.js

@@ -0,0 +1,33 @@
+import { jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
+import clsx from "clsx";
+import noAvatar from "@edifice.io/bootstrap/dist/images/avatar/no-avatar.svg";
+import Image from "../Image/Image.js";
+const Avatar = /* @__PURE__ */ forwardRef(({
+  variant = "square",
+  size = "md",
+  alt,
+  src,
+  imgPlaceholder,
+  className,
+  ...restProps
+}, ref) => {
+  const placeholder = imgPlaceholder || noAvatar, classes = clsx("avatar", {
+    ...{
+      "avatar-xs": size === "xs",
+      "avatar-sm": size === "sm",
+      "avatar-md": size === "md",
+      "avatar-lg": size === "lg",
+      "avatar-xl": size === "xl"
+    },
+    ...{
+      square: variant === "square",
+      rounded: variant === "rounded",
+      "rounded-circle": variant === "circle"
+    }
+  }, className);
+  return /* @__PURE__ */ jsx("div", { ref, className: classes, children: /* @__PURE__ */ jsx(Image, { src: src || placeholder, alt, imgPlaceholder: placeholder, ...restProps }) });
+});
+export {
+  Avatar as default
+};

package/dist/components/Avatar/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Avatar } from './Avatar';
+export * from './Avatar';

package/dist/components/Badge/Badge.d.ts

@@ -0,0 +1,49 @@
+import { ReactNode } from 'react';
+import { UserProfile } from '@edifice.io/client';
+export type BadgeRef = HTMLSpanElement;
+/** Badge variant : notification */
+export type NotificationBadgeVariant = {
+    type: 'notification';
+    level: 'success' | 'warning' | 'danger' | 'info';
+};
+/** Badge variant : content */
+export type ContentBadgeVariant = {
+    type: 'content';
+    level: 'success' | 'warning' | 'danger' | 'info';
+    background?: boolean;
+};
+/** Badge variant : profile = teacher, student, relative or personnel, guest */
+export type ProfileBadgeVariant = {
+    type: 'user';
+    profile: UserProfile[number];
+    background?: boolean;
+};
+/** Badge variant : chip */
+export type ChipBadgeVariant = {
+    type: 'chip';
+};
+/** Badge variant : link */
+export type LinkBadgeVariant = {
+    type: 'link';
+};
+export type BadgeVariants = NotificationBadgeVariant | ContentBadgeVariant | ProfileBadgeVariant | ChipBadgeVariant | LinkBadgeVariant;
+export interface BadgeProps extends React.ComponentPropsWithRef<'span'> {
+    /**
+     * Badge variant : notification, link or profile (Teacher|Student|Relative|Personnel)
+     * Defaults to notification.
+     */
+    variant?: BadgeVariants;
+    /**
+     * Text or icon (or whatever) to render as children elements.
+     */
+    children?: ReactNode;
+    /**
+     * Optional class for styling purpose
+     */
+    className?: string;
+}
+/**
+ * Primary UI component for user interaction
+ */
+declare const Badge: import('react').ForwardRefExoticComponent<Omit<BadgeProps, "ref"> & import('react').RefAttributes<HTMLSpanElement>>;
+export default Badge;

package/dist/components/Badge/Badge.js

@@ -0,0 +1,18 @@
+import { jsx } from "react/jsx-runtime";
+import { forwardRef } from "react";
+import clsx from "clsx";
+const Badge = /* @__PURE__ */ forwardRef(({
+  className,
+  variant = {
+    type: "notification",
+    level: "info"
+  },
+  children,
+  ...restProps
+}, ref) => {
+  const classes = clsx("badge rounded-pill", (variant.type === "content" || variant.type === "user") && "background" in variant ? "bg-gray-200" : (variant.type === "content" || variant.type === "user") && !("background" in variant) ? "border border-0" : "", variant.type === "content" && `text-${variant.level}`, variant.type === "notification" && `badge-notification bg-${variant.level} text-light border border-0`, variant.type === "user" && `badge-profile-${variant.profile.toLowerCase()}`, variant.type === "link" && "badge-link border border-0", variant.type === "chip" && "bg-gray-200", className);
+  return /* @__PURE__ */ jsx("span", { ref, className: classes, ...restProps, children: variant.type === "chip" ? /* @__PURE__ */ jsx("div", { className: "d-flex fw-800 align-items-center", children }) : children });
+});
+export {
+  Badge as default
+};

package/dist/components/Badge/index.d.ts

@@ -0,0 +1,2 @@
+export { default as Badge } from './Badge';
+export * from './Badge';

package/dist/components/Breadcrumb/Breadcrumb.d.ts

@@ -0,0 +1,13 @@
+import { IWebApp } from '@edifice.io/client';
+export interface BreadcrumbProps {
+    /**
+     * Pass all data about current application
+     */
+    app: IWebApp;
+    /**
+     * Show name of the current resource
+     */
+    name?: string;
+}
+declare const Breadcrumb: import('react').ForwardRefExoticComponent<BreadcrumbProps & import('react').RefAttributes<HTMLElement>>;
+export default Breadcrumb;