@careevolution/mydatahelps-ui 2.23.1-HackDocs.1 → 2.23.1-HackDocs.2

package/dist/esm/types/components/container/AllergiesList/AllergiesList.d.ts

@@ -5,11 +5,9 @@ export interface AllergiesListProps {
     onViewTermInfo(termInfo: TermInformationReference): void;
     innerRef?: React.Ref<HTMLDivElement>;
 }
-/** A listing of allergies.
- *
- * @component
- * @param {AllergiesListProps}  properties for the component
- * @returns {JSX.Element}
+/** Allergy List. Displays a list of participant allergies derived from EHR Data
  *
+ * @param {AllergiesListProps} props - Property object for the component.
+ * @param {event} props.onViewTermInfo - A function that is called when the user clicks on the term information
 */
 export default function AllergiesList(props: AllergiesListProps): React.JSX.Element;

package/dist/esm/types/components/container/BloodPressureVisualization/BloodPressureVisualization.d.ts

@@ -10,11 +10,12 @@ export interface BloodPressureVisualizationProps {
     deviceDataSource?: BloodPressureDeviceDataSource[];
     innerRef?: React.Ref<HTMLDivElement>;
 }
-/** Blood Pressure Visualization. Displays daily systolic and diastolic blood pressure readings in a dumbbell chart
+/** Blood Pressure Visualization. Displays daily systolic and diastolic blood pressure readings in a dumbbell chart. Most ofen used with a DateRangeCoordinator to navigate through time.
  *
- * @component
- * @param {BloodPressureVisualizationProps} props	- Props for the component)
- * @returns {JSX.Element}
+ * @param {BloodPressureVisualizationProps} props - Property object for the component. Configure to use survey and/or device data
+ * @param {string} props.surveyDataSource - The survey that is the source of data. Required fields are surveyName, dateResultIdentifier, systolicResultIdentifier, and diastolicResultIdentifier
+ * @param {string} props.weekStartsOn - The weekday name that the chart should start on. Default is Monday
+ * @param {string} props.deviceDataSource - An array of supported devices. AppleHealth, GoogleFit, and Omron are supported
  *
 */
 export default function BloodPressureVisualization(props: BloodPressureVisualizationProps): React.JSX.Element;

package/dist/esm/types/components/container/ConditionsList/ConditionsList.d.ts

@@ -5,4 +5,9 @@ export interface ConditionsListProps {
     onViewTermInfo(termInfo: TermInformationReference): void;
     innerRef?: React.Ref<HTMLDivElement>;
 }
+/** Conditions List. Displays a list of participant conditions derived from EHR Data
+ *
+ * @param {ConditionsListProps} props - Property object for the component. Configure to use survey and/or device data
+ * @param {event} props.onViewTermInfo - A function that is called when the user clicks on the condition
+*/
 export default function (props: ConditionsListProps): React.JSX.Element;

package/dist/esm/types/components/container/ConnectDevicesMenu/ConnectDevicesMenu.d.ts

@@ -11,4 +11,12 @@ export interface ConnectDevicesMenuProps {
     headerVariant?: "large" | "medium";
     connectExternalAccountOptions?: ConnectExternalAccountOptions;
 }
+/** Connect Devices Menu. Allows the user to establish connections for sharing data from wearables, apps, and other devices.
+ *
+ * @param {ConnectDevicesMenuProps} props - Property object for the component.
+ * @param {string[]} props.accountTypes - One or more of the following account types. Fitbit, Garmin, AppleHealth, GoogleFit, "Omron
+ * @param {string} props.title - A title for the component
+ * @param {string} props.text - Text that shows under the title
+ * @param {string} props.headerVariant - The size of the title. "large" or "medium"
+*/
 export default function (props: ConnectDevicesMenuProps): React.JSX.Element | null;

package/dist/esm/types/components/container/ConnectEhr/ConnectEhr.d.ts

@@ -17,4 +17,16 @@ export interface ConnectEhrProps {
     onClick?: () => void;
 }
 export type ConnectEhrPreviewState = "notEnabled" | "enabled" | "enabledConnected" | "enabledNeedsAttention";
+/** Connect EHR Menu. Allows the user to establish connections to their EHR.
+ *
+ * @param {ConnectEhrProps} props - Property object for the component.
+ * @param {string} props.applicationUrl - The url that the user will be directed to when they click the Connect Provider button. Use as an alternative to onClick
+ * @param {event} props.onClick - A custom onClick event for the Connect Provider button. Use as an alternative to applicationUrl
+ * @param {string} props.disabledBehavior - Use 'hide' or 'displayError' to determine how the component behaves when EHR is not enabled
+ * @param {string} props.title - Text to show as the Title of the component
+ * @param {string} props.variant - The size of the presentation. 'large' | 'medium' | 'small'
+ * @param {string} props.notConnectedText - Customize the text displayed when the user is not connected to an EHR
+ * @param {string} props.connectedText - Customize the text displayed when the user is connected to an EHR
+ * @param {boolean} props.hideWhenConnected - Boolean value. Hides the component when the state is connected
+*/
 export default function (props: ConnectEhrProps): React.JSX.Element | null;

package/dist/esm/types/components/container/SeverityCalendar/SeverityCalendar.d.ts

@@ -9,4 +9,12 @@ export interface SeverityCalendarProps {
     previewState?: SeverityCalendarPreviewState;
     innerRef?: React.Ref<HTMLDivElement>;
 }
+/** Severity Calendar. A calendar that color codes a survey step response to reflects Mild/Moderate/Severe.
+ *
+ * @param {SeverityCalendarProps} props - Property object for the component.
+ * @param {string} props.surveyName - The name of the survey
+ * @param {string} props.dateRecordedResultIdentifier - The identifier for the date recorded result. If not provided, the date the survey was submitted will be used.
+ * @param {string} props.severityResultIdentifier - The identifier for the result that contains the severity value. Defaults are Mild, Moderate, Severe though any values can be mapped to these categories.
+ * @param {date} props.intervalStart - The start date for the calendar. If used with a DateRangeCoordinator, this value can be left undefined.
+*/
 export default function (props: SeverityCalendarProps): React.JSX.Element;

package/dist/index.d.ts

@@ -894,12 +894,10 @@ interface AllergiesListProps {
     onViewTermInfo(termInfo: TermInformationReference): void;
     innerRef?: React$1.Ref<HTMLDivElement>;
 }
-/** A listing of allergies.
- *
- * @component
- * @param {AllergiesListProps}  properties for the component
- * @returns {JSX.Element}
+/** Allergy List. Displays a list of participant allergies derived from EHR Data
  *
+ * @param {AllergiesListProps} props - Property object for the component.
+ * @param {event} props.onViewTermInfo - A function that is called when the user clicks on the term information
 */
 declare function AllergiesList(props: AllergiesListProps): React$1.JSX.Element;
 
@@ -935,11 +933,12 @@ interface BloodPressureVisualizationProps {
     deviceDataSource?: BloodPressureDeviceDataSource[];
     innerRef?: React$1.Ref<HTMLDivElement>;
 }
-/** Blood Pressure Visualization. Displays daily systolic and diastolic blood pressure readings in a dumbbell chart
+/** Blood Pressure Visualization. Displays daily systolic and diastolic blood pressure readings in a dumbbell chart. Most ofen used with a DateRangeCoordinator to navigate through time.
  *
- * @component
- * @param {BloodPressureVisualizationProps} props	- Props for the component)
- * @returns {JSX.Element}
+ * @param {BloodPressureVisualizationProps} props - Property object for the component. Configure to use survey and/or device data
+ * @param {string} props.surveyDataSource - The survey that is the source of data. Required fields are surveyName, dateResultIdentifier, systolicResultIdentifier, and diastolicResultIdentifier
+ * @param {string} props.weekStartsOn - The weekday name that the chart should start on. Default is Monday
+ * @param {string} props.deviceDataSource - An array of supported devices. AppleHealth, GoogleFit, and Omron are supported
  *
 */
 declare function BloodPressureVisualization(props: BloodPressureVisualizationProps): React$1.JSX.Element;
@@ -949,6 +948,11 @@ interface ConditionsListProps {
     onViewTermInfo(termInfo: TermInformationReference): void;
     innerRef?: React$1.Ref<HTMLDivElement>;
 }
+/** Conditions List. Displays a list of participant conditions derived from EHR Data
+ *
+ * @param {ConditionsListProps} props - Property object for the component. Configure to use survey and/or device data
+ * @param {event} props.onViewTermInfo - A function that is called when the user clicks on the condition
+*/
 declare function export_default$1s(props: ConditionsListProps): React$1.JSX.Element;
 
 type DeviceAccountType = "Fitbit" | "Garmin" | "AppleHealth" | "GoogleFit" | "Omron";
@@ -961,6 +965,14 @@ interface ConnectDevicesMenuProps {
     headerVariant?: "large" | "medium";
     connectExternalAccountOptions?: ConnectExternalAccountOptions;
 }
+/** Connect Devices Menu. Allows the user to establish connections for sharing data from wearables, apps, and other devices.
+ *
+ * @param {ConnectDevicesMenuProps} props - Property object for the component.
+ * @param {string[]} props.accountTypes - One or more of the following account types. Fitbit, Garmin, AppleHealth, GoogleFit, "Omron
+ * @param {string} props.title - A title for the component
+ * @param {string} props.text - Text that shows under the title
+ * @param {string} props.headerVariant - The size of the title. "large" or "medium"
+*/
 declare function export_default$1r(props: ConnectDevicesMenuProps): React$1.JSX.Element | null;
 
 interface ConnectEhrProps {
@@ -978,6 +990,18 @@ interface ConnectEhrProps {
     onClick?: () => void;
 }
 type ConnectEhrPreviewState = "notEnabled" | "enabled" | "enabledConnected" | "enabledNeedsAttention";
+/** Connect EHR Menu. Allows the user to establish connections to their EHR.
+ *
+ * @param {ConnectEhrProps} props - Property object for the component.
+ * @param {string} props.applicationUrl - The url that the user will be directed to when they click the Connect Provider button. Use as an alternative to onClick
+ * @param {event} props.onClick - A custom onClick event for the Connect Provider button. Use as an alternative to applicationUrl
+ * @param {string} props.disabledBehavior - Use 'hide' or 'displayError' to determine how the component behaves when EHR is not enabled
+ * @param {string} props.title - Text to show as the Title of the component
+ * @param {string} props.variant - The size of the presentation. 'large' | 'medium' | 'small'
+ * @param {string} props.notConnectedText - Customize the text displayed when the user is not connected to an EHR
+ * @param {string} props.connectedText - Customize the text displayed when the user is connected to an EHR
+ * @param {boolean} props.hideWhenConnected - Boolean value. Hides the component when the state is connected
+*/
 declare function export_default$1q(props: ConnectEhrProps): React$1.JSX.Element | null;
 
 interface ConnectFitbitProps {
@@ -1461,6 +1485,14 @@ interface SeverityCalendarProps {
     previewState?: SeverityCalendarPreviewState;
     innerRef?: React$1.Ref<HTMLDivElement>;
 }
+/** Severity Calendar. A calendar that color codes a survey step response to reflects Mild/Moderate/Severe.
+ *
+ * @param {SeverityCalendarProps} props - Property object for the component.
+ * @param {string} props.surveyName - The name of the survey
+ * @param {string} props.dateRecordedResultIdentifier - The identifier for the date recorded result. If not provided, the date the survey was submitted will be used.
+ * @param {string} props.severityResultIdentifier - The identifier for the result that contains the severity value. Defaults are Mild, Moderate, Severe though any values can be mapped to these categories.
+ * @param {date} props.intervalStart - The start date for the calendar. If used with a DateRangeCoordinator, this value can be left undefined.
+*/
 declare function export_default$Y(props: SeverityCalendarProps): React$1.JSX.Element;
 
 interface ViewEhrProps {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@careevolution/mydatahelps-ui",
-  "version": "2.23.1-HackDocs.1",
+  "version": "2.23.1-HackDocs.2",
   "description": "MyDataHelps UI Library",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",