solid-dismiss - npm Package Compare versions

Comparing version 1.0.6 to 1.0.7

dist/types/index.d.ts

 import "./browserInfo";
 import { Accessor, Component, JSX } from "solid-js";
 import { TDismissStack } from "./dismissStack";
+import { DismissAnimation } from "./Transition";
 export declare type TDismiss = {
@@ -173,3 +174,3 @@ /**
 };
-export declare type FocusElementOnCloseOptions = {
+declare type FocusElementOnCloseOptions = {
     /**
@@ -219,36 +220,2 @@ *
 };
-export declare type DismissAnimation = {
-    /**
-     * Used to automatically generate transition CSS class names. e.g. name: 'fade' will auto expand to .fade-enter, .fade-enter-active, etc.
-     */
-    name?: string;
-    enterActiveClass?: string;
-    enterClass?: string;
-    enterToClass?: string;
-    exitActiveClass?: string;
-    exitClass?: string;
-    exitToClass?: string;
-    onBeforeEnter?: (el: Element) => void;
-    onEnter?: (el: Element, done: () => void) => void;
-    onAfterEnter?: (el: Element) => void;
-    onBeforeExit?: (el: Element) => void;
-    onExit?: (el: Element, done: () => void) => void;
-    onAfterExit?: (el: Element) => void;
-    /**
-     * Change element where CSS classes are appended and passed to callbacks.
-     *
-     * css selector, queried from root component, to get menu popup element. Or pass JSX element
-     *
-     * Using `"container"` value will use root element of the component
-     *
-     * @defaultValue The element is the root element of the component, where CSS classes are appended to, and it is also passed to callbacks
-     */
-    appendToElement?: string | Node;
-    /**
-     * Whether to apply transition on initial render.
-     *
-     * @defaultValue `false`
-     */
-    appear?: boolean;
-};
 export declare type OnOpenHandler = (open: boolean, props: {
@@ -255,0 +222,0 @@ uniqueId: string;

dist/types/Transition.d.ts

 import { Component, JSX } from "solid-js";
-import { DismissAnimation } from ".";
+export declare type DismissAnimation = {
+    /**
+     * Used to automatically generate transition CSS class names. e.g. name: 'fade' will auto expand to .fade-enter, .fade-enter-active, etc.
+     */
+    name?: string;
+    enterActiveClass?: string;
+    enterClass?: string;
+    enterToClass?: string;
+    exitActiveClass?: string;
+    exitClass?: string;
+    exitToClass?: string;
+    onBeforeEnter?: (el: Element) => void;
+    onEnter?: (el: Element, done: () => void) => void;
+    onAfterEnter?: (el: Element) => void;
+    onBeforeExit?: (el: Element) => void;
+    onExit?: (el: Element, done: () => void) => void;
+    onAfterExit?: (el: Element) => void;
+    /**
+     * Change element where CSS classes are appended and passed to callbacks.
+     *
+     * css selector, queried from root component, to get menu popup element. Or pass JSX element
+     *
+     * Using `"container"` value will use root element of the component
+     *
+     * @defaultValue The element is the root element of the component, where CSS classes are appended to, and it is also passed to callbacks
+     */
+    appendToElement?: string | Node;
+    /**
+     * Whether to apply transition on initial render.
+     *
+     * @defaultValue `false`
+     */
+    appear?: boolean;
+};
 export declare const Transition: Component<DismissAnimation & {
     children: JSX.Element;
 }>;

package.json

 {
   "name": "solid-dismiss",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "homepage": "https://aquaductape.github.io/solid-dismiss/",
@@ -5,0 +5,0 @@ "description": "Handles \"click outside\" behavior for popup menu. Closing is triggered by click/focus outside of popup element or pressing \"Escape\" key.",

README.md

@@ -1,5 +0,326 @@
-<h1 align="center">Solid Dismiss</h1>
+<h1 align="center">Solid Dismiss
+<img src="assets/logo.svg" width="40px" height="35px" style="position: relative; top: 5px;">
+</h1>
 
-<!-- https://img.shields.io/badge/size%20(gzip)-~6kb-brightgreen?style=for-the-badge -->
+<sup>
+<img src="https://img.shields.io/badge/size%20(gzip)-~6.6kb-brightgreen" alt="size of package gzip" />
+  </sup>
 
-https://solid-dismiss-test.netlify.app/
+Handles "click outside" behavior for popup menu. Closing is triggered by click/focus outside of popup element or pressing "Escape" key. It can also deal with stacks/layers of popups.
+
+## Install
+
+```
+npm i solid-dismiss
+```
+
+```
+yarn add solid-dismiss
+```
+
+## Example
+
+### Popup
+
+```js
+import Dismiss from "solid-dismiss";
+import { createSignal } from "solid-js";
+
+const Popup = () => {
+  const [open, setOpen] = createSignal(false);
+  let btnEl;
+
+  return (
+    <div style="position: relative;">
+      <button ref={btnEl}>Open</button>
+      <Dismiss menuButton={btnEl} open={open} setOpen={setOpen}>
+        <div class="popup">
+          <p>Popup text!</p>
+          <p>
+            Lorem, <a href="#">ipsum</a> dolor.
+          </p>
+        </div>
+      </Dismiss>
+    </div>
+  );
+};
+```
+
+## [Demo Site](https://aquaductape.github.io/solid-dismiss/)
+
+## Caveat
+
+For iOS devices: when clicking outside, without overlay, and the element that happened to be clicked upon was an iframe,there's a chance that the popup won't close. iframe detection interaction is feasible by checking if window blurs, but in iOS, unless the user taps on a clickable element inside iframe, window won't blur because the main page focus hasn't been blurred.
+
+If the iframe body element has click listener, then tapping anywhere on iframe will blur window, thus closing the popup as intended. Thus if author is dealing with same domain iframes, the author can easily add empty click event listener to the body.
+
+```js
+const iframeEl = document.querySelector("iframe");
+const doc = iframeEl.contentWindow.document;
+
+doc.body.addEventListener("click", () => {});
+```
+
+## Docs
+
+Dismiss
+
+```ts
+/**
+ * sets id attribute for root component
+ */
+id?: string;
+ref?: JSX.Element;
+class?: string;
+classList?: { [key: string]: boolean };
+open: Accessor<boolean>;
+setOpen: (v: boolean) => void;
+/**
+ * callback when setOpen signal changes
+ */
+onOpen?: OnOpenHandler;
+/**
+ * css selector, queried from document, to get menu button element. Or pass JSX element
+ */
+menuButton: string | JSX.Element | (() => JSX.Element);
+/**
+ *
+ * css selector, queried from document, to get menu popup element. Or pass JSX element
+ *
+ * @defaultValue root component element queries first child element
+ */
+menuPopup?: string | JSX.Element | (() => JSX.Element);
+/**
+ *
+ * Have the behavior to move through a list of "dropdown items" using cursor keys.
+ *
+ * @defaultValue `false`
+ */
+cursorKeys?: boolean;
+/**
+ *
+ * Focus will remain inside menuPopup when pressing Tab key
+ *
+ * @defaultValue `false`
+ */
+trapFocus?: boolean;
+/**
+ *
+ * which element, via selector*, to recieve focus after popup opens.
+ *
+ * *css string queried from root component, or if string value is `"menuPopup"` uses menuPopup element.
+ *
+ * @defaultValue focus remains on `"menuButton"`
+ */
+focusElementOnOpen?: "menuPopup" | string | JSX.Element | (() => JSX.Element);
+/**
+ *
+ * Which element, via selector*, to recieve focus after popup closes.
+ *
+ * *selector: css string queried from document, or if string value is `"menuButton"` uses menuButton element
+ *
+ * @remarks
+ *
+ * If menuPopup is mounted elsewhere in the DOM or doesn't share the same parent as menuButton, when tabbing outside menuPopup, this library programmatically grabs the correct next tabbable element after menuButton. However if that next tabbable element is inside an iframe that has different origin, then this library won't be able to grab tabbable elements inside it, instead the iframe will be focused.
+ *
+ *
+ * @defaultValue
+ *
+ * When Tabbing forwards, focuses on tabbable element after menuButton. When Tabbing backwards, focuses on menuButton. When pressing Escape key, menuButton will be focused. When programmatically closed, such as clicking close button, then menuButton will be focused. When "click" outside, user-agent determines which element recieves focus, however if `Dismiss.overlay` or `Dismiss.overlayElement` are set, then menuButton will be focused instead.
+ */
+focusElementOnClose?:
+  | "menuButton"
+  | string
+  | JSX.Element
+  | FocusElementOnCloseOptions;
+
+/**
+ *
+ * When `true`, after focusing within menuPopup, if focused back to menu button via keyboard (Tab key), the menuPopup will close.
+ *
+ * @defaultValue `false`
+ */
+closeWhenMenuButtonIsTabbed?: boolean;
+/**
+ *
+ * If `overlay` is `true`, menuPopup will always close when menu button is clicked
+ *
+ * @defaultValue `false`
+ */
+closeWhenMenuButtonIsClicked?: boolean;
+/**
+ *
+ * Closes menuPopup when any scrollable container (except inside menuPopup) is scrolled
+ *
+ * @remark
+ *
+ * Even when `true`, scrolling in "outside" scrollable iframe won't be able to close menuPopup.
+ *
+ * @defaultValue `false`
+ */
+closeWhenScrolling?: boolean;
+/**
+ *
+ * If `false`, menuPopup won't close when overlay backdrop is clicked. When overlay clicked, menuPopup will recieve focus.
+ *
+ * @defaultValue `true`
+ */
+
+closeWhenOverlayClicked?: boolean;
+/**
+ *
+ * Closes menuPopup when escape key is pressed
+ *
+ * @defaultValue `true`
+ */
+closeWhenEscapeKeyIsPressed?: boolean;
+/**
+ *
+ * Closes when the document "blurs". This would happen when interacting outside of the page such as Devtools, changing browser tabs, or switch different applications.
+ */
+closeWhenDocumentBlurs?: boolean;
+/**
+ *
+ * If `true`, sets "overflow: hidden" declaration to Document.scrollingElement.
+ *
+ * @defaultValue `false`
+ */
+removeScrollbar?: boolean;
+/**
+ * Prevent page interaction when clicking outside to close menuPopup
+ *
+ * Author must create overlay element within menuPopup, this way page elements underneath the menuPopup can't be interacted with.
+ *
+ *
+ * @defaultValue `false`
+ */
+overlay?: boolean;
+/**
+ * Prevent page interaction when clicking outside to close menuPopup
+ *
+ * Adds root level div that acts as a layer. This removes interaction of the page elements that's underneath the overlay element, that way menuPopup is the only element that can be interacted with.
+ *
+ * @defaultValue `false`
+ */
+overlayElement?:
+  | boolean
+  | {
+      ref?: (el: HTMLElement) => void;
+      class?: string;
+      classList?: { [key: string]: boolean };
+      animation?: DismissAnimation;
+    };
+/**
+ *
+ * activates sentinel element as last tabbable item in menuPopup, that way when Tabbing "forwards" out of menuPopup, the next logical tabblable element after menuButton will be focused.
+ *
+ *
+ * @defaultValue `false` unless `Dismiss.mount` is set, `Dismiss.focusElementOnClosed` is set, `Dismiss.overlay` prop is `true`, or this component's root container is not an adjacent sibling of menuButton.
+ */
+enableLastFocusSentinel?: boolean;
+/**
+ *
+ * Inserts menuPopup in the mount node. Useful for inserting menuPopup outside of page layout. Events still propagate through the Component Hierarchy.
+ */
+mount?: string | Node;
+/**
+ * Place CSS class names or JS Web Animation to fire animation as menuPopup enters/exits
+ *
+ * @defaultValue none
+ */
+animation?: DismissAnimation;
+/**
+ * Determine whether children are rendered always, or conditionally.
+ *
+ * If `true`, children are rendered.
+ *
+ * @defaultValue `false`, children are conditionally rendered based on `Dismiss.open` value.
+ */
+show?: boolean;
+// stopComponentEventPropagation?: boolean;
+```
+
+FocusElementOnCloseOptions
+
+```ts
+/**
+ *
+ * focus on element when exiting menuPopup via tabbing backwards ie "Shift + Tab".
+ *
+ * @defaultValue `"menuButton"`
+ *
+ */
+tabBackwards?: "menuButton" | string | JSX.Element;
+/**
+ *
+ * focus on element when exiting menuPopup via tabbing forwards ie "Tab".
+ *
+ * @remarks
+ *
+ *  If popup is mounted elsewhere in the DOM, when tabbing outside, this library is able to grab the correct next tabbable element after menuButton, except for tabbable elements inside iframe with cross domain.
+ *
+ * @defaultValue next tabbable element after menuButton;
+ */
+tabForwards?: "menuButton" | string | JSX.Element;
+/**
+ * focus on element when exiting menuPopup via click outside popup.
+ *
+ * If mounted overlay present, and popup closes via click, then menuButton will be focused.
+ *
+ * @remarks
+ *
+ * When clicking, user-agent determines which element recieves focus.
+ */
+click?: "menuButton" | string | JSX.Element;
+/**
+ *
+ * focus on element when exiting menuPopup via "Escape" key
+ *
+ * @defaultValue `"menuButton"`
+ */
+escapeKey?: "menuButton" | string | JSX.Element;
+/**
+ *
+ * focus on element when exiting menuPopup via scrolling, from scrollable container that contains menuButton
+ *
+ * @dafaultValue `"menuButton"`
+ */
+scrolling?: "menuButton" | string | JSX.Element;
+```
+
+DismissAnimation
+
+```ts
+/**
+ * Used to automatically generate transition CSS class names. e.g. name: 'fade' will auto expand to .fade-enter, .fade-enter-active, etc.
+ */
+name?: string;
+enterActiveClass?: string;
+enterClass?: string;
+enterToClass?: string;
+exitActiveClass?: string;
+exitClass?: string;
+exitToClass?: string;
+onBeforeEnter?: (el: Element) => void;
+onEnter?: (el: Element, done: () => void) => void;
+onAfterEnter?: (el: Element) => void;
+onBeforeExit?: (el: Element) => void;
+onExit?: (el: Element, done: () => void) => void;
+onAfterExit?: (el: Element) => void;
+/**
+ * Change element where CSS classes are appended and passed to callbacks.
+ *
+ * css selector, queried from root component, to get menu popup element. Or pass JSX element
+ *
+ * Using `"container"` value will use root element of the component
+ *
+ * @defaultValue The element is the root element of the component, where CSS classes are appended to, and it is also passed to callbacks
+ */
+appendToElement?: string | Node;
+/**
+ * Whether to apply transition on initial render.
+ *
+ * @defaultValue `false`
+ */
+appear?: boolean;
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

252342

increased by3.99%

Number of lines in readme file

327

increased by5350%

No dependency changes