@availity/feedback 7.1.2 → 7.1.3

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [7.1.3](https://github.com/Availity/availity-react/compare/@availity/feedback@7.1.2...@availity/feedback@7.1.3) (2022-12-01)
+
+
+
 ## [7.1.2](https://github.com/Availity/availity-react/compare/@availity/feedback@7.1.1...@availity/feedback@7.1.2) (2022-08-08)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/feedback",
-  "version": "7.1.2",
+  "version": "7.1.3",
   "description": "Availity feedback with smiley faces react component.",
   "keywords": [
     "react",
@@ -25,7 +25,7 @@
     "publish:canary": "yarn npm publish --access public --tag canary"
   },
   "dependencies": {
-    "@availity/form": "1.5.1",
+    "@availity/form": "1.7.1",
     "@availity/hooks": "3.3.1",
     "@availity/icon": "0.11.1",
     "@availity/native-form": "^5.0.1",

package/src/Feedback.js

@@ -73,21 +73,32 @@ const Feedback = ({
 };
 
 Feedback.propTypes = {
+  analytics: PropTypes.shape({
+    info: PropTypes.func.isRequired,
+  }),
+  /** The name of the application this feedback is for. It is used in the API request to indicate where the feedback came from. */
   appName: PropTypes.string,
+  /** Whether to open the FeedbackForm in a modal */
   modal: PropTypes.bool,
+  /** Allows for overriding the z-indexvalue from react-strap Modalcomponent. */
   zIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+  /** Allows for overriding the z-index value from reactstrap Support Modal component. */
   supportZIndex: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+  /** The text to display on the submit button. */
   children: PropTypes.node,
   className: PropTypes.string,
+  /** Indicates if the button should use the "outline" styles or not. */
   outline: PropTypes.bool,
+  /** The color of the button. Default: "light". */
   color: PropTypes.string,
+  /** Props to be spread to the underlying FeedbackForm. See the FeedbackForm Props. */
   formProps: PropTypes.object,
+  /** Text that prompts the user to provider feedback. Default: "Tell us what you think about ${appName}.". */
   prompt: PropTypes.string,
+  /** Callback for when the feedback is submitted. It is called with the feedback object. */
   onFeedbackSent: PropTypes.func,
   onModalOpenChange: PropTypes.func,
-  analytics: PropTypes.shape({
-    info: PropTypes.func.isRequired,
-  }),
+  /** Toggle whether or not to show the "Open a Support ticket" link in the FeedbackForm */
   showSupport: PropTypes.bool,
 };
 

package/src/FeedbackForm.js

@@ -249,8 +249,14 @@ const FeedbackForm = ({
 };
 
 FeedbackForm.propTypes = {
+  /** The name of the application this feedback is for. It is used in the API request to indicate where the feedback came from. */
   name: PropTypes.string.isRequired,
+  /** Callback for when the feedback is submitted. It is called with the feedback object. */
   onFeedbackSent: PropTypes.func,
+  /** Array of Objects containing icon (String), description (String), and label (String) properties.
+   * Allows you to override the smiley face options which appear.
+   * Default: Smiley Face, Meh Face, and Frowny Face.
+   * Previous placeholder property removed as of v6.0.0. Use label instead. */
   faceOptions: PropTypes.arrayOf(
     PropTypes.shape({
       icon: PropTypes.string,
@@ -258,23 +264,37 @@ FeedbackForm.propTypes = {
       label: PropTypes.string,
     })
   ),
+  /** Array of Objects containing value (String,Number) and label (String) properties.
+   * Allows a dropdown displaying the options provided to let the user indicate what the feedback is about. */
   aboutOptions: PropTypes.arrayOf(
     PropTypes.shape({
       name: PropTypes.string,
       value: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
     })
   ),
+  /** Label text for the dropdown created via the aboutOptions prop. Default: "This is about".
+   *Previously aboutPlaceholder. All placeholders replaced with labels starting v6.0.0. */
   aboutLabel: PropTypes.node,
+  /** When provided, a "Close" button is rendered and onClose is excuted when it's clicked. */
   onClose: PropTypes.func,
+  /** Text that prompts the user to provider feedback. Default: "Tell us what you think about ${appName}.". */
   prompt: PropTypes.string,
+  /** If true, shows an optional comments field below. */
   additionalComments: PropTypes.bool,
+  /** Static (non-user-entered) key/value pairs to be sent in feedback submission. */
   staticFields: PropTypes.object,
+  /** Props to be spread onto the <ModalHeader /> rendered inside of the <FeedbackForm />. See ModalHeader
+   *For accessibility use className instead of tag to adjust size and style of header. */
   modalHeaderProps: PropTypes.shape({ ...ModalHeader.propTypes }),
+  /** Override the analytics instance that is passed in. Default avLogMessagesApi */
   analytics: PropTypes.shape({
     info: PropTypes.func.isRequired,
   }),
+  /** Toggle whether or not to show the "Open a Support ticket" link in the FeedbackForm */
   showSupport: PropTypes.bool,
   setSupportIsActive: PropTypes.func,
+  /** Default: true. When set to false, the first feedback button is not focused.
+   * This is to avoid issues with focus causing other elements to close (e.g. dropdowns) */
   autoFocusFeedbackButton: PropTypes.bool,
   modal: PropTypes.bool,
 };