@wistia/vhs 2.59.1-beta.5f931870.ae1f3bf → 2.59.1-beta.909aef57.3734806

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.
@@ -83,7 +83,14 @@ export type ActionModalProps = ComponentPropsWithoutRef<'div'> & {
83
83
  width?: string;
84
84
  };
85
85
  /**
86
- * @deprecated Please use Modal component, see https://wistia.github.io/vhs/?path=/docs/components-modal--docs for documentation
86
+ * @deprecated Please use Modal component, see [documentation](?path=/docs/components-modal--docs).
87
+ *
88
+ * #### Why ActionModal is being deprecated
89
+ * ActionModal's API tightly couples the modal itself with the button or element that toggles it. This makes it difficult to
90
+ * implement in several scenarios (such as within a Menu) or if it needs to be programatically opened by an external action.
91
+ *
92
+ * [Modal](?path=/docs/components-modal--docs) allows for a separate state control to toggle its visibility and is also more composable
93
+ * allowing for more variation.
87
94
  */
88
95
  export declare const ActionModal: {
89
96
  ({ alignHorizontal, alignVertical, buttons, children, className, elevated, fullHeight, closeIconColorOverride, illustration, illustrationBackgroundColor, initialShownState, isDismissible, onBeforeHide, onHide, onShow, render, title, toggle, width, ...otherProps }: ActionModalProps): import("react/jsx-runtime").JSX.Element;
@@ -1 +1 @@
1
- {"version":3,"file":"ActionModal.d.ts","sourceRoot":"","sources":["../../../src/components/ActionModal/ActionModal.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AAQxF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AA2FpE,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,GAAG;IAC/D;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACzD;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IACvD;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,SAAS,CAAC,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IAEH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,qBAAqB,CAAC;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,KAAK,SAAS,CAAC;IAC3D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,CACP,IAAI,EAAE,MAAM,OAAO,EACnB,eAAe,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,GAAG,SAAS,KAC7D,SAAS,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,WAAW;6QAqBrB,gBAAgB;;CAsFlB,CAAC"}
1
+ {"version":3,"file":"ActionModal.d.ts","sourceRoot":"","sources":["../../../src/components/ActionModal/ActionModal.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,wBAAwB,EAAE,MAAM,OAAO,CAAC;AAQxF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AA2FpE,MAAM,MAAM,gBAAgB,GAAG,wBAAwB,CAAC,KAAK,CAAC,GAAG;IAC/D;;OAEG;IACH,eAAe,CAAC,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACzD;;OAEG;IACH,aAAa,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;IACvD;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,KAAK,SAAS,CAAC,CAAC;IACxD;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;;OAIG;IAEH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,qBAAqB,CAAC;IAC3C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,IAAI,CAAC;IACpB;;;OAGG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,IAAI,KAAK,SAAS,CAAC;IAC3D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,CACP,IAAI,EAAE,MAAM,OAAO,EACnB,eAAe,CAAC,EAAE,SAAS,CAAC,WAAW,GAAG,SAAS,CAAC,GAAG,SAAS,KAC7D,SAAS,CAAC;IACf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,WAAW;6QAqBrB,gBAAgB;;CAsFlB,CAAC"}
@@ -53,7 +53,14 @@ export type MenuButtonProps = ButtonProps & {
53
53
  size?: 'lg' | 'md' | 'sm';
54
54
  };
55
55
  /**
56
- * @deprecated Please use Menu with a Button trigger, see https://wistia.github.io/vhs/?path=/docs/components-menu--docs for documentation
56
+ * @deprecated Please use Menu with a Button trigger, see [documentation](https://wistia.github.io/vhs/?path=/docs/components-menu--docs).
57
+ *
58
+ * #### Why MenuButton is being deprecated
59
+ *
60
+ * The [Menu](https://wistia.github.io/vhs/?path=/docs/components-menu--docs) component is preferred over MenuButton for several reasons:
61
+ * 1. Menu has better alignment and collision detection.
62
+ * 2. Menu supports submenus.
63
+ * 3. Menu is properly portalled.
57
64
  */
58
65
  export declare const MenuButton: {
59
66
  ({ label, menuAlignment, menuItems, menuPosition, menuWidth, onMenuClick, onMenuClosed, disabled, iconButtonComponent, overrideMenuHeader, size, ...otherProps }: MenuButtonProps): JSX.Element;
@@ -1 +1 @@
1
- {"version":3,"file":"MenuButton.d.ts","sourceRoot":"","sources":["../../../src/components/MenuButton/MenuButton.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAItE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAwB7C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAmCF,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,GAAG,CAAC,OAAO,GAAG,YAAY,CAAC;IACjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9F;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7F;;OAEG;IACH,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B;;OAEG;IAEH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;sKAapB,eAAe,GAAG,WAAW;;CA2G/B,CAAC"}
1
+ {"version":3,"file":"MenuButton.d.ts","sourceRoot":"","sources":["../../../src/components/MenuButton/MenuButton.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAItE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAwB7C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,aAAa,EAAE,OAAO,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAmCF,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG;IAC1C;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,GAAG,CAAC,OAAO,GAAG,YAAY,CAAC;IACjD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,EAAE,CAAC;IAC1B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC9F;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,SAAS,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,UAAU,KAAK,IAAI,CAAC,GAAG,SAAS,CAAC;IAC7F;;OAEG;IACH,kBAAkB,CAAC,EAAE,SAAS,CAAC;IAC/B;;OAEG;IAEH,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;CAC3B,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;sKAapB,eAAe,GAAG,WAAW;;CA2G/B,CAAC"}
package/dist/index.cjs CHANGED
@@ -1,6 +1,6 @@
1
1
 
2
2
  /*
3
- * @license VHS v2.59.1-beta.5f931870.ae1f3bf
3
+ * @license VHS v2.59.1-beta.909aef57.3734806
4
4
  *
5
5
  * Copyright (c) 2021-2024, Wistia, Inc. and its affiliates.
6
6
  *