@trackunit/react-components 0.0.114 → 0.0.115

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.
@@ -23,6 +23,10 @@ export interface ModalProps extends CommonProps {
23
23
  */
24
24
  maxWidth?: ModalWidth;
25
25
  }
26
- /** Preferred usage is with useModal(), so the modal is placed at highest level. */
26
+ /**
27
+ * - Modals are used to present critical information or request user input needed to complete a user's workflow.
28
+ * - Modals interrupt a user's workflow by design.
29
+ * - The modal component provides a foundation for creating dialogs, lightboxes, etc.
30
+ */
27
31
  export declare const Modal: React.ForwardRefExoticComponent<ModalProps & React.RefAttributes<HTMLDivElement>>;
28
32
  export {};
package/index.js CHANGED
@@ -2913,7 +2913,11 @@ const Backdrop = tw(animated.div)`
2913
2913
  tu-modal-backdrop
2914
2914
  `;
2915
2915
 
2916
- /** Preferred usage is with useModal(), so the modal is placed at highest level. */
2916
+ /**
2917
+ * - Modals are used to present critical information or request user input needed to complete a user's workflow.
2918
+ * - Modals interrupt a user's workflow by design.
2919
+ * - The modal component provides a foundation for creating dialogs, lightboxes, etc.
2920
+ */
2917
2921
 
2918
2922
  const Modal = React.forwardRef(({
2919
2923
  isOpen,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-components",
3
- "version": "0.0.114",
3
+ "version": "0.0.115",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "dependencies": {