@nimbus-ds/popover 3.0.0 → 3.1.0-rc.2

package/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 Use Popovers to bring attention to specific user interface elements and suggest an action or to guide users through a new experience
 
-## 2023-02-24 `3.0.0`
+## 2023-03-13 `3.0.0`
 
 ### 🛠 Breaking changes
 
@@ -49,6 +49,7 @@ Use Popovers to bring attention to specific user interface elements and suggest
 - Removed `terser-webpack-plugin@5.3.5`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
 - Removed `ts-loader@9.3.1`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
 - Removed `webpack-cli@4.10.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
+- Removed `webpack@5.74.0`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
 - Removed `typescript@4.7.4`. ([#63](https://github.com/TiendaNube/nimbus-design-system/pull/63) by [@juniorconquista](https://github.com/juniorconquista))
 
 ## 2022-10-24 `1.2.0`

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 // Generated by dts-bundle-generator v7.1.0
 
-import { Placement } from '@floating-ui/react-dom-interactions';
 import React from 'react';
 import { HTMLAttributes, ReactNode } from 'react';
 
@@ -39,36 +38,89 @@ export type PopoverColorProperties = keyof typeof propertiesPopover.color;
 export type PopoverBackgroundColorProperties = keyof typeof propertiesPopover.backgroundColor;
 export type PopoverPaddingProperties = keyof typeof propertiesPopover.padding;
 export interface PopoverSprinkle {
+	/**
+	 * The width property specifies the width of a popover's content area.
+	 * @default 17.5rem
+	 */
 	width?: string | Conditions<string>;
+	/**
+	 * The height property specifies the height of a popover's content area.
+	 */
 	height?: string | Conditions<string>;
+	/**
+	 * The zIndex property specifies the stack order of the popover.
+	 */
 	zIndex?: number | Conditions<number>;
+	/**
+	 * The backgroundColor property sets the background color of the popover.
+	 * @default neutral-background
+	 * @examples ["neutral-interactive", { xs: "neutral-surface", md: "neutral-interactive" }]
+	 */
 	backgroundColor?: PopoverBackgroundColorProperties | Conditions<PopoverBackgroundColorProperties>;
+	/**
+	 * The color property is used to set the color of the popover.
+	 * @default neutral-background
+	 */
 	color?: PopoverColorProperties | Conditions<PopoverColorProperties>;
+	/**
+	 * The padding properties are used to generate space around an popover's content area.
+	 * @default base
+	 */
 	padding?: PopoverPaddingProperties | Conditions<PopoverPaddingProperties>;
 }
-export type PopoverExtends = PopoverSprinkle & HTMLAttributes<HTMLDivElement>;
-export interface PopoverProps extends PopoverExtends {
-	/** Popover anchor */
+export type PopoverPlacement = "top" | "right" | "bottom" | "left" | "bottom-start" | "bottom-end" | "left-start" | "left-end" | "right-start" | "right-end" | "top-start" | "top-end";
+export interface PopoverProperties extends PopoverSprinkle {
+	/**
+	 * An HTML element, or a function that returns one. It's used to set the position of the popover.
+	 * @TJS-type React.ReactNode
+	 */
 	children: ReactNode;
-	/** Content for the Popover */
+	/**
+	 * The content of the popover.
+	 * @TJS-type React.ReactNode
+	 */
 	content: ReactNode;
-	/** Default open popover */
+	/**
+	 * If true, the component is shown.
+	 */
 	visible?: boolean;
-	/** Function to control popover opening and closing */
+	/**
+	 * Function to control popover opening and closing.
+	 * @TJS-type (visible: boolean) => void;
+	 */
 	onVisibility?: (visible: boolean) => void;
-	/** Conditional for displaying the popover arrow */
+	/**
+	 * Conditional for displaying the popover arrow.
+	 * @default true
+	 */
 	arrow?: boolean;
-	/** Position of the Popover */
-	position?: Placement;
-	/** Adds hover event listeners that change the open state, like CSS :hover */
+	/**
+	 * Position of the popover.
+	 * @default bottom
+	 */
+	position?: PopoverPlacement;
+	/**
+	 * Adds hover event listeners that change the open state, like CSS :hover.
+	 * @default false
+	 */
 	enabledHover?: boolean;
-	/** Adds click event listeners that change the open state */
+	/**
+	 * Adds click event listeners that change the open state.
+	 * @default true
+	 */
 	enabledClick?: boolean;
-	/** Adds listeners that dismiss (close) the floating element */
+	/**
+	 * Adds listeners that dismiss (close) the floating element.
+	 * @default true
+	 */
 	enabledDismiss?: boolean;
-	/** offset() displaces the floating element from its core placement along the specified axes */
+	/**
+	 * Offest displaces the floating element from its core placement along the specified axes.
+	 * @default 10
+	 */
 	offset?: number;
 }
+export type PopoverProps = PopoverProperties & HTMLAttributes<HTMLDivElement>;
 export declare const Popover: React.FC<PopoverProps>;
 
 export {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimbus-ds/popover",
-  "version": "3.0.0",
+  "version": "3.1.0-rc.2",
   "license": "MIT",
   "main": "dist/index.js",
   "files": [
@@ -9,7 +9,7 @@
   ],
   "sideEffects": false,
   "scripts": {
-    "build": "webpack",
+    "build": "yarn g:webpack",
     "clean": "rm -rf dist",
     "version": "yarn version"
   },
@@ -29,8 +29,9 @@
     "url": "https://github.com/TiendaNube/nimbus-design-system/issues"
   },
   "devDependencies": {
-    "@nimbus-ds/box": "^3.0.0",
-    "@vanilla-extract/dynamic": "^2.0.2",
-    "webpack": "^5.74.0"
-  }
+    "@nimbus-ds/box": "^3.2.0",
+    "@nimbus-ds/webpack": "^1.3.0-rc.2",
+    "@vanilla-extract/dynamic": "^2.0.2"
+  },
+  "stableVersion": "3.0.0"
 }