@hedia/recommendation-screen 2.1.15 → 2.1.17-alpha

package/coverage/lcov-report/src/components/TwoOptionModal.tsx.html

@@ -25,7 +25,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>6/6</span>
+                <span class='fraction'>5/5</span>
             </div>
         
             
@@ -39,14 +39,14 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>2/2</span>
+                <span class='fraction'>1/1</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>6/6</span>
+                <span class='fraction'>5/5</span>
             </div>
         
             
@@ -244,7 +244,15 @@
 <a name='L185'></a><a href='#L185'>185</a>
 <a name='L186'></a><a href='#L186'>186</a>
 <a name='L187'></a><a href='#L187'>187</a>
-<a name='L188'></a><a href='#L188'>188</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L188'></a><a href='#L188'>188</a>
+<a name='L189'></a><a href='#L189'>189</a>
+<a name='L190'></a><a href='#L190'>190</a>
+<a name='L191'></a><a href='#L191'>191</a>
+<a name='L192'></a><a href='#L192'>192</a>
+<a name='L193'></a><a href='#L193'>193</a>
+<a name='L194'></a><a href='#L194'>194</a>
+<a name='L195'></a><a href='#L195'>195</a>
+<a name='L196'></a><a href='#L196'>196</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -267,7 +275,14 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-yes">13x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -328,6 +343,7 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -441,22 +457,29 @@ import { stylesModal } from "./RecommendationModal";
 const { TwoOptionModalTestIds } = Testing.Id;
 &nbsp;
 export interface ITwoOptionModalProps {
+	/** The title of the modal. */
 	title: string;
+	/** The message to show in the modal. */
 	message: string;
+	/** The label of the first option. */
 	textFirstOption: string;
+	/**  The label of the second option. */
 	textSecondOption: string;
+	/** Whether or not the modal shall have a cancel button in the corner to close the modal. */
 	isCancelable?: boolean;
+	/**  If true the buttons will be displayed side-by-side. If false the buttons will be displayed on top of each other. */
 	rowAsButtonLayout: boolean;
+	/** To be called if the user taps the first option button. */
 	firstOption(): void;
+	/** To be called if the user taps the second option button. */
 	secondOption(): void;
+	/** To be called if the user taps the optionally shown close button. */
 	onClose?(): void;
 }
 &nbsp;
+/** Display a modal with two buttons for the user to choose between. */
 export default class TwoOptionModal extends React.Component&lt;ITwoOptionModalProps&gt; {
-	constructor(props: ITwoOptionModalProps) {
-		super(props);
-	}
-&nbsp;
+	/** Compose a JSX element for displaying the modal. */
 	public render(): JSX.Element {
 		const { rowAsButtonLayout, isCancelable } = this.props;
 		return (
@@ -515,6 +538,7 @@ export default class TwoOptionModal extends React.Component&lt;ITwoOptionModalPr
 	}
 }
 const { height, width } = Dimensions.get(`screen`);
+/** @internal */
 export const modalStyle = StyleSheet.create({
 	container: {
 		...StyleSheet.absoluteFillObject,
@@ -625,7 +649,7 @@ export const modalStyle = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../prettify.js"></script>

package/coverage/lcov-report/src/components/activity/Activity.tsx.html

@@ -137,7 +137,41 @@
 <a name='L78'></a><a href='#L78'>78</a>
 <a name='L79'></a><a href='#L79'>79</a>
 <a name='L80'></a><a href='#L80'>80</a>
-<a name='L81'></a><a href='#L81'>81</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L81'></a><a href='#L81'>81</a>
+<a name='L82'></a><a href='#L82'>82</a>
+<a name='L83'></a><a href='#L83'>83</a>
+<a name='L84'></a><a href='#L84'>84</a>
+<a name='L85'></a><a href='#L85'>85</a>
+<a name='L86'></a><a href='#L86'>86</a>
+<a name='L87'></a><a href='#L87'>87</a>
+<a name='L88'></a><a href='#L88'>88</a>
+<a name='L89'></a><a href='#L89'>89</a>
+<a name='L90'></a><a href='#L90'>90</a>
+<a name='L91'></a><a href='#L91'>91</a>
+<a name='L92'></a><a href='#L92'>92</a>
+<a name='L93'></a><a href='#L93'>93</a>
+<a name='L94'></a><a href='#L94'>94</a>
+<a name='L95'></a><a href='#L95'>95</a>
+<a name='L96'></a><a href='#L96'>96</a>
+<a name='L97'></a><a href='#L97'>97</a>
+<a name='L98'></a><a href='#L98'>98</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -217,22 +251,39 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { t } from "@lingui/macro";
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Activity as ActivityTypes, BolusCalculator } from "@hedia/types";
+import { t } from "@lingui/macro";
 import React from "react";
 import { Dimensions, StyleSheet, Text, View } from "react-native";
 import { i18n } from "../../locale/i18nUtils";
 import { Testing } from "../../types/enum";
-import { IActivityDisplayProps, IActivityParams, ReductionType } from "../../types/types";
+import { IActivityDisplayProps } from "../../types/types";
 import { infoStyles } from "../InfoBars";
 import ActivityIcon from "./ActivityIcon";
 import ActivityIntensity from "./ActivityIntensity";
 &nbsp;
-interface IProps extends IActivityDisplayProps {
-	activity: IActivityParams;
-	activityReduction: ReductionType;
+export interface IProps extends IActivityDisplayProps {
+	/** Details about the activity that affect the calculation */
+	activity: BolusCalculator.Types.IActivityParams;
+	/** The fraction (in the interval [0; 1]) by which the insulin recommendation is being reduced due to physical activity */
+	activityReduction: ActivityTypes.Types.ReductionType;
 }
 &nbsp;
+/**
+ * Component for displaying a summary of the entered physical activity along with the effect it has on the insulin recommendation.
+ */
 export default class Activity extends React.Component&lt;IProps&gt; {
+	/**
+	 * Steps:
+	 * 1. Unpack activity, activityType, activityReduction, and activityTitle from props.
+	 * 2. Compute the reductionPercentage by multiplying the activityReduction prop by 100 and rounding to the nearest integer.
+	 * 3. Generate and return the JSX element to display the following on the screen:
+	 * 	- Print the activity duration.
+	 * 	- Display the ActivityIcon that corresponds to the type of activity.
+	 * 	- Display the ActivityIntensity for the activity.
+	 * 	- Print the reductionPercentage.
+	 * @returns JSX Element containing all the user's physical activity details
+	 */
 	public render(): JSX.Element {
 		const { activity, activityType, activityReduction, activityTitle } = this.props;
 		const reductionPercentage = ((activityReduction ?? 0) * 100).toFixed(0);
@@ -304,7 +355,7 @@ const activityStyles = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/components/activity/ActivityIcon.tsx.html

@@ -111,7 +111,20 @@
 <a name='L52'></a><a href='#L52'>52</a>
 <a name='L53'></a><a href='#L53'>53</a>
 <a name='L54'></a><a href='#L54'>54</a>
-<a name='L55'></a><a href='#L55'>55</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L55'></a><a href='#L55'>55</a>
+<a name='L56'></a><a href='#L56'>56</a>
+<a name='L57'></a><a href='#L57'>57</a>
+<a name='L58'></a><a href='#L58'>58</a>
+<a name='L59'></a><a href='#L59'>59</a>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -120,6 +133,7 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">2x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -129,11 +143,23 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">21x</span>
 <span class="cline-any cline-yes">25x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">25x</span>
 <span class="cline-any cline-yes">25x</span>
 <span class="cline-any cline-yes">25x</span>
@@ -174,7 +200,8 @@ import { IActivityDisplayProps } from "../../types/types";
 &nbsp;
 const { Other } = Activity.Enums.ActivityEnum;
 &nbsp;
-const ACTIVITY_ICONS: Record&lt;Activity.Enums.ActivityEnum, ImageURISource&gt; = {
+/** Mapping from ActivityEnums to corresponding image resource. */
+export const ACTIVITY_ICONS: Record&lt;Activity.Enums.ActivityEnum, ImageURISource&gt; = {
 	Run: require(`../../assets/activity/Runner.png`),
 	Walk: require(`../../assets/activity/Walk.png`),
 	Cycling: require(`../../assets/activity/Cyclist.png`),
@@ -182,11 +209,23 @@ const ACTIVITY_ICONS: Record&lt;Activity.Enums.ActivityEnum, ImageURISource&gt;
 	Other: require(`../../assets/activity/Other.png`),
 };
 &nbsp;
+/** Component used to displat the user's physical activity type icon */
 export default class ActivityIcon extends React.Component&lt;IActivityDisplayProps&gt; {
+	/**
+	 * @returns The value from the ACTIVITY_ICONS constant that corresponds to the value of the activityType prop.
+	 */
 	public getActivityIcon = (): ImageURISource =&gt; {
 		return ACTIVITY_ICONS[this.props.activityType ?? Other];
 	};
 &nbsp;
+	/**
+	 * Steps:
+	 * 1. Unpack activityType and activityTitle from props.
+	 * 2. Create an accessibility label string by appending ‘_activity’ to the enum label corresponding to the activityType prop.
+	 * @returns A JSX element including the following:
+	 * 1. An image component with the generated accessibility label displaying the icon from getActivityIcon().
+	 * 2. The activityTitle if it is truthy or the string “Untitled Activity” otherwise
+	 */
 	public render(): JSX.Element | null {
 		const { activityType, activityTitle } = this.props;
 		const label = `${Activity.Enums.ActivityEnum[activityType ?? Other]}_activity`;
@@ -226,7 +265,7 @@ const activityIconStyles = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/components/activity/ActivityIntensity.tsx.html

@@ -116,7 +116,23 @@
 <a name='L57'></a><a href='#L57'>57</a>
 <a name='L58'></a><a href='#L58'>58</a>
 <a name='L59'></a><a href='#L59'>59</a>
-<a name='L60'></a><a href='#L60'>60</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L60'></a><a href='#L60'>60</a>
+<a name='L61'></a><a href='#L61'>61</a>
+<a name='L62'></a><a href='#L62'>62</a>
+<a name='L63'></a><a href='#L63'>63</a>
+<a name='L64'></a><a href='#L64'>64</a>
+<a name='L65'></a><a href='#L65'>65</a>
+<a name='L66'></a><a href='#L66'>66</a>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -175,18 +191,26 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
-<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Activity } from "@hedia/types";
+<span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import { Activity, BolusCalculator } from "@hedia/types";
 import React from "react";
 import { Dimensions, StyleSheet, Text, View } from "react-native";
-import { IActivityParams } from "../../types/types";
+import {} from "../../types/types";
 import { ActivityIntensityTranslations } from "../../utils/Translations";
 import { infoStyles } from "../InfoBars";
 &nbsp;
-interface IProps {
-	activityIntensity: IActivityParams["activityIntensity"];
+export interface IProps {
+	/** - Indicates the intensity of the activity. */
+	activityIntensity: BolusCalculator.Types.IActivityParams["activityIntensity"];
 }
 &nbsp;
+/** Component used to display the users's physical activity intensity on its corresponding background color */
 export default class ActivityIntensity extends React.Component&lt;IProps&gt; {
+	/**
+	 * Steps:
+	 * 1. Set intensity to the activityIntensity prop.
+	 * 2. Set the style variable to the style that correspond to the intensity.
+	 * @returns JSX element that displays the intensity of the user’s activity along with the associated color coding
+	 */
 	public render = (): JSX.Element =&gt; {
 		const intensity = this.props.activityIntensity;
 		const style = activityIntensityStyles[intensity];
@@ -241,7 +265,7 @@ const activityIntensityStyles = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/components/activity/index.html

@@ -125,7 +125,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>

package/coverage/lcov-report/src/components/index.html

@@ -25,7 +25,7 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Statements</span>
-                <span class='fraction'>164/164</span>
+                <span class='fraction'>162/162</span>
             </div>
         
             
@@ -39,14 +39,14 @@
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Functions</span>
-                <span class='fraction'>45/45</span>
+                <span class='fraction'>43/43</span>
             </div>
         
             
             <div class='fl pad1y space-right2'>
                 <span class="strong">100% </span>
                 <span class="quiet">Lines</span>
-                <span class='fraction'>164/164</span>
+                <span class='fraction'>162/162</span>
             </div>
         
             
@@ -198,13 +198,13 @@
 	<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
 	</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="28" class="abs high">28/28</td>
+	<td data-value="27" class="abs high">27/27</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="18" class="abs high">18/18</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="7" class="abs high">7/7</td>
+	<td data-value="6" class="abs high">6/6</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="28" class="abs high">28/28</td>
+	<td data-value="27" class="abs high">27/27</td>
 	</tr>
 
 <tr>
@@ -243,13 +243,13 @@
 	<div class="chart"><div class="cover-fill cover-full" style="width: 100%"></div><div class="cover-empty" style="width: 0%"></div></div>
 	</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="6" class="abs high">6/6</td>
+	<td data-value="5" class="abs high">5/5</td>
 	<td data-value="100" class="pct high">100%</td>
 	<td data-value="16" class="abs high">16/16</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="2" class="abs high">2/2</td>
+	<td data-value="1" class="abs high">1/1</td>
 	<td data-value="100" class="pct high">100%</td>
-	<td data-value="6" class="abs high">6/6</td>
+	<td data-value="5" class="abs high">5/5</td>
 	</tr>
 
 </tbody>
@@ -260,7 +260,7 @@
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../prettify.js"></script>

package/coverage/lcov-report/src/components/mood/Emotion.tsx.html

@@ -123,7 +123,32 @@
 <a name='L64'></a><a href='#L64'>64</a>
 <a name='L65'></a><a href='#L65'>65</a>
 <a name='L66'></a><a href='#L66'>66</a>
-<a name='L67'></a><a href='#L67'>67</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
+<a name='L67'></a><a href='#L67'>67</a>
+<a name='L68'></a><a href='#L68'>68</a>
+<a name='L69'></a><a href='#L69'>69</a>
+<a name='L70'></a><a href='#L70'>70</a>
+<a name='L71'></a><a href='#L71'>71</a>
+<a name='L72'></a><a href='#L72'>72</a>
+<a name='L73'></a><a href='#L73'>73</a>
+<a name='L74'></a><a href='#L74'>74</a>
+<a name='L75'></a><a href='#L75'>75</a>
+<a name='L76'></a><a href='#L76'>76</a>
+<a name='L77'></a><a href='#L77'>77</a>
+<a name='L78'></a><a href='#L78'>78</a>
+<a name='L79'></a><a href='#L79'>79</a>
+<a name='L80'></a><a href='#L80'>80</a>
+<a name='L81'></a><a href='#L81'>81</a>
+<a name='L82'></a><a href='#L82'>82</a>
+<a name='L83'></a><a href='#L83'>83</a>
+<a name='L84'></a><a href='#L84'>84</a>
+<a name='L85'></a><a href='#L85'>85</a>
+<a name='L86'></a><a href='#L86'>86</a>
+<a name='L87'></a><a href='#L87'>87</a>
+<a name='L88'></a><a href='#L88'>88</a>
+<a name='L89'></a><a href='#L89'>89</a>
+<a name='L90'></a><a href='#L90'>90</a>
+<a name='L91'></a><a href='#L91'>91</a>
+<a name='L92'></a><a href='#L92'>92</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -138,10 +163,32 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">69x</span>
 <span class="cline-any cline-yes">8x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">69x</span>
 <span class="cline-any cline-yes">1440x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -163,6 +210,9 @@
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
+<span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-yes">144x</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
 <span class="cline-any cline-neutral">&nbsp;</span>
@@ -198,16 +248,38 @@ import MoodIcon from "./MoodIcon";
 &nbsp;
 const MoodEnum = Logbook.Enums.MoodEnum;
 &nbsp;
-interface IProps {
+export interface IProps {
+	/** Indicates which mood if any that is currently selected. */
 	currentMood: Logbook.Enums.MoodEnum | null;
+	/**
+	 * Callback function to call when the selected icon changes. Takes a single optional argument, mood, which is a {@link Logbook.Enums.MoodEnum} | null.
+	 * Doesn’t have a return value.
+	 * */
 	moodSelected(mood: Logbook.Enums.MoodEnum | null): void;
 }
 &nbsp;
+/** The Emotion component displays a horizontally arranged set of icons representing various moods and allows the user to select one. */
 export default class Emotion extends React.Component&lt;IProps&gt; {
+	/**
+	 * Handle what should happen when the user picks taps on one of the mood icons.
+	 *
+	 * Steps:
+	 * 1. Call the moodSelected prop callback function with selected as argument if toggle is true and null as argument otherwise.
+	 * @param selected Integer number that represents the icon that was tapped.
+	 * @param toggle Boolean indicating whether the icon should be deselected.
+	 */
 	public handleIconPress = (selected: Logbook.Enums.MoodEnum, toggle: boolean): void =&gt; {
 		this.props.moodSelected(toggle ? selected : null);
 	};
 &nbsp;
+	/**
+	 * Compose a sequence of MoodIcons
+	 *
+	 * Steps:
+	 * 1. Make a sequence of MoodEnum values from the properties of the MoodEnum object and save the sequence as a variable named values.
+	 * 2. Map each of the elements of the values sequence to a MoodIcon.
+	 * @returns JSX Element consisting of an array of MoodIcon components.
+	 */
 	public mappedMoods = (): Array&lt;JSX.Element&gt; =&gt; {
 		const values = Object.values(MoodEnum).filter((val): boolean =&gt; isNaN(Number(val))) as Array&lt;
 			keyof typeof MoodEnum
@@ -228,6 +300,9 @@ export default class Emotion extends React.Component&lt;IProps&gt; {
 		);
 	};
 &nbsp;
+	/**
+	 * @returns JSX element to display the mood icons from mappedMoods() in a horizontal arrangement.
+	 */
 	public render(): JSX.Element {
 		return (
 			&lt;View style={emotionStyles.container}&gt;
@@ -262,7 +337,7 @@ const emotionStyles = StyleSheet.create({
             <div class='footer quiet pad2 space-top1 center small'>
                 Code coverage generated by
                 <a href="https://istanbul.js.org/" target="_blank">istanbul</a>
-                at Fri Jul 09 2021 12:31:53 GMT+0000 (Coordinated Universal Time)
+                at Mon Aug 16 2021 10:59:26 GMT+0000 (Coordinated Universal Time)
             </div>
         </div>
         <script src="../../../prettify.js"></script>