@availity/page-header 11.3.1 → 11.3.3

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.3.3](https://github.com/Availity/availity-react/compare/@availity/page-header@11.3.2...@availity/page-header@11.3.3) (2023-07-20)
+
+
+### Bug Fixes
+
+* **page-header:** fix link ([10dd984](https://github.com/Availity/availity-react/commit/10dd984614b1526ed993ada96a220ebcbe81e9c1))
+
+
+
+## [11.3.2](https://github.com/Availity/availity-react/compare/@availity/page-header@11.3.1...@availity/page-header@11.3.2) (2023-01-25)
+
+
+
 ## [11.3.1](https://github.com/Availity/availity-react/compare/@availity/page-header@11.3.0...@availity/page-header@11.3.1) (2022-06-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/page-header",
-  "version": "11.3.1",
+  "version": "11.3.3",
   "description": "The standard page header for Availity Portal Applications",
   "keywords": [
     "react",
@@ -26,17 +26,17 @@
     "publish:canary": "yarn npm publish --access public --tag canary"
   },
   "dependencies": {
-    "@availity/app-icon": "1.6.1",
-    "@availity/breadcrumbs": "3.3.1",
-    "@availity/feedback": "7.1.1",
-    "@availity/payer-logo": "5.2.1",
+    "@availity/app-icon": "1.6.2",
+    "@availity/breadcrumbs": "3.3.3",
+    "@availity/feedback": "7.1.6",
+    "@availity/payer-logo": "5.2.2",
     "classnames": "^2.3.1",
     "prop-types": "^15.8.1"
   },
   "devDependencies": {
     "@availity/api-axios": "^7.0.1",
-    "@availity/spaces": "6.1.1",
-    "@availity/training-link": "1.5.1",
+    "@availity/spaces": "6.5.9",
+    "@availity/training-link": "1.7.1",
     "axios": "^0.21.4",
     "formik": "^2.2.9",
     "react": "^17.0.2",

package/src/PageHeader.js

@@ -133,21 +133,37 @@ const PageHeader = ({
 };
 
 PageHeader.propTypes = {
-  className: PropTypes.string,
+  /** Name of the application. */
   appName: PropTypes.string.isRequired,
+  /** The name of the class. */
+  className: PropTypes.string,
+  /** Payer Space Name of the space in which this page is under. */
   spaceName: PropTypes.string,
+  /** Payer Space ID of the space in which this page is under. */
   spaceId: PropTypes.string,
+  /** If provided and payerId is not provided, the app icon will appear. */
   appAbbr: PropTypes.string,
+  /** Potential values: "black", "blue", "green", "orange", "red". Only used if the app icon should appear. Default: "black". */
   iconColor: PropTypes.string,
+  /** Triggers the app icon's "branded" styles. Only used if the app icon should appear. */
   branded: PropTypes.bool,
+  /** The ID of the payer the application is for. If provided, the payer logo appears and not the app icon. */
   payerId: PropTypes.string,
+  /** Allow rendering of an optional component in the top right of the header. */
   component: PropTypes.element,
+  /** If true, the feedback loop button appears. */
   feedback: PropTypes.bool,
+  /** See Feedback. Props to send to <Feedback /> component */
   feedbackProps: PropTypes.shape({ ...Feedback.propTypes }),
+  /** Additional props passed to the page-header-title. */
   titleProps: PropTypes.object,
+  /** This value appears at the h1 of the page. Overrides the appName to allow for custom elements (such as a "beta" tag). Default: ${appName}. */
   children: PropTypes.node,
+  /** Custom link tag for the links. Default: <a> */
   linkTag: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
+  /** Flag whether or not to show the breadcrumbs. Default: true */
   showCrumbs: PropTypes.bool,
+  /** Array of Objects containing name (String) and url (String) properties. The ancestor pages which get passed to the Breadcrumbs component. See Breadcrumbs */
   crumbs: PropTypes.oneOfType([
     PropTypes.arrayOf(
       PropTypes.shape({
@@ -157,13 +173,21 @@ PageHeader.propTypes = {
     ),
     PropTypes.node,
   ]),
+  /** If true will fetch the payer logo using the spaceId or payerId. */
   logo: PropTypes.bool,
+  /** The tag to render the page header as. Default: <h1>. */
   tag: PropTypes.oneOfType([PropTypes.func, PropTypes.string]),
+  /** Used to customize the contents of the right side of the page header where the feedback and payer logo get rendered. Accepts the rendered payerLogo and feedback as props */
   renderRightContent: PropTypes.func,
+  /** Renders the name of the right side of the page header */
   renderRightClassName: PropTypes.string,
+  /** Url for the Home route. Default: public/apps/dashboard. */
   homeUrl: PropTypes.string,
+  /** Client ID to use in Spaces to fetch the payer's logo */
   clientId: PropTypes.string,
+  /** Image source for <AppIcon /> to be used instead of appAbbr. */
   iconSrc: PropTypes.string,
+  /** Required if iconSrc is used. Image alt property of <AppIcon /> */
   iconAlt: PropTypes.string,
 };