npm - react-weekly-planning - Versions diffs - 1.0.0 - Mend

react-weekly-planning 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (39) hide show

package/LICENSE +21 -0
package/README.md +160 -0
package/__tests__/page.test.js +46 -0
package/__tests__/page.test.tsx +57 -0
package/contexts/CalendarContext.js +12 -0
package/contexts/CalendarContext.tsx +34 -0
package/definition.txt +318 -0
package/definitions/index.js +1 -0
package/definitions/index.ts +446 -0
package/docs/global.html +4983 -0
package/docs/index.html +473 -0
package/docs/index.ts.html +567 -0
package/docs/scripts/app.min.js +1 -0
package/docs/scripts/linenumber.js +26 -0
package/docs/scripts/search.js +39 -0
package/docs/styles/app.min.css +1 -0
package/docs/styles/iframe.css +13 -0
package/docs/styles/prettify-jsdoc.css +111 -0
package/docs/styles/prettify-tomorrow.css +132 -0
package/docs/styles/reset.css +44 -0
package/index.js +224 -0
package/index.tsx +591 -0
package/jest.config.js +9 -0
package/jest.config.ts +10 -0
package/jsdoc.json +26 -0
package/lib/utils.js +437 -0
package/lib/utils.ts +598 -0
package/myJsDoc.js +0 -0
package/out/index.html +129 -0
package/out/scripts/app.min.js +1 -0
package/out/scripts/linenumber.js +26 -0
package/out/scripts/search.js +39 -0
package/out/styles/app.min.css +1 -0
package/out/styles/iframe.css +13 -0
package/out/styles/prettify-jsdoc.css +111 -0
package/out/styles/prettify-tomorrow.css +132 -0
package/out/styles/reset.css +44 -0
package/package.json +45 -0
package/style.css +51 -0

package/docs/index.ts.html ADDED Viewed

@@ -0,0 +1,567 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> index.ts</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+                <a href="index.html">
+                    <h1 class="navbar-item">Calendar</h1>
+                </a>
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3><a href="global.html">Global</a></h3></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Source</p>
+                    <h1>index.ts</h1>
+                </header>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * Props for the Group component.
+ */
+export type GroupPropsType = {
+  /** Custom render function for the group. */
+  groupRender?: ({
+    currentGroup
+  }: {
+    currentGroup: GroupFeildsType;
+  }) => React.ReactNode;
+  /** Additional class names for the group component. */
+  className?: string;
+  /** Additional styles for the group component. */
+  style?: React.CSSProperties | undefined;
+  /** The current group data. */
+  currentGroup: GroupFeildsType;
+  /** Handler function for clicking the group. */
+  handleClickGroup?: (currentGroup: GroupFeildsType) => void;
+};
+/**
+ * Required fields for a group.
+ */
+type GroupRiquiredFieldsType = {
+  /** Label for the group. */
+  label?: string;
+  /** URL of the image representing the group. */
+  imageUrl?: string;
+  /** Unique identifier for the group. */
+  id: string;
+};
+/**
+ * Additional fields for a group.
+ */
+type GroupAdditionalFieldsType = Record&lt;any, unknown>;
+/**
+ * Fields for a group, including both required and additional fields.
+ */
+export type GroupFeildsType = GroupRiquiredFieldsType &amp;
+  GroupAdditionalFieldsType;
+/**
+ * Props for the GroupComponent.
+ */
+export type GroupComponentPropsType = {
+  /** Custom render function for the group. */
+  groupRender?: ({
+    currentGroup
+  }: {
+    currentGroup: GroupFeildsType;
+  }) => React.ReactNode;
+  /** Additional class names for the group component. */
+  className?: string;
+  /** Additional styles for the group component. */
+  style?: React.CSSProperties | undefined;
+};
+/**
+ * Props for the Days component.
+ */
+export type DaysPropsType = {
+  /** Custom render function for a day. */
+  dayRender?: ({
+    dayIndex,
+    day,
+    dayOfTheMonth,
+    dayMonth,
+    dayYear,
+  }: {
+    dayIndex?: number;
+    day?: string;
+    dayOfTheMonth?: number;
+    dayMonth?: string;
+    dayYear?: number;
+  }) => React.ReactNode;
+  /** Additional class names for the days component. */
+  className?: string;
+  /** Additional styles for the days component. */
+  style?: React.CSSProperties | undefined;
+};
+/**
+ * Props for a single day.
+ */
+export type DayPropsType = {
+  /** Index of the day. */
+  dayIndex: number;
+  /** Name of the day. */
+  day: string;
+  /** Day of the month. */
+  dayOfTheMonth: number;
+  /** Custom render function for a day. */
+  dayRender?: ({
+    dayIndex,
+    day,
+    dayOfTheMonth,
+    dayMonth,
+    dayYear,
+  }: {
+    dayIndex: number;
+    day: string;
+    dayOfTheMonth: number;
+    dayMonth: string;
+    dayYear: number;
+  }) => React.ReactNode;
+  /** Month of the day. */
+  dayMonth: string;
+  /** Year of the day. */
+  dayYear: number;
+  /** Additional class names for the day component. */
+  className?: string;
+  /** Additional styles for the day component. */
+  style?: React.CSSProperties | undefined;
+};
+/**
+ * Props for the Calendar component.
+ */
+export type CalendarPropsType = {
+  /** Offset for the week (e.g., -7 for last week, 0 for current week, 7 for next week). */
+  weekOffset?: number;
+  /** Array of group data to be displayed in the calendar. */
+  groups: GroupFeildsType[];
+  /** Additional class names for the calendar component. */
+  className?: string;
+  /** Additional styles for the calendar component. */
+  style?: React.CSSProperties | undefined;
+  /** The current date to display in the calendar. */
+  date: Date;
+  /** Custom render function for a group. */
+  groupRender?: ({
+    currentGroup
+  }: {
+    currentGroup: GroupFeildsType;
+  }) => React.ReactNode;
+  /** Custom render function for a day. */
+  dayRender?: ({
+    dayIndex,
+    day,
+    dayOfTheMonth,
+    dayMonth,
+    dayYear,
+  }: {
+    dayIndex: number;
+    day: string;
+    dayOfTheMonth: number;
+    dayMonth: string;
+    dayYear: number;
+  }) => React.ReactNode;
+  /** Custom render function for a task. */
+  taskRender?: ({
+    currentTask,
+    handleDragTask
+  }: {
+    currentTask: TaskFeildsType;
+    handleDragTask?: (
+      event: React.DragEvent&lt;HTMLDivElement>,
+      currentTask: TaskFeildsType
+    ) => void;
+  }) => React.ReactNode;
+  /** Additional styles for the rows. */
+  rowsStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the rows. */
+  rowsClassName?: string;
+  /** Additional styles for the group columns. */
+  groupsColsStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the group columns. */
+  groupsColsClassName?: string;
+  /** Additional styles for the day columns. */
+  daysColsStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the day columns. */
+  daysColsClassName?: string;
+  /** Additional class names for the add task button. */
+  addTaskClassName?: string;
+  /** Additional styles for the add task button. */
+  addTaskStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the groups. */
+  groupClassName?: string;
+  /** Additional styles for the groups. */
+  groupStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the days. */
+  dayClassName?: string;
+  /** Additional styles for the days. */
+  dayStyle?: React.CSSProperties | undefined;
+  /** Additional styles for the task container. */
+  taskContainerStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the task container. */
+  taskContainerClassName?: string;
+  /** Additional styles for the group head container. */
+  groupHeadContainerStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the group head container. */
+  groupHeadContainerClassName?: string;
+  /** Additional styles for the sum hours container. */
+  sumHoursContainerStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the sum hours container. */
+  sumHoursContainerClassName?: string;
+  /** Additional styles for the sum hours header. */
+  sumHoursHeadStyle?: React.CSSProperties | undefined;
+  /** Additional class names for the sum hours header. */
+  sumHoursHeadClassName?: string;
+  /** Handler function for adding a new task. */
+  handleAddTask?: (
+    groupId: string,
+    dayInfo: dayInfoType
+  ) => void;
+  /** Custom render function for adding a task. */
+  addTaskRender?:({
+    groupId,
+    dayInfo,
+  }: {
+    groupId: string;
+    dayInfo: dayInfoType;
+  }) => React.ReactNode;
+  /** Array of tasks to be displayed in the calendar. */
+  tasks: TasksType;
+  /** Handler function for dragging a task. */
+  handleDragTask?: (
+    event: React.DragEvent&lt;HTMLDivElement>,
+    currentTask: TaskFeildsType
+  ) => void;
+  /** Handler function for dropping a task. */
+  handleDropTask?: (
+    event: React.DragEvent&lt;HTMLTableDataCellElement>,
+    taskStart: number,
+    taskEnd: number,
+    taskDate: Date,
+    groupId: string,
+    dayIndex: number,
+    newTask: TaskFeildsType,
+    newTasks: TasksType
+  ) => void;
+  /** Handler function for ending the drag of a task. */
+  handleDragTaskEnd?: (
+    event: React.DragEvent&lt;HTMLDivElement>
+  ) => void;
+  /** Custom render function for the groups header. */
+  groupsHeadRender?: () => React.ReactNode;
+  /** Custom render function for the sum of hours. */
+  sumHoursRender?: ({
+    groupId,
+    tasks,
+    weekOffset,
+    calendarDate,
+    sumHoursByGroups,
+  }: {
+    groupId: string;
+    tasks: TasksType;
+    weekOffset: number;
+    calendarDate: Date;
+    sumHoursByGroups: number;
+  }) => React.ReactNode;
+  /** Custom render function for the sum of hours header. */
+  sumHoursHeadRender?:() => React.ReactNode;
+  /** Handler function for clicking a task. */
+  handleClickTask?: (currentTask: TaskFeildsType) => void;
+  /** Handler function for clicking a group. */
+  handleClickGroup?: (currentGroup: GroupFeildsType) => void;
+};
+/**
+ * Type for style props.
+ */
+export type StyleType = React.CSSProperties | undefined;
+/**
+ * Props for the AddTask component.
+ */
+export type AddTaskPropsType = {
+  /** ID of the group. */
+  groupId: string;
+  /** Additional styles for the add task button. */
+  addTaskStyle?: StyleType;
+  /** Additional class names for the add task button. */
+  addTaskClassName?: string;
+  /** Custom render function for adding a task. */
+  addTaskRender?: ({
+    groupId,
+    dayInfo,
+  }: {
+    groupId: string;
+    dayInfo: dayInfoType;
+  }) => React.ReactNode;
+  /** Information about the day. */
+  dayInfo: dayInfoType;
+  /** Handler function for adding a new task. */
+  handleAddTask?: (
+    groupId: string,
+    dayInfo: dayInfoType
+  ) => void;
+};
+/**
+ * Information about a day.
+ */
+export type dayInfoType = {
+  /** Position of the day. */
+  positionDay: number;
+  /** Date of the day. */
+  day: Date;
+  /** Start time of the day. */
+  start: number;
+  /** End time of the day. */
+  end: number;
+};
+/**
+ * Type for a task.
+ */
+export type TaskType = {
+  /** Start time of the task. */
+  taskStart: number;
+  /** End time of the task. */
+  taskEnd: number;
+  /** Description of the task. */
+  task: string;
+  /** Date of the task. */
+  taskDate: Date;
+  /** ID of the group the task belongs to. */
+  groupId: string;
+  /** Index of the day the task belongs to. */
+  dayIndex: number;
+  /** Unique identifier for the task. */
+  taskId: string;
+};
+/**
+ * Props for the TaskContainer component.
+ */
+export type TaskContainerPropsType = {
+  /** Additional class names for the task container. */
+  className?: string;
+  /** Additional styles for the task container. */
+  style?: React.CSSProperties | undefined;
+  /** Handler function for dragging a task. */
+  handleDragTask?: (
+    event: React.DragEvent&lt;HTMLDivElement>,
+    currentTask: TaskFeildsType
+  ) => void;
+  /** Custom render function for a task. */
+  taskRender?: ({
+    currentTask,
+    handleDragTask
+  }: {
+    currentTask: TaskFeildsType;
+    handleDragTask?: (
+      event: React.DragEvent&lt;HTMLDivElement>,
+      currentTask: TaskFeildsType
+    ) => void;
+  }) => React.ReactNode;
+  /** Handler function for ending the drag of a task. */
+  handleDragTaskEnd?:(
+    event: React.DragEvent&lt;HTMLDivElement>
+  ) => void;
+  /** The current task data. */
+  currentTask: TaskFeildsType;
+  /** Handler function for clicking a task. */
+  handleClickTask?: (currentTask: TaskFeildsType) => void;
+};
+/**
+ * Props for the GroupsHeadContainer component.
+ */
+export type GroupsHeadContainerPropsType = {
+  /** Custom render function for the groups header. */
+  groupsHeadRender?: () => React.ReactNode;
+  /** Additional styles for the groups header container. */
+  style?: React.CSSProperties | undefined;
+  /** Additional class names for the groups header container. */
+  className?: string;
+};
+/**
+ * Props for the SumHoursHeadContainer component.
+ */
+export type SumHoursHeadContainerPropsType = {
+  /** Custom render function for the sum hours header. */
+  sumHoursHeadRender?: () => React.ReactNode;
+  /** Additional styles for the sum hours header container. */
+  style?: React.CSSProperties | undefined;
+  /** Additional class names for the sum hours header container. */
+  className?: string;
+};
+/**
+ * Additional fields for a task.
+ */
+type TaskAdditionalFieldsType = Record&lt;any, unknown>;
+/**
+ * Fields for a task, including both required and additional fields.
+ */
+export type TaskFeildsType = TaskType &amp; TaskAdditionalFieldsType;
+/**
+ * Type for an array of tasks.
+ */
+export type TasksType = TaskFeildsType[];
+/**
+ * Handler function type for ending the drag of a task.
+ */
+export type handleDragTaskEndType = (
+  event: React.DragEvent&lt;HTMLDivElement>
+) => void;
+/**
+ * Props for the SumHoursContainer component.
+ */
+export type SumHoursContainerPropsType = {
+  /** ID of the group. */
+  groupId: string;
+  /** Array of tasks to be displayed in the calendar. */
+  tasks: TasksType;
+  /** Offset for the week (e.g., -7 for last week, 0 for current week, 7 for next week). */
+  weekOffset: number;
+  /** The current date to display in the calendar. */
+  calendarDate: Date;
+  /** Sum of hours for the group. */
+  sumHoursByGroups: number;
+  /** Custom render function for the sum of hours. */
+  sumHoursRender?: ({
+    groupId,
+    tasks,
+    weekOffset,
+    calendarDate,
+    sumHoursByGroups,
+  }: {
+    groupId: string;
+    tasks: TasksType;
+    weekOffset: number;
+    calendarDate: Date;
+    sumHoursByGroups: number;
+  }) => React.ReactNode;
+  /** Additional styles for the sum hours container. */
+  style?: React.CSSProperties | undefined;
+  /** Additional class names for the sum hours container. */
+  className?: string;
+};
+</code></pre>
+        </article>
+    </section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.3</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>

package/docs/scripts/app.min.js ADDED Viewed

@@ -0,0 +1 @@

+ "use strict";$().ready(function(){});var sidebarIsVisible=!1,toggleSidebar=function(e){var a=!(0<arguments.length&&void 0!==e)||e;$("#sidebarNav").toggleClass("sticky",a),$("#stickyNavbarOverlay").toggleClass("active",a),$("#hamburger").toggleClass("is-active"),sidebarIsVisible=a};$().ready(function(){$("#hamburger").click(function(){toggleSidebar(!sidebarIsVisible)}),$("#stickyNavbarOverlay").click(function(){sidebarIsVisible&&toggleSidebar(!1)})});var OFFSET=150;$().ready(function(){var o=$("#side-nav"),c=[];if($(".vertical-section").length||o.hide(),$(".vertical-section").each(function(e,a){var i=$(a),t=i.find("> h1").text();if(t){o.append($("<h3/>").text(t));var s=$("<ul></ul>");i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);s.append($("<li></li>").append(r)),c.push({link:r,offset:i.offset().top})}),o.append(s)}else i.find(".members h4.name").each(function(e,a){var i=$(a),t=i.find(".code-name").clone().children().remove().end().text(),n=i.find("a").attr("href"),r=$('<a href="'.concat(n,'" />')).text(t);o.append(r),c.push({link:r,offset:i.offset().top})})}),!$.trim(o.text()))return o.hide();function e(){for(var e=n.scrollTop(),a=!1,i=c.length-1;0<=i;i--){var t=c[i];t.link.removeClass("is-active"),e+OFFSET>=t.offset?a?t.link.addClass("is-past"):(t.link.addClass("is-active"),a=!0):t.link.removeClass("is-past")}}var n=$("#main-content-wrapper");n.on("scroll",e),e(),c.forEach(function(e){e.link.click(function(){n.animate({scrollTop:e.offset-OFFSET+1},500)})})}),$().ready(function(){$("#sidebarNav a").each(function(e,a){var i=$(a).attr("href");window.location.pathname.match("/"+i)&&($(a).addClass("active"),$("#sidebarNav").scrollTop($(a).offset().top-150))})});

package/docs/scripts/linenumber.js ADDED Viewed

@@ -0,0 +1,26 @@
+/*global document */
+(function() {
+    var source = document.getElementsByClassName('prettyprint source linenums');
+    var i = 0;
+    var lineNumber = 0;
+    var lineId;
+    var lines;
+    var totalLines;
+    var anchorHash;
+    if (source && source[0]) {
+        anchorHash = document.location.hash.substring(1);
+        lines = source[0].getElementsByTagName('li');
+        totalLines = lines.length;
+        for (; i < totalLines; i++) {
+            lineNumber++;
+            lineId = 'line' + lineNumber;
+            lines[i].id = lineId;
+            if (lineId === anchorHash) {
+                lines[i].className += ' selected';
+            }
+        }
+    }
+})();

package/docs/scripts/search.js ADDED Viewed

@@ -0,0 +1,39 @@
+(function() {
+  const input = document.querySelector('#search')
+  const targets = [ ...document.querySelectorAll('#sidebarNav li')]
+  input.addEventListener('keyup', () => {
+    // loop over each targets and hide the not corresponding ones
+    targets.forEach(target => {
+      if (!target.innerText.toLowerCase().includes(input.value.toLowerCase())) {
+        target.style.display = 'none'
+        /**
+         * Detects an empty list
+         * Remove the list and the list's title if the list is not displayed
+         */
+        const list = [...target.parentNode.childNodes].filter( elem => elem.style.display !== 'none')
+        if (!list.length) {
+          target.parentNode.style.display = 'none'
+          target.parentNode.previousSibling.style.display = 'none'
+        }
+        /**
+         * Detects empty category
+         * Remove the entire category if no item is displayed
+         */
+        const category = [...target.parentNode.parentNode.childNodes]
+          .filter( elem => elem.tagName !== 'H2' && elem.style.display !== 'none')
+        if (!category.length) {
+          target.parentNode.parentNode.style.display = 'none'
+        }
+      } else {
+        target.parentNode.style.display = 'block'
+        target.parentNode.previousSibling.style.display = 'block'
+        target.parentNode.parentNode.style.display = 'block'
+        target.style.display = 'block'
+      }
+    })
+  })
+})()